0.1.0 ā€¢ Published 4 years ago

plinter v0.1.0

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

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.

Optiontypedescriptionrequired
itemsstring[]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

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