-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
[Docs] create setup.md
#1152
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
base: master
Are you sure you want to change the base?
[Docs] create setup.md
#1152
Conversation
Root file for the docs directory to help newbies find info on setting up the plugin.
@tiefling ping, any interest in completing this PR? |
I'm not sure that I can - I only have an option to Close it. |
@ljharb - Do I have to resolve the comments first? (not done this through GitHub before) |
@tiefling when they're resolved, you can click "resolve" - but the main thing is, updating the PR branch with the suggested changes :-) i can resolve things, rebase, and merge once the content is ready. |
I'll try and look at this over the next couple of days - I should have a spare 20 mins. It'll be a best endeavours exercise from memory given the time though! I switched from React to Vue full time last year!
|
Thanks, that would be appreciated :-) |
@ljharb - I think this is good now - I can't merge but it should be good to merge in now. |
All resolved and ready to merge |
38456f3
to
119b8b0
Compare
1. At the root of your project type <code>npm install --save-dev eslint-plugin-react</code> | ||
2. Check your package.json 'devDependencies' for the following entries (version numbers may vary, but it's important that **the eslint version matches the peerDependency version in eslint-plugin-react**)... | ||
<pre> | ||
"devDependencies": { | ||
"eslint": "^7.3.1", | ||
"eslint-plugin-react": "^7.10.3" | ||
} | ||
</pre> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think maybe it'd be better to use instructions like here: https://github.com/airbnb/javascript/blob/c5bee75b1b358a3749f1a6d38ee6fad73de28e29/packages/eslint-config-airbnb-base/README.md#eslint-config-airbnb-base-1 so it's a bit more automated.
"no-unused-vars": 2, | ||
"react/jsx-uses-vars": 2, | ||
"react/require-extensions": 0, | ||
"react/jsx-sort-prop-types": 0, | ||
"react/prop-types": [2, { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"no-unused-vars": 2, | |
"react/jsx-uses-vars": 2, | |
"react/require-extensions": 0, | |
"react/jsx-sort-prop-types": 0, | |
"react/prop-types": [2, { | |
"no-unused-vars": "error", | |
"react/jsx-uses-vars": "error", | |
"react/require-extensions": "off", | |
"react/jsx-sort-prop-types": "off", | |
"react/prop-types": ["error", { |
59af733
to
865ed16
Compare
069314a
to
181c68f
Compare
Root file for the docs directory to help newbies (like me) find info on setting up the plugin.