plinter

A linter for your project.

Usage no npm install needed!

<script type="module">
  import plinter from 'https://cdn.skypack.dev/plinter';
</script>

README

Welcome to plinter 👋

Version Documentation Maintenance License: MIT Twitter: joaquimnet\_

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

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