eslint-config-tdp

eslint-config-tdp

This is my ESLint shareable config file. You're very welcome to use this and to contribute to it but I'm going to be pretty selfish with any changes/updates as config is a personal thing and I have a slightly odd programming style so what works for me probably isn't great for many/most others - or maybe it is, let me know!

Using eslint-config-tdp

For general guidance and background, see 'using a shareable config' on eslint.org.

The specifics for eslint-config-tdp (assuming you've got an NPM project set up already) are:

1. Add eslint-config-tdp as a dependency for your NPM package

npm install --save-dev eslint-config-tdp

2. Configure your NPM package to use eslint-config-tdp

Add the following to your package.json file:

{
...
  "eslintConfig":
  {
    "extends":
    [
      "tdp/node",
      "tdp/react",
      "tdp/ava",
      "tdp/flow-types"
    ]
  }
...  
}

If you already have an eslintConfig property in your package.json, just add the above to it (eslintConfig needs to be a root-level property of your package.json) - you can also add any custom rules here (in a rules property inside eslintConfig).

You can remove any of the tdp/... rulesets that you don't need e.g., if you're not using react, remove "tdp/react".

3. Create an NPM script to lint your files

Add the following to your package.json file:

{
  ...
  "scripts":
  {
    "lint": "./node_modules/eslint/bin/eslint.js ."
  }
  ...
}

Note that you might want to customise the name of the lint script ("lint" in the above) and/or the file pattern (. in the above).

4. Running the linter

You should now be able to lint your files by running the following from a command line in your NPM package root directory:

npm run lint

Notes:

• If you changed the name of the lint script, you'll need to replace "lint" in the above with whatever you called your lint script.
• If you're running linting programmatically, you can detect success in a *nix environment via an exit code of 0. Errors will return non-zero exit codes.

Contributing

With the above caveat, contributions are very welcome for fixes, improvements, new features, documentation, bug reports and/or ideas. Please create a Github issue initially so we can discuss and agree actions/approach and whether it's a good fit - that should save time all-round.

The ideal way to receive contributions is via a Github Pull Request from/to the master branch.

License

This package, in its entirety is MIT licensed.