36 lines
1.4 KiB
JavaScript
36 lines
1.4 KiB
JavaScript
/* eslint-disable import/no-commonjs */
|
|
const remarkMode = process.env.REMARK_MODE;
|
|
/**
|
|
* Linting config.
|
|
* Check the following links for the list of all rules:
|
|
* - https://github.com/remarkjs/remark-lint/tree/master/packages/remark-preset-lint-consistent
|
|
* - https://github.com/remarkjs/remark-lint/tree/master/packages/remark-preset-lint-recommended
|
|
* - https://github.com/remarkjs/remark-lint/tree/master/packages/remark-preset-lint-markdown-style-guide
|
|
**/
|
|
const lintConfig = {
|
|
plugins: [
|
|
'frontmatter',
|
|
'remark-preset-lint-consistent',
|
|
'remark-preset-lint-recommended',
|
|
'preset-lint-markdown-style-guide',
|
|
|
|
// Following rules are configured to fit what prettier does
|
|
'lint-no-trailing-spaces', // No trailing spaces
|
|
['lint-emphasis-marker', '_'], // Italic with _, bold with **
|
|
['lint-list-item-spacing', false], // No need to add lines between list items
|
|
['lint-list-item-indent', 'space'], // Indent list items with one space
|
|
['lint-maximum-heading-length', 80], // Warn on heading that can be too long
|
|
['lint-maximum-line-length', 80], // Warn on lines that are too long
|
|
],
|
|
};
|
|
const fixConfig = {
|
|
plugins: {
|
|
frontmatter: true, // Frontmatter is needed to it does not choke on it
|
|
'reference-links': true, // Convert links to reference table at bottom of file
|
|
},
|
|
};
|
|
|
|
const config = remarkMode === 'fix' ? fixConfig : lintConfig;
|
|
|
|
exports.plugins = config.plugins;
|
|
exports.settings = config.settings;
|