├── .eslintrc.json
├── .gitignore
├── .prettierignore
├── .travis.yml
├── LICENSE
├── README.md
├── cli.js
├── media
├── demo1.png
└── logo.png
├── package.json
├── src
├── display.js
├── index.js
└── template.js
└── test
├── __snapshots__
└── index.test.js.snap
├── index.test.js
└── testFolder
└── testAgain
├── test.txt
└── testForSake.js
/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "parser": "babel-eslint",
3 | "plugins": ["prettier"],
4 | "rules": {
5 | "prettier/prettier": "error"
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | coverage/
3 | ./test/coverage
4 | yarn.lock
--------------------------------------------------------------------------------
/.prettierignore:
--------------------------------------------------------------------------------
1 | src/template.js
2 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js:
3 | - "8"
4 | install:
5 | - npm install
6 | script:
7 | - npm run test
8 |
9 |
10 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2018 Paul Rosset
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | 
5 |
6 |
7 |
8 |
9 |
10 | > Make sure the file-names stay the same, control them! 👁
11 |
12 | [](https://travis-ci.org/PaulRosset/linter-farch)
13 | [](https://badge.fury.io/js/linter-farch)
14 | [](https://travis-ci.org/PaulRosset/linter-farch)
15 |
16 | ## Motivation
17 |
18 | More and more frameworks that have been created recently gave the possibility to the user to write content in markdown, like [Gatsby](https://github.com/gatsbyjs/gatsby) or [Docusaurus](https://github.com/facebook/docusaurus), but sometimes if you collaborate with multiples people on these markdown files, keeping a clean file-name is more important than ever. That's why I created this tiny linter to force people to respect a file-name architecture in order the keep everything clean and understandable.
19 | Of course, many other usages can be considered.
20 |
21 | ## Install
22 |
23 | ```sh
24 | yarn add --dev linter-farch
25 | ```
26 |
27 | ## Usage
28 |
29 | Once installed, a small and quick configuration is needed in the `package.json` file.
30 | The `package.json` file is used here, to avoid creating another file with a purpose of configuration.
31 |
32 | ### Configuration:
33 |
34 | 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):
35 |
36 | In the `package.json` file:
37 |
38 | ```json
39 | {
40 | "farch": {
41 | "src": "([a-z]*-[0-9]{4})[.]*[a-z]*",
42 | "src/utilities": "[a-z]*",
43 | "src/utilities/*.js": "[a-z]"
44 | }
45 | }
46 | ```
47 |
48 | > You can use [`glob`](http://man7.org/linux/man-pages/man3/glob.3.html) as key/path to provide more flexibility to capture the wanted files.
49 |
50 | * Creating regex can be hard or simply boring, that's why you can simply put template placeholder like this:
51 |
52 | ```json
53 | {
54 | "farch": {
55 | "src": "([a-z]*-[0-9]{4})[.]*[a-z]*",
56 | "src/utilities": ["LOWER_CAMEL_CASE_JS", "[a-z]*"],
57 | "src/utilities/*.js": "[a-z]"
58 | }
59 | }
60 | ```
61 |
62 | You can find any template placeholder already created [here](https://github.com/PaulRosset/linter-farch/blob/master/src/template.js), feel free to contribute by adding more template/placeholder regex. The keys have to be of the following form: "XXX*XXX_XXX_YY", where \_XXX* is the name and _YY_ the extension of the file that we want to test.
63 |
64 | ---
65 |
66 | 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`.
67 |
68 | ```json
69 | {
70 | "farch": {
71 | "src": "([a-z]*-[0-9]{4})[.]*[a-z]*",
72 | "src/utilities": "[a-z]*"
73 | }
74 | }
75 | ```
76 |
77 | > `farch.json` file have the priority over the `package.json` file.
78 |
79 | Inside the `farch` property, insert the directory that you want to test:
80 | Pass as `key`, the path from the root directory to the target directory, then in value pass `regex` to match.
81 |
82 | **Then, you are all set!**
83 |
84 | ### Execution
85 |
86 | To avoid creating tons of rules if you have a lot of directory nested and they apply to the same assertion you can pass `-R`, hence it will recursively check all the directory.
87 |
88 | At the root of your project:
89 |
90 | ```sh
91 | npx farch
92 | ```
93 |
94 | or
95 |
96 | Insert it in your `package.json` file:
97 |
98 | ```json
99 | {
100 | "scripts": {
101 | "test": "farch ((-R))"
102 | }
103 | }
104 | ```
105 |
106 | **And run `CI` on it !**
107 |
108 | ### Output
109 |
110 |
111 |
112 |