quine-global-labs/mirror-cockpit-project-cockpit
1
0
Fork 0
mirror of https://github.com/cockpit-project/cockpit.git synced 2026-11-03 21:49:50 -09:00
Code Issues Projects Releases Packages Wiki Activity
mirror-cockpit-project-cockpit/.eslintrc.json

104 lines
3.3 KiB
JSON
Raw Permalink Normal View History

Add linting for es/jsx code We want to treat using undefined variables or having unused variables as errors. Closes #5800 Reviewed-by: Stef Walter <stefw@redhat.com>
2017-01-27 02:20:22 -09:00
{
eslintrc: Set "root" to true Eslint shimmies up directories looking for more eslintrcs. As make-checkout now clones projects in a subdirectory, this can result in some strange interactions. Each subproject using eslint should enable this as well. https://eslint.org/docs/user-guide/configuring Closes #12610
2019-08-26 03:17:39 -08:00
"root": true,
Add linting for es/jsx code We want to treat using undefined variables or having unused variables as errors. Closes #5800 Reviewed-by: Stef Walter <stefw@redhat.com>
2017-01-27 02:20:22 -09:00
"env": {
"browser": true,
Bump eslint version Autofix warnings: Expected property shorthand
2023-02-27 07:42:41 -09:00
"es2022": true
Add linting for es/jsx code We want to treat using undefined variables or having unused variables as errors. Closes #5800 Reviewed-by: Stef Walter <stefw@redhat.com>
2017-01-27 02:20:22 -09:00
},
eslintrc: extend recommended configuration of flowtype plugin Previously it was in the section for customized rules, but not rules were specified, resulting in this not taking any effect.
2022-02-17 00:06:57 -09:00
"extends": [
"eslint:recommended", "standard", "standard-jsx", "standard-react",
"plugin:jsx-a11y/recommended"
],
Add linting for es/jsx code We want to treat using undefined variables or having unused variables as errors. Closes #5800 Reviewed-by: Stef Walter <stefw@redhat.com>
2017-01-27 02:20:22 -09:00
"parserOptions": {
Bump eslint version Autofix warnings: Expected property shorthand
2023-02-27 07:42:41 -09:00
"ecmaVersion": "2022"
Add linting for es/jsx code We want to treat using undefined variables or having unused variables as errors. Closes #5800 Reviewed-by: Stef Walter <stefw@redhat.com>
2017-01-27 02:20:22 -09:00
},
eslintrc: remove jsx-a11y from the plugins section As we are already extending the recommended settings without modifications.
2022-02-17 00:13:59 -09:00
"plugins": ["react", "react-hooks"],
Add linting for es/jsx code We want to treat using undefined variables or having unused variables as errors. Closes #5800 Reviewed-by: Stef Walter <stefw@redhat.com>
2017-01-27 02:20:22 -09:00
"rules": {
eslint: Enable "ident" rule Set to "4" spaces
2018-04-24 04:17:32 -08:00
"indent": ["error", 4,
{
"ObjectExpression": "first",
"CallExpression": {"arguments": "first"},
eslint: Ignore JSX attribute indention This aspect really was a change for the worse. Revert the JSX attribute indentation of commit a6f180eb37 and tell eslint to ignore them. There currently does not seem to be a mode to enforce vertically aligned attributes. Closes #9044
2018-04-25 22:30:35 -08:00
"MemberExpression": 2,
"ignoredNodes": [ "JSXAttribute" ]
eslint: Enable "ident" rule Set to "4" spaces
2018-04-24 04:17:32 -08:00
}],
eslintrc: allow 3 chained calls on one line We have some semi-reasonable patterns of code which chain 3 calls on a single line. Unfortunately there doesn't seem to be a way to distinguish between chaining for promises and for other things (like text manipulation). Line length can be a proxy for that, though.
2022-03-28 02:18:48 -08:00
"newline-per-chained-call": ["error", { "ignoreChainWithDepth": 3 }],
eslint: Enable "lines-between-class-members" rule Closes #9694
2018-07-20 02:35:37 -08:00
"lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
eslint: Enable "prefer-promise-reject-errors" rule See https://eslint.org/docs/rules/prefer-promise-reject-errors for rationale. Closes #9168
2018-05-14 11:37:25 -08:00
"prefer-promise-reject-errors": ["error", { "allowEmptyReject": true }],
eslint: Enable no-var rule `var` has broken/unexpected scoping in JavaScript, and can lead to subtle errors. It's preferable and safer to use `const` whenever possible, and `let` where necessary. Most pages got updated by now, so let's make sure they stay that way. Disable the rule for the four remaining known pages which still use `var`. Also temporarily downgrade the `error` to `warn` when running `npm run eslint`, as that is covered by the unit-tests "distcheck" scenario. This requires touching package.json and thus a node_modules rebuild.
2021-09-21 21:32:17 -08:00
"no-var": "error",
eslint: Sort and regroup checks * The first block customizes default rules. * The second block disables rules that we don't want, as they are too intrusive while not being important, or an æsthetic regression (such as forcing properties to not be aligned any more). * The third block disables rules which we eventually want to enable, but still have to fix.
2018-05-04 04:50:36 -08:00
"react/jsx-indent": ["error", 4],
package.json: Switch to markdown-to-jsx The PackageKit UpdateDetail signal provides markdown in the `update_text` and uses remarkable to parse the markdown contents. Remarkable however has not been updated since 6 years, additionally it requires us to use `dangerouslySetInnerHTML` which can lead to XSS issues. The npm ecosystem has two other markdown alternatives `react-markdown` and a `markdown-to-jsx`. The latter has zero dependencies while `react-markdown` has eleven and requires additional plugins like `rehype-external-links` to add a rel/target to external links. https://www.freedesktop.org/software/PackageKit/gtk-doc/Transaction.html https://github.com/jonschlinkert/remarkable/issues/438
2026-06-03 10:14:52 -08:00
"react/no-danger": "error",
eslint: Enable "semi" rule Fix semicolons in all files. Closes #9736
2018-07-26 11:58:41 -08:00
"semi": ["error", "always", { "omitLastInOneLineBlock": true }],
webpack: Use eslint for .jsx and .es6 files ESLint is used for .jsx and .es6 files. Starnard rules for React and ES6 are set. The eslint is still executed as webpack preloader. Convenient script is added to package.json to either run or automatically fix the issues via: npm run eslint npm run eslint:fix Temporarily, rules not met in recent codebase are disabled. The plan is to reenable rule-by-rule in follow-ups along corresponding fixes. Closes #9000
2018-04-16 01:18:14 -08:00
build: Add eslint rules for React hooks These make components with simple state (only a few variables) easier to read and maintain. See https://reactjs.org/docs/hooks-intro.html for details. Hook are available since React 16.8, and we already depend on 16.10. We don't have any hooks yet in our code. This enables the ESLint plugin to guide us right from the start.
2019-10-17 23:24:38 -08:00
"react-hooks/rules-of-hooks": "error",
"react-hooks/exhaustive-deps": "error",
webpack: Use eslint for .jsx and .es6 files ESLint is used for .jsx and .es6 files. Starnard rules for React and ES6 are set. The eslint is still executed as webpack preloader. Convenient script is added to package.json to either run or automatically fix the issues via: npm run eslint npm run eslint:fix Temporarily, rules not met in recent codebase are disabled. The plan is to reenable rule-by-rule in follow-ups along corresponding fixes. Closes #9000
2018-04-16 01:18:14 -08:00
"camelcase": "off",
"comma-dangle": "off",
"curly": "off",
eslint: Disable "no-template-curly-in-string" rule These are false positives, as we often use i18n like cockpit.format(_("foo ${bar}"), ...) where we do want curly formats in strings.
2018-11-22 12:59:07 -09:00
"no-template-curly-in-string": "off",
webpack: Use eslint for .jsx and .es6 files ESLint is used for .jsx and .es6 files. Starnard rules for React and ES6 are set. The eslint is still executed as webpack preloader. Convenient script is added to package.json to either run or automatically fix the issues via: npm run eslint npm run eslint:fix Temporarily, rules not met in recent codebase are disabled. The plan is to reenable rule-by-rule in follow-ups along corresponding fixes. Closes #9000
2018-04-16 01:18:14 -08:00
"jsx-quotes": "off",
eslint: Sort and regroup checks * The first block customizes default rules. * The second block disables rules that we don't want, as they are too intrusive while not being important, or an æsthetic regression (such as forcing properties to not be aligned any more). * The third block disables rules which we eventually want to enable, but still have to fix.
2018-05-04 04:50:36 -08:00
"no-console": "off",
webpack: Use eslint for .jsx and .es6 files ESLint is used for .jsx and .es6 files. Starnard rules for React and ES6 are set. The eslint is still executed as webpack preloader. Convenient script is added to package.json to either run or automatically fix the issues via: npm run eslint npm run eslint:fix Temporarily, rules not met in recent codebase are disabled. The plan is to reenable rule-by-rule in follow-ups along corresponding fixes. Closes #9000
2018-04-16 01:18:14 -08:00
"quotes": "off",
eslint: Sort and regroup checks * The first block customizes default rules. * The second block disables rules that we don't want, as they are too intrusive while not being important, or an æsthetic regression (such as forcing properties to not be aligned any more). * The third block disables rules which we eventually want to enable, but still have to fix.
2018-05-04 04:50:36 -08:00
"react/jsx-curly-spacing": "off",
"react/jsx-indent-props": "off",
package.json: Bump up version of eslint Disable rules that need complex fixing, these should be fixed as follow-ups. First three should really be fixed, the rest is not that important. Closes #12644
2019-08-27 23:49:37 -08:00
"react/jsx-handler-names": "off",
"react/jsx-closing-bracket-location": "off",
"react/jsx-closing-tag-location": "off",
"react/jsx-curly-newline": "off",
"react/jsx-first-prop-new-line": "off",
eslint: enable no-useless-fragment rule by default This rule is not part of the standard ESLint recommends set but is useful and can be auto-fixed.
2024-04-22 06:44:04 -08:00
"react/jsx-no-useless-fragment": "error",
eslint: Sort and regroup checks * The first block customizes default rules. * The second block disables rules that we don't want, as they are too intrusive while not being important, or an æsthetic regression (such as forcing properties to not be aligned any more). * The third block disables rules which we eventually want to enable, but still have to fix.
2018-05-04 04:50:36 -08:00
"react/prop-types": "off",
webpack: Use eslint for .jsx and .es6 files ESLint is used for .jsx and .es6 files. Starnard rules for React and ES6 are set. The eslint is still executed as webpack preloader. Convenient script is added to package.json to either run or automatically fix the issues via: npm run eslint npm run eslint:fix Temporarily, rules not met in recent codebase are disabled. The plan is to reenable rule-by-rule in follow-ups along corresponding fixes. Closes #9000
2018-04-16 01:18:14 -08:00
"space-before-function-paren": "off",
eslintrc: Permanently disable "standard/no-callback-literal" rule It was previously in the "desirable to turn on" section, but it complains about valid code and is considered to be removed: https://github.com/standard/eslint-plugin-standard/issues/27
2018-05-14 11:18:14 -08:00
"standard/no-callback-literal": "off",
eslint: Sort and regroup checks * The first block customizes default rules. * The second block disables rules that we don't want, as they are too intrusive while not being important, or an æsthetic regression (such as forcing properties to not be aligned any more). * The third block disables rules which we eventually want to enable, but still have to fix.
2018-05-04 04:50:36 -08:00
eslintrc: Enable `eqeqeq` Resolves: COCKPIT-1910
2026-10-30 02:34:27 -08:00
"eqeqeq": ["error", "smart"],
eslint: Add a rule to disallow using cockpit.all() cockpit.all() is deprecated and should not be used in new code. Add an eslint exception and a comment to all call sites for which using Promise.all() is not yet possible (see previous commit). Closes #10949
2019-01-10 23:32:25 -09:00
"react/jsx-no-bind": "off",
eslintrc: reenable array callback return rule and fix all related errors Reasoning: A map() creates an array, so a return is expected for all code paths (if/elses). If one does not want an array or to return data, they should use forEach instead. Similar for filter(). An expection in our codebase was cockpit.transport.filter which confused the linter, thinking that its an array filter. I disabled linting on these lines for this rule.
2022-02-17 01:09:17 -09:00
"react/jsx-wrap-multilines": "off"
Add linting for es/jsx code We want to treat using undefined variables or having unused variables as errors. Closes #5800 Reviewed-by: Stef Walter <stefw@redhat.com>
2017-01-27 02:20:22 -09:00
},
"globals": {
.eslintrc.json: boolean values are deprecated for globals As per ESLint docs these options still allow boolean values but in reality they are deprecated and replaced by "readonly". Oxlint currently cannot deal with this and therefore cannot parse the eslint configuration file. https://eslint.org/docs/latest/use/configure/language-options#using-configuration-files
2024-05-19 03:34:11 -08:00
"require": "readonly",
"module": "readonly"
eslint: Mute warning about missing react version Previously we were seeing the following error when running eslint. Warning: React version not specified in eslint-plugin-react settings. See https://github.com/yannickcr/eslint-plugin-react#configuration. Closes #10147
2018-09-24 23:19:25 -08:00
},
test/static-code: add support for typescript Add the typescript compiler to our devel dependencies and run it from `test/static-code`. We add an initial cockpit.d.ts and a tsconfig.json which will get `tsc` to report errors against any `.ts` or `.tsx` files.
2024-04-10 00:52:19 -08:00
"overrides": [
{
"files": ["**/*.ts", "**/*.tsx"],
"plugins": [
"@typescript-eslint"
],
.eslintrc.json: setup some TypeScript rules - disable the base no-use-before-define rule: it doesn't understand that TypeScript allows using types before they're defined. Enable the TypeScript-specific rule for it for TypeScript files. - add an 'unused variables' config matching the default rules of the TypeScript compiler Both of these rule stanzas were copied from the documentation of the typescript-eslint plugin. Links to those pages are provided in comments, which are valid in the extended JSON syntax used for eslintrc. Tweak our test/static-code rule for JSON to also exempt eslintrc from our strict checking.
2024-07-15 17:49:44 -08:00
"extends": "plugin:@typescript-eslint/recommended",
test/static-code: add support for typescript Add the typescript compiler to our devel dependencies and run it from `test/static-code`. We add an initial cockpit.d.ts and a tsconfig.json which will get `tsc` to report errors against any `.ts` or `.tsx` files.
2024-04-10 00:52:19 -08:00
"parser": "@typescript-eslint/parser",
"parserOptions": {
build: Use "projectService" instead of "project" for eslint Because magic. Fixes #21246
2024-11-11 02:15:51 -09:00
"projectService": ["./tsconfig.json"]
.eslintrc.json: setup some TypeScript rules - disable the base no-use-before-define rule: it doesn't understand that TypeScript allows using types before they're defined. Enable the TypeScript-specific rule for it for TypeScript files. - add an 'unused variables' config matching the default rules of the TypeScript compiler Both of these rule stanzas were copied from the documentation of the typescript-eslint plugin. Links to those pages are provided in comments, which are valid in the extended JSON syntax used for eslintrc. Tweak our test/static-code rule for JSON to also exempt eslintrc from our strict checking.
2024-07-15 17:49:44 -08:00
},
"rules": {
// https://typescript-eslint.io/rules/no-use-before-define
// Note: you must disable the base rule as it can report incorrect errors
"no-use-before-define": "off",
build: Allow TS functions to be used before their definition This is fine, TypeScript will check them correctly. And it is very useful for global functions, at least. And we allow functions to be used before their definitions in JavaScript files.
2024-11-13 22:24:56 -09:00
"@typescript-eslint/no-use-before-define": [
"error",
{
"functions": false
}
],
.eslintrc.json: setup some TypeScript rules - disable the base no-use-before-define rule: it doesn't understand that TypeScript allows using types before they're defined. Enable the TypeScript-specific rule for it for TypeScript files. - add an 'unused variables' config matching the default rules of the TypeScript compiler Both of these rule stanzas were copied from the documentation of the typescript-eslint plugin. Links to those pages are provided in comments, which are valid in the extended JSON syntax used for eslintrc. Tweak our test/static-code rule for JSON to also exempt eslintrc from our strict checking.
2024-07-15 17:49:44 -08:00
// as recommended by https://typescript-eslint.io/rules/no-unused-vars/
"@typescript-eslint/no-unused-vars": [
"error",
{
"args": "all",
"argsIgnorePattern": "^_",
"caughtErrors": "all",
"caughtErrorsIgnorePattern": "^_",
"destructuredArrayIgnorePattern": "^_",
"varsIgnorePattern": "^_",
"ignoreRestSiblings": true
}
]
test/static-code: add support for typescript Add the typescript compiler to our devel dependencies and run it from `test/static-code`. We add an initial cockpit.d.ts and a tsconfig.json which will get `tsc` to report errors against any `.ts` or `.tsx` files.
2024-04-10 00:52:19 -08:00
}
}
],
eslint: Mute warning about missing react version Previously we were seeing the following error when running eslint. Warning: React version not specified in eslint-plugin-react settings. See https://github.com/yannickcr/eslint-plugin-react#configuration. Closes #10147
2018-09-24 23:19:25 -08:00
"settings": {
"react": {
.eslintrc.json: Change from react:latest to react:detect In this case it picks the version we use. (latest was picking up something older than 16.2)
2019-08-29 00:55:01 -08:00
"version": "detect"
eslint: Mute warning about missing react version Previously we were seeing the following error when running eslint. Warning: React version not specified in eslint-plugin-react settings. See https://github.com/yannickcr/eslint-plugin-react#configuration. Closes #10147
2018-09-24 23:19:25 -08:00
}
Add linting for es/jsx code We want to treat using undefined variables or having unused variables as errors. Closes #5800 Reviewed-by: Stef Walter <stefw@redhat.com>
2017-01-27 02:20:22 -09:00
}
}
Reference in a new issue Copy permalink