Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
AMDmi3 committed Feb 12, 2024
1 parent 09f6eab commit 5f6c85d
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,17 @@ in not actively maintained projects.

Note: ruleset syntax is not final.

```
% cat omnilinter.conf
### Example ruleset

```yaml
rules:
- title: convert deprecated auto_ptr to unique_ptr
files: "*.cpp"
match: auto_ptr

- title: convert setup.py to pyptoject.toml
- title: convert setup.py to pyproject.toml
files: setup.py
nofiles: pyproject.toml

- title: change indentation to spaces
files: "*.py"
Expand All @@ -30,7 +32,19 @@ rules:

- title: add README.md
nofiles: README.md
```
See also [config](.omnilinter.conf) used to check omnilinter's own codebase.
### Example output
Command:
```
% omnilinter -c omnilinter.conf projects/*
```

Output:
```
projects/my_python_project:
- setup.py: convert setup.py to pyptoject.toml
- src/__init__.py: add license information
Expand All @@ -43,3 +57,19 @@ project/my_cpp_lib:
- src/main.cpp:17: convert deprecated auto_ptr to unique_ptr
- src/main.cpp:49: convert deprecated auto_ptr to unique_ptr
```

## Ruleset format

TODO

## Arguments

TODO

## Author

* [Dmitry Marakasov](https://github.com/AMDmi3) <[email protected]>

## License

* [GPL-3.0-or-later](LICENSE)

0 comments on commit 5f6c85d

Please sign in to comment.