eslint-config-fluid v2.1.1

eslint-config-fluid

fluid-project eslint configuration

Using

To use the eslint configuration provided by this module add it as a dev dependency

npm install eslint-config-fluid --save-dev

and add an extends property to your .eslintrc.json file.

{
    "extends": "eslint-config-fluid"
}

Extend / Override Configuration

When using the eslint configuration provided by this module, you may have a case where you'd like to adjust or extend the configuration. To do this, add any additional configuration to your own .eslintrc.json file, which extends the one held in this project.

In the following example, we want to add a new global for the Infusion 2.0.0 versioned namespace to our project. The default configuration provided by the module defines a global for the generic "fluid" namespace, so we need to extend the configuration with an additional global, in this case "fluid_2_0_0".

{
    "extends": "eslint-config-fluid",
    "globals": {
        "fluid_2_0_0": true
    }
}

See the eslint user-guide for more configuration options.

Developing

See the eslint sharable configs documentation for full details.

Modifying Configuration

To modify the eslint rules provided by this module, update the configuration in the .eslintrc.json file. See the eslint user-guide for configuration options.

Testing

To test your changes locally, link the package globally on your system.

# run from the eslint-config-fluid directory.
# depending on your system, you may need to use sudo
npm link

Add your linked module to the package you want to test in.

# in the root directory for the package you want to test the configuration with
npm link eslint-config-fluid

Remove the links to clean up the test settings.

# run from the eslint-config-fluid directory.
# depending on your system, you may need to use sudo
npm unlink

# in the root directory for the package you tested the configuration with
npm unlink eslint-config-fluid

# run the install again to ensure that all the dependencies are properly installed
npm install