Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Declaring dependency on eslint in shared config (fixes #6617) #6985

Merged
merged 1 commit into from Aug 28, 2016

Conversation

alberto
Copy link
Member

@alberto alberto commented Aug 26, 2016

No description provided.

@mention-bot
Copy link

@alberto, thanks for your PR! By analyzing the annotation information on this pull request, we identified @nzakas, @Akkuma and @icyflame to be potential reviewers

@eslintbot
Copy link

LGTM

@platinumazure
Copy link
Member

LGTM, thanks!

@@ -26,6 +26,14 @@ Since `index.js` is just JavaScript, you can optionally read these settings for

Once your shareable config is ready, you can [publish to npm](https://docs.npmjs.com/getting-started/publishing-npm-packages) to share with others. We recommend using the `eslint` and `eslintconfig` keywords so others can easily find your module.

You should declare your dependency on eslint in `package.json` using the [peerDependecies](https://docs.npmjs.com/files/package.json#peerdependencies) field. The recommended way to declare a dependency for future proof compatibility is with the ">=" range syntax, using the lowest required eslint version. For example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small typo here: "peerDependecies" should be "peerDependencies"

@vitorbal
Copy link
Member

LGTM, just a small typo!

@eslintbot
Copy link

LGTM

@vitorbal
Copy link
Member

Lgtm, thanks!

@vitorbal vitorbal merged commit a989a7c into master Aug 28, 2016
@alberto alberto deleted the docs-shared-configs branch October 21, 2016 16:10
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants