Moenda is an engine built with Nodejs that analyzes a set of files from editable and user-defined rules and generates a report of these files.
$ npm i moenda
$ ./node_modules/moenda.js --rules <rules-file.js> --path <files-dir/> --exclude <files-extensions> --config <config-file.js>
Basic Configuration:
--rules This option allows you to specify another file from which to load rules files rather then default.
--path This option allows you to specify the path to the file(s) to be analyzed.
--config This option allows you to specify an additional configuration file for Moenda.
--exclude This option allows you to specify which file extensions Moenda must ignore.(optional)
--context This option allows you to generate a context for markdown files. (optional)
You can specify another file from which to load rules files using --rules option. This allows you to dynamically load new rules at run time. This is useful when you have custom rules that aren't suitable for being bundled with Moenda. Check it out our rules documentation to see how implement your custom rules.
You can specify the path to the file(s) to be analyzed using --path option.
You can specify extensions of file to be ignored using --exclude. So, Moenda will not looks to those files when running the rules.
Use a JavaScript file to specify configuration information for your files. This should be in the form of an <configName>.js file. Moenda will look for the file that you specified on the command line using --config option.
const config = {
ruleLineCounter: {limit:60},
ruleLineAboveXCharacters: {limit:30},
ruleFirstSectionStartsWithHx: {limit: 3},
ruleConsecutiveBlankLines: {limit: 1}
}
module.exports = config;After run the command you'll see the report in your terminal.
$ moenda.js --rules /home/user/md-rules.js --path /home/user/sut --exclude html,java --config configOne.js
/home/user/sut/file.js
12:76 error "This line must not exceed 75 characters." ruleLineAboveXCharacters()
51:- error "This file is expected to have a maximum of 50 lines" ruleLineCounter()
62:- error "This file is expected to have a maximum of 1 consecutive blank lines" ruleConsecutiveBlankLines()
* 4 problem(s) (2 errors)
* 0 info(s)
/home/user/sut/markdown.md
1:4 error The first section of the file does not start with H1 ruleFirstSectionStartsWithHx()
1:4 error The file does not have increasing and decreasing sections ruleNeighboringSections()
15:76 error "This line must not exceed 75 characters." ruleLineAboveXCharacters()
51:- error "This file is expected to have a maximum of 50 lines" ruleLineCounter()
* 4 problem(s) (4 errors)
* 0 info(s)
$ moenda --rules /home/felipe/fork/Moenda/src/rules/MD/MDRules.js --path /home/felipe/fork/Moenda/README.md --config /home/felipe/fork/Moenda/src/config.js --context true
/home/felipe/fork/Moenda/README.md
-:- info The file has 94 line(s) ruleLineCounter()
1:1 error The first section of the file does not start with H3 ruleFirstSectionStartsWithHx()
5:31 error This line must not exceed 30 characters. ruleLineAboveXCharacters()
30:- error This file is expected to have a maximum of 1 consecutive blank lines ruleConsecutiveBlankLines()
45:4 error The file does not have increasing and decreasing sections ruleNeighboringSections()
94:- error This file is expected to have a minimum of 600 lines ruleLessThanXLines()
* 5 problem(s) (5 errors)
* 1 info(s)
{
[
{ type: 'inLineCode', value: '`--path || ', line: 25, quantity: 1 },
{
type: 'link',
value: 'https://github.com/SPLAB-UFCG/Moenda/blob/master/src/index.js#L260',
line: 85,
quantity: 1
},
{
type: 'text',
value: ' - Analyzes whether the file has more consecutive blank lines than allowed.',
line: 86,
quantity: 1
},
{ type: 'section', value: 2, line: 91, quantity: 1 },
{ type: 'text', value: 'MIT © Moenda', line: 93, quantity: 1 }
],
sections: 1,
links: 1,
lists: 0,
images: 0,
inLineCode: 1,
texts: 2
}
- ruleLineCounter
- Counts the file lines. - ruleLessThanXLines
- Evaluates whether a file has fewer lines than necessary. - ruleLineAboveXCharacters
- Evaluates whether a line has more characters than allowed. - ruleFirstSectionStartsWithHx
- Analyzes whether the first section of the file is of the determined order. - ruleNeighboringSections
- Analyzes whether sections have inconsistencies. - ruleInconsistencyOfSpaces
- It finds spaces inconsistency. - ruleConsecutiveBlankLines
- Analyzes whether the file has more consecutive blank lines than allowed.
MIT © Moenda
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent