Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

chore: use eslint-config-ipfs #3287

Merged
merged 7 commits into from
Oct 6, 2020
Merged

chore: use eslint-config-ipfs #3287

merged 7 commits into from
Oct 6, 2020

Conversation

Gozala
Copy link
Contributor

@Gozala Gozala commented Sep 15, 2020

Demonstrates use shared eslint config eslint-config-ipfs by integrating ipfs/aegir#638. Shared config uses new jsdoc plugin enabling use to remove bunch of eslint-disable-next-line valid-jsdoc comments. On the flip side it adds bit more requirements for structuring jsdoc comments. Most changes are generated automatically by eslint with --fix flag.

This change also intentionally adds .eslintrc files to every package with content { "extends": "ipfs" }, so that all the tools that support eslint pick up desired configuration. eslint-config-ipfs package itself isn't added to dependencies, because it gets installed as aegir dependency.

packages/ipfs/package.json Outdated Show resolved Hide resolved
@Gozala Gozala requested a review from jacobheun October 5, 2020 20:01
@Gozala
Copy link
Contributor Author

Gozala commented Oct 5, 2020

@jacobheun you've offered to take some reviews off of @achingbrain's plate. If you have time to review this it would be great to get this inn.

@achingbrain achingbrain merged commit 2ff7ca5 into master Oct 6, 2020
@achingbrain achingbrain deleted the gozala/eslintrc branch October 6, 2020 12:00
SgtPooki referenced this pull request in ipfs/js-kubo-rpc-client Aug 18, 2022
Uses shared eslint config `eslint-config-ipfs` by integrating ipfs/aegir#638. Shared config uses new jsdoc plugin enabling use to remove bunch of `eslint-disable-next-line valid-jsdoc` comments. On the flip side it adds bit more requirements for structuring jsdoc comments. Most changes are generated automatically by eslint with `--fix` flag.

This change also intentionally adds `.eslintrc` files to every package with content `{ "extends": "ipfs" }`, so that all the tools that support eslint pick up desired configuration.  `eslint-config-ipfs` package itself isn't added to dependencies, because it gets installed as `aegir` dependency.

Co-authored-by: achingbrain <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants