elastic / elastic/detection-rules
[Meta] Refactor Rule Formatter
- Dominant language
- Python
- Stars
- 2.7k
- Forks
- 696
- Avg merge
- 4d 17h
- Merged PRs (30d)
- 87
Description
## Parent Epic (If Applicable)
https://github.com/elastic/ia-trade-team/issues/810
## Meta Summary
The formatter was once written when the schemas were flat structures. Now that they have evolved to nested structures, the rule formatter should be refactored.
- The new solution should easily be able to specify the order of the toml file.
- The solution should remain consistent and not unintentionally create new sha256 calculations.
- The solution should still support some of the old features:
- text wrapping after a certain character limit
- skipping fields that should not be formatted or normalized
## Estimated Time to Complete
## Potential Blockers
## Tasklist
### Meta Tasks
- [ ] Provide Week 1 Update Comment
- [ ] Provide Week 2 Update or Closeout Comment
- [x] https://github.com/elastic/detection-rules/issues/4979
- [ ] Develop a CLI command to validate all existing toml files and reformat (lint)
- [ ] Ensure all rules have
- [ ] Add unit tests for the formatter
## Resources / References
Contributor guide
Assessment
This issue has not been assessed yet.