0.1.0 ā¢ Published 4 years ago
plinter v0.1.0
A linter for your project.
š Homepage
Install
yarn install plinter
Usage
plinter [pattern] [--options]
Run tests
yarn test
Config Example
// plinter.config.js
module.exports = {
rules: {
'top-level-items': [
'error',
{ items: ['CHANGELOG.md', 'README.md', 'src', '.editorconfig'] },
],
},
ignore: ['*.md'],
pattern: ['**'],
};
Plinter Rules
š¹ top-level-items
Make some files and directories on the top level of your project required.
Option | type | description | required |
---|---|---|---|
items | string[] | The items that should be on the top level. | true |
'top-level-items': [ 'error', { items: ['src', 'config.json', '.env'] } ]
š¹ More rules TBD
Author
š¤ Joaquim Neto
- Website: joaquimnet.github.io
- Twitter: @joaquimnet_
- Github: @joaquimnet
Show your support
Give a āļø if this project helped you!
š License
Copyright Ā© 2020 Joaquim Neto. This project is MIT licensed.
This README was generated with ā¤ļø by readme-md-generator
0.1.0
4 years ago