@qlik/eslint-config 0.8.2 → 1.0.0

package/src/configs/rules/import-x.js

@@ -0,0 +1,159 @@
+// @ts-check
+
+/**
+ * @satisfies {import("../../types/index.js").ESLintFlatConfig["rules"]}
+ *
+ * eslint-plugin-import-x package https://github.com/un-ts/eslint-plugin-import-x/blob/master/README.md
+ */
+const rules = {
+  // modify rules from eslint-plugin-import-x here
+  /* -------------------------------------------------------------------------- */
+  /*                              Static analysis:                              */
+  /* -------------------------------------------------------------------------- */
+  // ensure imports point to files/modules that can be resolved
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-unresolved.md
+  "import-x/no-unresolved": ["error", { commonjs: true, caseSensitive: true }],
+  // ensure named imports coupled with named exports
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/named.md#when-not-to-use-it
+  "import-x/named": "error",
+  /* -------------------------------------------------------------------------- */
+  /*                              Helpful warnings:                             */
+  /* -------------------------------------------------------------------------- */
+  // disallow invalid exports, e.g. multiple defaults
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/export.md
+  "import-x/export": "error",
+  // do not allow a default import name to match a named export
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-named-as-default.md
+  "import-x/no-named-as-default": "error",
+  // warn on accessing default export property names that are also named exports
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-named-as-default-member.md
+  "import-x/no-named-as-default-member": "error",
+  // disallow use of jsdoc-marked-deprecated imports
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-deprecated.md
+  "import-x/no-deprecated": "warn",
+
+  // Can depend on bundler setup, and other things. Disabling for now.
+  // Forbid the use of extraneous packages
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-extraneous-dependencies.md
+  // paths are treated both as absolute paths, and relative to process.cwd()
+  "import-x/no-extraneous-dependencies": [
+    "off",
+    {
+      devDependencies: [
+        "**/test*/**",
+        "**/mocks/**",
+        "**/mock/**",
+        "test/**", // tape, common npm pattern
+        "tests/**", // also common npm pattern
+        "spec/**", // mocha, rspec-like pattern
+        "**/__tests__/**", // jest pattern
+        "**/__mocks__/**", // jest pattern
+        "test.{js,jsx,ts,tsx}", // repos with a single test file
+        "test-*.{js,jsx,ts,tsx}", // repos with multiple top-level test files
+        "**/*{.,_}{test,spec}.{js,jsx,ts,tsx}", // tests where the extension or filename suffix denotes that it is a test
+        "**/jest.config.{cjs,mjs,js,ts}", // jest config
+        "**/jest.setup.{cjs,mjs,js,ts}", // jest setup
+        "**/vitest.config.{cjs,mjs,js,ts}", // vitest config
+        "**/vue.config.{cjs,mjs,js,ts}", // vue-cli config
+        "**/svelte.config.{cjs,mjs,js,ts}", // svelte config
+        "**/tsup.config.{cjs,mjs,js,ts}", // tsup config
+        "**/playwright.config.{cjs,mjs,js,ts}", // playwright config
+        "**/webpack.config.{cjs,mjs,js,ts}", // webpack config
+        "**/webpack.mod.{cjs,mjs,js,ts}", // webpack config
+        "**/rollup.config.{cjs,mjs,js,ts}", // rollup config
+        "**/rollup.config.*cjs,mjs,.{js,ts}", // rollup config
+        "**/protractor.conf.{cjs,mjs,js,ts}", // protractor config
+        "**/protractor.conf.*.{cjs,mjs,js,ts}", // protractor config
+        "**/.eslintrc.{cjs,mjs,js,ts}", // eslint config
+        "**/eslint.config.{cjs,mjs,js,ts}", // eslint config
+        "**/.prettierrc.{cjs,mjs,js,ts}", // prettier config
+        "**/.prettierrc", // prettier config
+      ],
+      optionalDependencies: false,
+    },
+  ],
+  // Forbid mutable exports
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-mutable-exports.md
+  "import-x/no-mutable-exports": "error",
+  /* -------------------------------------------------------------------------- */
+  /*                               Module systems:                              */
+  /* -------------------------------------------------------------------------- */
+  // disallow AMD require/define
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-amd.md
+  "import-x/no-amd": "error",
+  // No Node.js builtin modules
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-nodejs-modules.md
+  // TODO: enable?
+  "import-x/no-nodejs-modules": "off",
+  /* -------------------------------------------------------------------------- */
+  /*                                Style guide:                                */
+  /* -------------------------------------------------------------------------- */
+  // disallow duplicate imports
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-duplicates.md
+  "import-x/no-duplicates": "error",
+  // Ensure consistent use of file extension within the import path
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/extensions.md
+  "import-x/extensions": [
+    "error",
+    "ignorePackages",
+    {
+      js: "never",
+      mjs: "never",
+      jsx: "never",
+      ts: "never",
+      mts: "never",
+      tsx: "never",
+    },
+  ],
+  // Require a newline after the last import-x/require in a group
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/newline-after-import.md
+  "import-x/newline-after-import": "error",
+  // Require modules with a single export to use a default export
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/prefer-default-export.md
+  "import-x/prefer-default-export": "off",
+  // Forbid import of modules using absolute paths
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-absolute-path.md
+  "import-x/no-absolute-path": "error",
+  // Forbid require() calls with expressions
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-dynamic-require.md
+  "import-x/no-dynamic-require": "error",
+  // Forbid Webpack loader syntax in imports
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-webpack-loader-syntax.md
+  "import-x/no-webpack-loader-syntax": "error",
+  // Prevent importing the default as if it were named
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-named-default.md
+  "import-x/no-named-default": "error",
+  // Forbid a module from importing itself
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-self-import.md
+  "import-x/no-self-import": "error",
+  // Forbid cyclical dependencies between modules
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-cycle.md
+  "import-x/no-cycle": ["error", { maxDepth: "∞" }],
+  // Ensures that there are no useless path segments
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-useless-path-segments.md
+  "import-x/no-useless-path-segments": ["error", { commonjs: true }],
+  // Reports modules without any exports, or with unused exports
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-unused-modules.md
+  "import-x/no-unused-modules": "error",
+  // Reports the use of import declarations with CommonJS exports in any module except for the main module.
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-import-module-exports.md
+  "import-x/no-import-module-exports": [
+    "error",
+    {
+      exceptions: [],
+    },
+  ],
+  // Use this rule to prevent importing packages through relative paths.
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-relative-packages-exports.md
+  "import-x/no-relative-packages": "error",
+  // This seems conflicting with @typescript-eslint/no-import-type-side-effects
+  // enforce a consistent style for type specifiers (inline or top-level)
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/consistent-type-specifier-style.md
+  "import-x/consistent-type-specifier-style": "off",
+  // Makes importing runtime (`import type {} from ...`) types annoying
+  // Reports the use of empty named import blocks.
+  // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-empty-named-blocks.md
+  "import-x/no-empty-named-blocks": "off",
+};
+
+export default rules;

package/src/configs/rules/index.js

@@ -0,0 +1,17 @@
+import eslintCoreRules from "./eslint-core.js";
+import importXRules from "./import-x.js";
+import reactA11yRules from "./react-a11y.js";
+import reactHooksRules from "./react-hooks.js";
+import reactRules from "./react.js";
+import testingLibraryRules from "./testing-library.js";
+import typescriptRules from "./typescript.js";
+
+export default {
+  importXRules,
+  eslintCoreRules,
+  typescriptRules,
+  reactRules,
+  reactA11yRules,
+  reactHooksRules,
+  testingLibraryRules,
+};

package/src/configs/rules/node.js

@@ -0,0 +1,10 @@
+// @ts-check
+
+/**
+ * @satisfies {import("../../types/index.js").ESLintFlatConfig["rules"]}
+ */
+const rules = {
+  // TODO use eslint-plugin-n https://github.com/eslint-community/eslint-plugin-n
+};
+
+export default rules;

package/src/configs/rules/react-a11y.js

@@ -0,0 +1,232 @@
+// @ts-check
+
+/**
+ * @satisfies {import("../../types/index.js").ESLintFlatConfig["rules"]}
+ */
+const rules = {
+  // Enforce that all elements that require alternative text have meaningful information
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/alt-text.md
+  "jsx-a11y/alt-text": [
+    "error",
+    {
+      elements: ["img", "object", "area", 'input[type="image"]'],
+      img: [],
+      object: [],
+      area: [],
+      'input[type="image"]': [],
+    },
+  ],
+
+  // Enforce that anchors have content
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/anchor-has-content.md
+  "jsx-a11y/anchor-has-content": ["error", { components: [] }],
+
+  // ensure <a> tags are valid
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/0745af376cdc8686d85a361ce36952b1fb1ccf6e/docs/rules/anchor-is-valid.md
+  "jsx-a11y/anchor-is-valid": [
+    "error",
+    {
+      components: ["Link"],
+      specialLink: ["to"],
+      aspects: ["noHref", "invalidHref", "preferButton"],
+    },
+  ],
+
+  // elements with aria-activedescendant must be tabbable
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-activedescendant-has-tabindex.md
+  "jsx-a11y/aria-activedescendant-has-tabindex": "error",
+
+  // Enforce all aria-* props are valid.
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-props.md
+  "jsx-a11y/aria-props": "error",
+
+  // Enforce ARIA state and property values are valid.
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-proptypes.md
+  "jsx-a11y/aria-proptypes": "error",
+
+  // Require ARIA roles to be valid and non-abstract
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-role.md
+  "jsx-a11y/aria-role": ["error", { ignoreNonDOM: false }],
+
+  // Enforce that elements that do not support ARIA roles, states, and
+  // properties do not have those attributes.
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-unsupported-elements.md
+  "jsx-a11y/aria-unsupported-elements": "error",
+
+  // require onClick be accompanied by onKeyUp/onKeyDown/onKeyPress
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/click-events-have-key-events.md
+  "jsx-a11y/click-events-have-key-events": "error",
+
+  // Enforce that a control (an interactive element) has a text label.
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/control-has-associated-label.md
+  "jsx-a11y/control-has-associated-label": [
+    "error",
+    {
+      labelAttributes: ["label"],
+      controlComponents: [],
+      ignoreElements: ["audio", "canvas", "embed", "input", "textarea", "tr", "video"],
+      ignoreRoles: [
+        "grid",
+        "listbox",
+        "menu",
+        "menubar",
+        "radiogroup",
+        "row",
+        "tablist",
+        "toolbar",
+        "tree",
+        "treegrid",
+      ],
+      depth: 5,
+    },
+  ],
+
+  // ensure <hX> tags have content and are not aria-hidden
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/heading-has-content.md
+  "jsx-a11y/heading-has-content": ["error", { components: [""] }],
+
+  // require HTML elements to have a "lang" prop
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/html-has-lang.md
+  "jsx-a11y/html-has-lang": "error",
+
+  // ensure iframe elements have a unique title
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/iframe-has-title.md
+  "jsx-a11y/iframe-has-title": "error",
+
+  // Prevent img alt text from containing redundant words like "image", "picture", or "photo"
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/img-redundant-alt.md
+  "jsx-a11y/img-redundant-alt": "error",
+
+  // Elements with an interactive role and interaction handlers must be focusable
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/interactive-supports-focus.md
+  "jsx-a11y/interactive-supports-focus": "error",
+
+  // Enforce that a label tag has a text label and an associated control.
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/b800f40a2a69ad48015ae9226fbe879f946757ed/docs/rules/label-has-associated-control.md
+  "jsx-a11y/label-has-associated-control": [
+    "error",
+    {
+      labelComponents: [],
+      labelAttributes: [],
+      controlComponents: [],
+      assert: "both",
+      depth: 25,
+    },
+  ],
+
+  // require HTML element's lang prop to be valid
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/lang.md
+  "jsx-a11y/lang": "error",
+
+  // media elements must have captions
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/media-has-caption.md
+  "jsx-a11y/media-has-caption": [
+    "error",
+    {
+      audio: [],
+      video: [],
+      track: [],
+    },
+  ],
+
+  // require that mouseover/out come with focus/blur, for keyboard-only users
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/mouse-events-have-key-events.md
+  "jsx-a11y/mouse-events-have-key-events": "error",
+
+  // Prevent use of `accessKey`
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-access-key.md
+  "jsx-a11y/no-access-key": "error",
+
+  // prohibit autoFocus prop
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-autofocus.md
+  "jsx-a11y/no-autofocus": ["error", { ignoreNonDOM: true }],
+
+  // prevent distracting elements, like <marquee> and <blink>
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-distracting-elements.md
+  "jsx-a11y/no-distracting-elements": [
+    "error",
+    {
+      elements: ["marquee", "blink"],
+    },
+  ],
+
+  // WAI-ARIA roles should not be used to convert an interactive element to non-interactive
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-interactive-element-to-noninteractive-role.md
+  "jsx-a11y/no-interactive-element-to-noninteractive-role": [
+    "error",
+    {
+      tr: ["none", "presentation"],
+    },
+  ],
+
+  // A non-interactive element does not support event handlers (mouse and key handlers)
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-noninteractive-element-interactions.md
+  "jsx-a11y/no-noninteractive-element-interactions": [
+    "error",
+    {
+      handlers: ["onClick", "onMouseDown", "onMouseUp", "onKeyPress", "onKeyDown", "onKeyUp"],
+    },
+  ],
+
+  // WAI-ARIA roles should not be used to convert a non-interactive element to interactive
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-noninteractive-element-to-interactive-role.md
+  "jsx-a11y/no-noninteractive-element-to-interactive-role": [
+    "error",
+    {
+      ul: ["listbox", "menu", "menubar", "radiogroup", "tablist", "tree", "treegrid"],
+      ol: ["listbox", "menu", "menubar", "radiogroup", "tablist", "tree", "treegrid"],
+      li: ["menuitem", "option", "row", "tab", "treeitem"],
+      table: ["grid"],
+      td: ["gridcell"],
+    },
+  ],
+
+  // Tab key navigation should be limited to elements on the page that can be interacted with.
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-noninteractive-tabindex.md
+  "jsx-a11y/no-noninteractive-tabindex": [
+    "error",
+    {
+      tags: [],
+      roles: ["tabpanel"],
+      allowExpressionValues: true,
+    },
+  ],
+
+  // ensure HTML elements do not specify redundant ARIA roles
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-redundant-roles.md
+  "jsx-a11y/no-redundant-roles": [
+    "error",
+    {
+      nav: ["navigation"],
+    },
+  ],
+
+  // Enforce that DOM elements without semantic behavior not have interaction handlers
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-static-element-interactions.md
+  "jsx-a11y/no-static-element-interactions": [
+    "error",
+    {
+      handlers: ["onClick", "onMouseDown", "onMouseUp", "onKeyPress", "onKeyDown", "onKeyUp"],
+    },
+  ],
+
+  // Enforce that elements with ARIA roles must have all required attributes
+  // for that role.
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/role-has-required-aria-props.md
+  "jsx-a11y/role-has-required-aria-props": "error",
+
+  // Enforce that elements with explicit or implicit roles defined contain
+  // only aria-* properties supported by that role.
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/role-supports-aria-props.md
+  "jsx-a11y/role-supports-aria-props": "error",
+
+  // only allow <th> to have the "scope" attr
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/scope.md
+  "jsx-a11y/scope": "error",
+
+  // Enforce tabIndex value is not greater than zero.
+  // https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/tabindex-no-positive.md
+  "jsx-a11y/tabindex-no-positive": "error",
+};
+
+export default rules;

package/src/configs/rules/react-hooks.js

@@ -0,0 +1,16 @@
+// @ts-check
+
+/**
+ * @satisfies {import("../../types/index.js").ESLintFlatConfig["rules"]}
+ */
+const rules = {
+  // Enforce Rules of Hooks
+  // https://github.com/facebook/react/blob/c11015ff4f610ac2924d1fc6d569a17657a404fd/packages/eslint-plugin-react-hooks/src/RulesOfHooks.js
+  "react-hooks/rules-of-hooks": "error",
+
+  // Verify the list of the dependencies for Hooks like useEffect and similar
+  // https://github.com/facebook/react/blob/1204c789776cb01fbaf3e9f032e7e2ba85a44137/packages/eslint-plugin-react-hooks/src/ExhaustiveDeps.js
+  "react-hooks/exhaustive-deps": "error",
+};
+
+export default rules;