Run the Fluid community's standard linting checks.
npm install fluid-lint-allThis package runs the standard linting checks used within the
Fluid community.
If you want to use this package without installing it, you'll need to install npx.
1. Install the package using a command like npm install --save-dev fluid-lint-all.
2. Add a script to your package.json, something like: ``"lint": "fluid-lint-all"`
3. Run the checks using a command like .
To use this package without installing it as a dependency, use a command like:
`npx fluid-lint-all`
Although it's not required, it is recommended that you install the
standard ESLint configuration used within the community. If you
choose not to, you must at least have some kind of .eslintrc.json in your repository. Otherwise, some of the ESLint
checks will fail for lack of a configuration file.
To run the tests in this package, use a command like npm test.
| Task | Description |
| -------------------------- | ----------- |
| eslint | Use ESLint to lint both javascript and markdown content. |
| eslint.js | Check the validity and formatting of Javascript files. |
| eslint.json | Wrap JSON content as though it were part of a Javascript file and validate it using our Javascript rules. |
| eslint.md | Check the validity and formatting of Javascript code blocks in Markdown files. |
| json5lint | Check the validity of JSON5 files. |
| jsonlint | Use jsonlint to check the validity of JSON files. |
| lintspaces | Use lintspaces to check for trailing carriage returns and JSON indentation issues. |
| lintspaces.jsonindentation | Check the indentation of JSON files. |
| lintspaces.newlines | Check for the presence of a carriage return at the end of a file. |
| markdownlint | Use markdownlint to check the formatting of Markdown files. |
| mdjsonlint | Check the validity and formatting of JSON code blocks within Markdown files. |
| stylelint | Use stylelint to check the formatting of CSS or SCSS files. |
| yaml | Use js-yaml to check the validity of YAML files. |
This package is configured using a JSON file, which by default is named
.fluidlintallrc.json and located in the root of your repository. You can run the checks usingconfigFile
a different configuration file by passing the option, as innpx fluid-lint-all --configFile ./path/to/your/config.json.
You can choose to disable any checks that are not relevant to your environment
in the configuration file (see below), but you can also specify which check(s)
to run by passing the checks option, as in npx lint-all --checks=eslint ornpx fluid-lint-all --checks=jsonlint,lintspaces.newlines
Each check supports the following configuration options.
| Option | type | Description |
| -------- | --------------- | ----------- |
| enabled | Boolean | Whether or not to run the check. If set to false, will also disable any sub-checks. Defaults to true. |Array
| includes | | An array of glob patterns indicating files to be linted. |Array
| excludes | | An array of glob patterns indicating files (that otherwise match the includes) which should be excluded. |Object
| options | | The libraries (see above) used for most checks support their own configuration options, which should be placed here. |
The defaults for each check appear in this grade.
This package uses fluid-glob to defined the list of files to scan for each
check. For each check there are two supported options, includes and excludes. They are evaluated roughly in that
order, i.e. you establish more general wildcards for a file type or directory, and exclude individual files or
subdirectories that should not be linted.
See the documentation for fluid-glob for further details on the supported syntax.
In this example, we disable the markdown checks:
`json`
{
"eslint": {
"md": {
"enabled": false
}
},
"markdownlint": {
"enabled": false
},
"mdjsonlint": {
"enabled": false
}
}
This example demonstrates the way in which configuration options for subchecks (such as eslint.md) are nested undereslint
their respective parent (in this case, ). Here's an example that changes a configuration option specific to a
particular library:
`json`
{
"json-eslint": {
"excludes": ["./package-lock.json"],
"options": {
"rules": {
"indent": "on"
}
}
}
}
Here's an example that demonstrates how to change the excluded files for a given check. The lintspaces.newlines
check would otherwise report any files that lack a trailing space as an error.
`json`
{
"eslint": {
"md": {
"enabled": false
}
},
"markdownlint": {
"enabled": false
},
"mdjsonlint": {
"enabled": false
},
"lintspaces": {
"newlines": {
"excludes": ["./src/assets/images/*/"]
}
}
}
You can see clear examples of custom options for linting checks that support them in this text fixture.
Here's the stylelint configuration from that fixture:
`json`
{
"stylelint": {
"options": {
"configFile": ".stylelintrc-custom.json"
}
}
}
Stylelint also supports a config option where you can pass in the same rules you would write in a configuration file,config
but setting will prevent any of the options in your configFile from being used. Best practice is to extend
another configuration file and overlay your own exceptions, as demonstrated in this text fixture.
Each check is free to interpret relative paths in its own way. In the above example, stylelint would look for the file
relative to the repository in which the checks are run. The default stylelint options provided by this package make use
of fluid.module.resolvePath
to ensure that the default configuration file is used regardless of where your package manager
chooses to install fluid-lint-all.
There are global includes and excludes defined by default. See this file for the default
configuration options.
This section describes adding your own includes and excludes, and disabling defaults. The following example adds a
single exclude to the defaults for the lintspaces.newlines check:
`json`
{
"lintspaces": {
"newlines": {
"excludes": ["./src/assets/images/*/"]
}
}
}
To disable an existing default pattern, pass a negated version of the same pattern. For example, checking of trailing
newlines is currently disabled for SVG files. If you want to check SVG files, you would use a configuration like:
`json`
{
"lintspaces": {
"newlines": {
"excludes": ["!*.svg"]
}
}
}
This package was written as a replacement for fluid-grunt-lint-all.
The configuration of this package is very different, as this package does not
use Grunt or any conventions inherited from Grunt. You will need to create a
new configuration file using the above guide.
This package mitigates the problems we had previously with dependency resolution. When migrating away from
fluid-grunt-lint-all, you should be able to remove all Grunt` dependencies as well as ESLint plugin dependencies.