linter-farch CLI 👁

CLI helper to control filenames of a project

Motivation

More and more frameworks that have been created recently give the possibility to the user to write content in markdown, like Gatsby or Docusaurus and sometimes if you collaborate with multiples persons on this markdown files, keeping an clean file name is more important than ever. That's why I created this tiny linter to force people to respect a filename architecture in order the keep everything clean and understanble.

Install

yarn add --dev linter-farch-cli

or

npm i --save-dev linter-farch-cli

Usage

Once installed, a small and quick configuration is needed in the package.json file.
The package.json file is used here to avoid creating another file with a purpose of configuration.

Configuration:

For the configuration, two possibles way can be taken, the first is the package.json file like below (essentially for the JS project and if you don't want to create another config file):

In the package.json file:

{
  "farch": {
    "src": "([a-z]*-[0-9]{4})[.]*[a-z]*",
    "src/utilities": "[a-z]*"
  }
}

But, there is still the possibility to create a farch.json config file at the root of the project, essentially for the non-js project or if you don't want to put the configuration in your package.json.

{
  "farch": {
    "src": "([a-z]*-[0-9]{4})[.]*[a-z]*",
    "src/utilities": "[a-z]*"
  }
}

farch.json file have the priority over the package.json file.

Inside the farch property, insert the directory that you want to test:
Pass as key, the path from the root directory to the target directory, then in value pass regex to match.

Then, you are all set!

Execution

At the root of your project:

npx farch

or

Insert it in your package.json file:

{
  "scripts": {
    "test": "farch"
  }
}

API for this module

linter-farch API

License

MIT Paul Rosset