Finds common mistakes in .ir
files (FlipperFormat).
DOES NOT AUTOMATICALLY FIX ANY ERRORS
$ python3 main.py <format> [file 1] [file 2] ... [file n]
$ python3 main.py <format> 'glob:**/*.ir'
Note: You can use glob-pattern by prefixing
glob:
Specify
github
orgithub2
(newer) for format
Specify
simple
for format
→ python3 main.py simple remote.ir
*********************************
[lint] checking 'remote.ir' [1/1]
Error in line 19
'protocol:NEC'
↑
[error]: space missing after ':'
[suggested] 'protocol: NEC'
---
Error in line 19
'protocol:NEC'
↑↑↑↑↑↑↑↑
[error]: key 'type' expected
[suggested] 'type: ...'
---
[lint] found 2 warnings/errors in file.
*********************************
An example GitHub Actions Workflow can be found here.
The linter should work in a CI/CD pipeline.
Just put the example in your repo under the .github/workflows
directory and
enable
actions in the repo if necessary.
If a pull request is created in which .ir
files are modified, the linter checks the modified (or newly created) .ir
files.
If errors are found, they are appended as a comment to the PR and the PR is set to Requested Changes.