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.

Sign up for GitHub

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

Add WordPress JSDoc ESLint configuration #4245

Merged
merged 7 commits into from
Jan 10, 2018
Merged

Add WordPress JSDoc ESLint configuration #4245

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1cd1899
Add recommended WordPress JSDoc ESLint configuration
atimmer Jan 3, 2018
3041f2a
Require JSDoc for class methods
atimmer Jan 3, 2018
ab568f7
Implement eslines to only show warnings on changed lines.
atimmer Jan 4, 2018
3cd0585
Don't require JSDoc for test files
atimmer Jan 4, 2018
bc6f37a
Add missing eslines configuration
atimmer Jan 4, 2018
e352c97
Update to the latest `eslint-plugin-wordpress` commit
ntwb Jan 5, 2018
f8b9f7b
Update per latest `eslint-plugin-wordpress` changes
ntwb Jan 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .eslines.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"branches": {
"default": ["downgrade-unmodified-lines"]
},
"processors": {
"downgrade-unmodified-lines": {
"remote": "origin/master",
"rulesNotToDowngrade": ["no-unused-vars"]
Copy link
Contributor

Choose a reason for hiding this comment

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

Why this rule is different?

Copy link
Member

Choose a reason for hiding this comment

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

Via https://www.npmjs.com/package/eslines#how-to-use-it:

"The no-unused-vars rule won't be downgraded, though - this is one case where changing one line can cause a linting error in a different one so we recommend preventing it from downgrading."

}
}
}
19 changes: 17 additions & 2 deletions .eslintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"parser": "babel-eslint",
"extends": [
"wordpress",
"plugin:wordpress/jsdoc",
"plugin:react/recommended",
"plugin:jsx-a11y/recommended",
"plugin:jest/recommended"
Expand All @@ -27,6 +28,7 @@
"document": true
},
"plugins": [
"wordpress",
"react",
"jsx-a11y",
"jest"
Expand Down Expand Up @@ -175,6 +177,19 @@
"template-curly-spacing": [ "error", "always" ],
"valid-jsdoc": [ "error", { "requireReturn": false } ],
"valid-typeof": "error",
"yoda": "off"
}
"yoda": "off",
"require-jsdoc": [ "error", {
"require": {
"MethodDefinition": true
}
} ]
},
"overrides": [
{
"files": [ "{blocks,components,date,editor,element,i18n,data,utils}/**/test/*.js" ],
"rules": {
"require-jsdoc": "off"
}
}
]
}
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"dom-scroll-into-view": "1.2.1",
"element-closest": "2.0.2",
"escape-string-regexp": "1.0.5",
"eslint-plugin-wordpress": "git://github.com/WordPress-Coding-Standards/eslint-plugin-wordpress.git#a5fdd5177c747562ddc3b03e069fcbf131632490",
"hpq": "1.2.0",
"jed": "1.1.1",
"jquery": "3.2.1",
Expand Down Expand Up @@ -73,6 +74,7 @@
"deep-freeze": "0.0.1",
"enzyme": "3.2.0",
"enzyme-adapter-react-16": "1.1.0",
"eslines": "1.1.0",
"eslint": "4.9.0",
"eslint-config-wordpress": "2.0.0",
"eslint-plugin-jest": "21.5.0",
Expand Down Expand Up @@ -134,7 +136,7 @@
"prebuild": "check-node-version --package",
"build": "cross-env BABEL_ENV=default NODE_ENV=production webpack",
"gettext-strings": "cross-env BABEL_ENV=gettext webpack",
"lint": "eslint .",
"lint": "eslint -f json . | eslines",
"predev": "check-node-version --package",
"dev": "cross-env BABEL_ENV=default webpack --watch",
"test": "npm run lint && npm run test-unit",
Expand Down