eslint-config-ipfs


> ESLint Shareable Config for IPFS project

Table of contents

- Install
- Usage
- License
- Contribute

Install

``console
$ npm i eslint-config-ipfs
`

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:

`json
{
"extends": "ipfs"
}
`

Or a key in your package.json with:

`json
{
"eslintConfig": {
"extends": "ipfs"
}
}
`

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

License

Licensed under either of

- Apache 2.0, (LICENSE-APACHE / )
- MIT (LICENSE-MIT / )

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.


[node.js ci]: https://github.com/ipfs/eslint-config-ipfs/workflows/Node.js%20CI/badge.svg

[version.icon]: https://img.shields.io/npm/v/eslint-config-ipfs.svg

[package.url]: https://npmjs.org/package/eslint-config-ipfs

[downloads.image]: https://img.shields.io/npm/dm/eslint-config-ipfs.svg

[downloads.url]: https://npmjs.org/package/eslint-config-ipfs

[prettier.icon]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg

[prettier.url]: https://github.com/prettier/prettier

[ts-jsdoc]: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html

[aegir]: https://github.com/ipfs/aegir "Automated JavaScript project management."