eslint-config-ipfs

ESLint Shareable Config for IPFS project

Usage no npm install needed!

<script type="module">
  import eslintConfigIpfs from 'https://cdn.skypack.dev/eslint-config-ipfs';
</script>

README

eslint-config-ipfs

Node.js CI package styled with prettier

This package provides IPFS's .eslintrc as an extensible shared config.

Usage

Provided configuration contains ESLint rules followed by JS libraries in the JS IPFS ecosystem. It provides slightly separate rule sets for .js and .ts files. To use this configuration you'll need .eslintrc file in your project root with a following content:

{
  "extends": "ipfs"
}

If you use AEgir this config will comes with it, so above .eslintrc is only thing you'll need. If you choose to use ESLint directly, you'll need to add this package to your (dev) dependcies and satisfy "typescript" optional peer dependency yourself.

JS only setup

If you do not have .ts files in your tree chances are you don't care about typescript and don't want to add "typescript" dependency. In that case you can use another .eslintrc configuration with a following content:

{
  "extends": "ipfs/js"
}