@adbayb/stack 0.0.0-next-1ee86fc → 0.0.0-next-730a06d

package/config/eslint/constants.js

@@ -0,0 +1,5 @@
+import { cwd } from "node:process";
+
+export const CWD = cwd();
+
+export const JAVASCRIPT_LIKE_FILES = ["**/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts}"];

package/config/eslint/helpers.js

@@ -0,0 +1,6 @@
+import { createRequire } from "node:module";
+
+import tseslint from "typescript-eslint";
+
+export const require = createRequire(import.meta.url);
+export const createConfig = tseslint.config;

package/config/eslint/index.js

@@ -0,0 +1,33 @@
+import { config as uncategorizedConfig } from "./presets/uncategorized.js";
+import { config as typescriptConfig } from "./presets/typescript.js";
+import { config as testConfig } from "./presets/test.js";
+import { config as sonarConfig } from "./presets/sonar.js";
+import { config as reactConfig } from "./presets/react.js";
+import { config as overridableConfig } from "./presets/overridable.js";
+import { config as nodeConfig } from "./presets/node.js";
+import { config as jsdocConfig } from "./presets/jsdoc.js";
+import { config as importConfig } from "./presets/import.js";
+import { config as eslintConfig } from "./presets/eslint.js";
+import { config as baseConfig } from "./presets/base.js";
+import { createConfig } from "./helpers.js";
+
+/**
+ * TODO:
+ * - Review TS rules: attempt to include all rules from https://typescript-eslint.io/users/configs/#strict-type-checked and https://typescript-eslint.io/users/configs/#stylistic-type-checked ?
+ * - Review JSDoc rules.
+ */
+
+export default createConfig(
+	// The insertion order is important (last same config items overrides previous ones):
+	...baseConfig,
+	...eslintConfig,
+	...typescriptConfig,
+	...importConfig,
+	...nodeConfig,
+	...sonarConfig,
+	...jsdocConfig,
+	...reactConfig,
+	...testConfig,
+	...uncategorizedConfig,
+	...overridableConfig,
+);

package/config/eslint/presets/base.js

@@ -0,0 +1,26 @@
+import { resolve } from "node:path";
+
+import globals from "globals";
+import { includeIgnoreFile } from "@eslint/compat";
+
+import { CWD } from "../constants.js";
+
+export const config = [
+	{
+		languageOptions: {
+			ecmaVersion: "latest",
+			globals: {
+				...globals.browser,
+				...globals.node,
+				...globals.worker,
+			},
+			parserOptions: {
+				ecmaFeatures: {
+					jsx: true,
+				},
+			},
+			sourceType: "module",
+		},
+	},
+	includeIgnoreFile(resolve(CWD, ".gitignore")),
+];

package/config/eslint/presets/eslint.js

@@ -0,0 +1,135 @@
+import { JAVASCRIPT_LIKE_FILES } from "../constants.js";
+
+export const config = [
+	{
+		files: JAVASCRIPT_LIKE_FILES,
+		rules: {
+			"constructor-super": "error",
+			"eqeqeq": "error",
+			"for-direction": "error",
+			"getter-return": "error",
+			"no-alert": "error",
+			"no-async-promise-executor": "error",
+			"no-case-declarations": "error",
+			"no-class-assign": "error",
+			"no-compare-neg-zero": "error",
+			"no-cond-assign": "error",
+			"no-const-assign": "error",
+			"no-constant-binary-expression": "error",
+			"no-constant-condition": "error",
+			"no-control-regex": "error",
+			"no-debugger": "error",
+			"no-delete-var": "error",
+			"no-dupe-args": "error",
+			"no-dupe-else-if": "error",
+			"no-dupe-keys": "error",
+			"no-duplicate-case": "error",
+			"no-empty": "error",
+			"no-empty-character-class": "error",
+			"no-empty-pattern": "error",
+			"no-empty-static-block": "error",
+			"no-ex-assign": "error",
+			"no-extra-boolean-cast": "error",
+			"no-fallthrough": "error",
+			"no-func-assign": "error",
+			"no-global-assign": "error",
+			"no-import-assign": "error",
+			"no-invalid-regexp": "error",
+			"no-irregular-whitespace": "error",
+			"no-loss-of-precision": "error",
+			"no-misleading-character-class": "error",
+			"no-new-native-nonconstructor": "error",
+			"no-nonoctal-decimal-escape": "error",
+			"no-obj-calls": "error",
+			"no-octal": "error",
+			"no-prototype-builtins": "error",
+			"no-redeclare": "error",
+			"no-regex-spaces": "error",
+			"no-restricted-syntax": [
+				"error",
+				{
+					message: "Use undefined instead of null",
+					// https://medium.com/@hbarcelos/why-i-banned-null-from-my-js-code-and-why-you-should-too-13df90323cfa
+					selector: "Literal[raw='null']",
+				},
+			],
+			"no-self-assign": "error",
+			"no-setter-return": "error",
+			"no-shadow-restricted-names": "error",
+			"no-sparse-arrays": "error",
+			"no-this-before-super": "error",
+			"no-undef": "error",
+			"no-unexpected-multiline": "error",
+			"no-unreachable": "error",
+			"no-unsafe-finally": "error",
+			"no-unsafe-negation": "error",
+			"no-unsafe-optional-chaining": "error",
+			"no-unused-labels": "error",
+			"no-unused-private-class-members": "error",
+			"no-useless-backreference": "error",
+			"no-useless-catch": "error",
+			"no-useless-escape": "error",
+			"no-var": "error",
+			"no-with": "error",
+			"object-shorthand": ["error", "always"],
+			"padding-line-between-statements": [
+				"error",
+				{
+					blankLine: "always",
+					next: "*",
+					prev: "*",
+				},
+				{
+					blankLine: "never",
+					next: ["const", "let", "var"],
+					prev: ["const", "let", "var"],
+				},
+				{
+					blankLine: "never",
+					next: ["case", "default"],
+					prev: ["case", "default"],
+				},
+				{
+					blankLine: "always",
+					next: ["const", "let", "var"],
+					prev: ["multiline-const", "multiline-let", "multiline-var"],
+				},
+				{
+					blankLine: "always",
+					next: ["multiline-const", "multiline-let", "multiline-var"],
+					prev: ["const", "let", "var"],
+				},
+				{
+					blankLine: "any",
+					next: ["expression"],
+					prev: ["expression"],
+				},
+				{
+					blankLine: "any",
+					next: ["const", "let", "var"],
+					prev: ["cjs-import"],
+				},
+				{
+					blankLine: "any",
+					next: ["cjs-import", "import"],
+					prev: ["cjs-import", "import"],
+				},
+				{
+					blankLine: "any",
+					next: ["cjs-export", "export"],
+					prev: ["cjs-export", "export"],
+				},
+			],
+			"prefer-arrow-callback": ["error", { allowNamedFunctions: true }],
+			"prefer-const": "error",
+			"prefer-rest-params": "error",
+			"prefer-spread": "error",
+			"prefer-template": "error",
+			"require-yield": "error",
+			"sort-imports": ["error", { ignoreDeclarationSort: true }],
+			"sort-vars": "error",
+			"use-isnan": "error",
+			"valid-typeof": "error",
+		},
+	},
+];

package/config/eslint/presets/import.js

@@ -0,0 +1,71 @@
+import importPlugin from "eslint-plugin-import-x";
+
+import { JAVASCRIPT_LIKE_FILES } from "../constants.js";
+
+export const config = [
+	importPlugin.flatConfigs.typescript,
+	{
+		files: JAVASCRIPT_LIKE_FILES,
+		plugins: {
+			"import-x": importPlugin,
+		},
+		rules: {
+			"import-x/consistent-type-specifier-style": ["error", "prefer-top-level"],
+			"import-x/export": "error",
+			"import-x/first": "error",
+			"import-x/newline-after-import": "error",
+			"import-x/no-absolute-path": "error",
+			"import-x/no-amd": "error",
+			"import-x/no-anonymous-default-export": "error",
+			"import-x/no-commonjs": "error",
+			"import-x/no-cycle": "error",
+			"import-x/no-default-export": "error",
+			"import-x/no-deprecated": "error",
+			"import-x/no-duplicates": "error",
+			"import-x/no-empty-named-blocks": "error",
+			"import-x/no-extraneous-dependencies": "error",
+			"import-x/no-import-module-exports": "error",
+			"import-x/no-mutable-exports": "error",
+			"import-x/no-named-default": "error",
+			"import-x/no-namespace": "error",
+			"import-x/no-relative-packages": "error",
+			"import-x/no-self-import": "error",
+			"import-x/no-unassigned-import": "error",
+			"import-x/no-unused-modules": "error",
+			"import-x/no-useless-path-segments": [
+				"error",
+				{
+					commonjs: true,
+					noUselessIndex: true,
+				},
+			],
+			"import-x/no-webpack-loader-syntax": "error",
+			"import-x/order": [
+				"error",
+				{
+					"alphabetize": {
+						caseInsensitive: false,
+						order: "desc",
+						orderImportKind: "desc",
+					},
+					"groups": [
+						"builtin",
+						"external",
+						"internal",
+						["parent", "sibling", "index"],
+						"object",
+						"unknown",
+					],
+					"newlines-between": "always",
+				},
+			],
+			"import-x/unambiguous": "error",
+		},
+		settings: {
+			"import-x/resolver": {
+				node: true,
+				typescript: true,
+			},
+		},
+	},
+];

package/config/eslint/presets/jsdoc.js

@@ -0,0 +1,78 @@
+import jsdocPlugin from "eslint-plugin-jsdoc";
+
+import { JAVASCRIPT_LIKE_FILES } from "../constants.js";
+
+export const config = [
+	{
+		files: JAVASCRIPT_LIKE_FILES,
+		plugins: {
+			jsdoc: jsdocPlugin,
+		},
+		rules: {
+			"jsdoc/check-access": "error",
+			"jsdoc/check-alignment": "error",
+			"jsdoc/check-examples": "off", // To enable once ESLint >= 8.x is supported
+			"jsdoc/check-indentation": "error",
+			"jsdoc/check-line-alignment": "error",
+			"jsdoc/check-param-names": "error",
+			"jsdoc/check-property-names": "error",
+			"jsdoc/check-syntax": "error",
+			"jsdoc/check-tag-names": "error",
+			"jsdoc/check-types": "error",
+			"jsdoc/check-values": "error",
+			"jsdoc/empty-tags": "error",
+			"jsdoc/implements-on-classes": "error",
+			"jsdoc/multiline-blocks": "error",
+			"jsdoc/no-bad-blocks": "error",
+			"jsdoc/no-blank-block-descriptions": "error",
+			"jsdoc/no-defaults": "error",
+			"jsdoc/no-multi-asterisks": "error",
+			"jsdoc/no-types": "error",
+			"jsdoc/require-asterisk-prefix": "error",
+			"jsdoc/require-description": "error",
+			"jsdoc/require-description-complete-sentence": "error",
+			"jsdoc/require-example": "error",
+			"jsdoc/require-hyphen-before-param-description": "error",
+			"jsdoc/require-jsdoc": [
+				// To enable once the rule can be configured to require JSDoc for exported functions at package level (only at module level right now)
+				"off",
+				{
+					contexts: [
+						"TSTypeAliasDeclaration",
+						"TSInterfaceDeclaration",
+						"TSMethodSignature",
+						"TSPropertySignature",
+					],
+					publicOnly: {
+						ancestorsOnly: true,
+						cjs: true,
+						esm: true,
+					},
+					require: {
+						ArrowFunctionExpression: true,
+						ClassDeclaration: true,
+						ClassExpression: true,
+						FunctionDeclaration: true,
+						FunctionExpression: true,
+						MethodDefinition: true,
+					},
+				},
+			],
+			"jsdoc/require-param": "error",
+			"jsdoc/require-param-description": "error",
+			"jsdoc/require-param-name": "error",
+			"jsdoc/require-property": "error",
+			"jsdoc/require-property-description": "error",
+			"jsdoc/require-property-name": "error",
+			"jsdoc/require-returns": "error",
+			"jsdoc/require-returns-check": "error",
+			"jsdoc/require-returns-description": "error",
+			"jsdoc/require-throws": "error",
+			"jsdoc/require-yields": "error",
+			"jsdoc/require-yields-check": "error",
+			"jsdoc/sort-tags": "error",
+			"jsdoc/tag-lines": "error",
+			"jsdoc/valid-types": "error",
+		},
+	},
+];

package/config/eslint/presets/node.js

@@ -0,0 +1,51 @@
+import { join } from "node:path";
+
+import nodePlugin from "eslint-plugin-n";
+
+import { require } from "../helpers.js";
+import { CWD, JAVASCRIPT_LIKE_FILES } from "../constants.js";
+
+export const config = [
+	{
+		files: JAVASCRIPT_LIKE_FILES,
+		plugins: {
+			n: nodePlugin,
+		},
+		rules: {
+			"n/callback-return": "error",
+			"n/exports-style": ["error", "module.exports"],
+			"n/hashbang": "error",
+			"n/no-exports-assign": "error",
+			"n/no-path-concat": "error",
+			"n/no-process-env": [
+				"error",
+				{
+					allowedVariables: ["NODE_ENV"],
+				},
+			],
+			"n/no-unpublished-bin": "error",
+			"n/no-unsupported-features/es-builtins": "error",
+			"n/no-unsupported-features/es-syntax": "error",
+			"n/no-unsupported-features/node-builtins": [
+				"error",
+				{ allowExperimental: true },
+			],
+			"n/prefer-global/buffer": ["error", "never"],
+			"n/prefer-global/console": ["error", "always"],
+			"n/prefer-global/process": ["error", "never"],
+			"n/prefer-global/text-decoder": ["error", "always"],
+			"n/prefer-global/text-encoder": ["error", "always"],
+			"n/prefer-global/url": ["error", "always"],
+			"n/prefer-global/url-search-params": ["error", "always"],
+			"n/prefer-node-protocol": "error",
+			"n/prefer-promises/dns": "error",
+			"n/prefer-promises/fs": "error",
+			"n/process-exit-as-throw": "error",
+		},
+		settings: {
+			node: {
+				version: require(join(CWD, "package.json")).engines.node,
+			},
+		},
+	},
+];

package/config/eslint/presets/overridable.js

@@ -0,0 +1,31 @@
+import tseslint from "typescript-eslint";
+import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
+
+export const config = [
+	{
+		files: ["**/*.{js,jsx,cjs,mjs}"],
+		...tseslint.configs.disableTypeChecked,
+	},
+	{
+		// Relaxed rules for example-like folder, and [config-, story-, and test]-like files
+		files: [
+			"**/.config/**",
+			"**/config/**",
+			"**/examples/**",
+			"**/scripts/**",
+			"**/website/**",
+			"**/config.{js,ts,cjs,cts,mjs,mts}",
+			"**/*.config.{js,ts,cjs,cts,mjs,mts}",
+			"**/stories.{js,ts,jsx,tsx,cjs,cts,mjs,mts}",
+			"**/*.stories.{js,ts,jsx,tsx,cjs,cts,mjs,mts}",
+			"**/test.{js,ts,jsx,tsx,cjs,cts,mjs,mts}",
+			"**/*.test.{js,ts,jsx,tsx,cjs,cts,mjs,mts}",
+		],
+		rules: {
+			"import-x/no-anonymous-default-export": "off",
+			"import-x/no-default-export": "off",
+			"sonarjs/sonar-no-magic-numbers": "off",
+		},
+	},
+	eslintPluginPrettierRecommended,
+];

package/config/eslint/presets/react.js

@@ -0,0 +1,75 @@
+import reactHooksPlugin from "eslint-plugin-react-hooks";
+import reactPlugin from "eslint-plugin-react";
+
+export const config = [
+	{
+		files: ["**/*.{jsx,tsx}"],
+		plugins: {
+			"react": reactPlugin,
+			"react-hooks": reactHooksPlugin,
+		},
+		rules: {
+			"react-hooks/exhaustive-deps": "warn",
+			"react-hooks/rules-of-hooks": "error",
+			"react/boolean-prop-naming": [
+				"error",
+				{ rule: "^(is|has)[A-Z]([A-Za-z0-9]?)+" },
+			],
+			"react/button-has-type": "error",
+			"react/checked-requires-onchange-or-readonly": "error",
+			"react/display-name": "error",
+			"react/forbid-component-props": "error",
+			"react/forward-ref-uses-ref": "error",
+			"react/hook-use-state": "error",
+			"react/iframe-missing-sandbox": "error",
+			"react/jsx-boolean-value": "error",
+			"react/jsx-fragments": "error",
+			"react/jsx-handler-names": "error",
+			"react/jsx-key": "error",
+			"react/jsx-no-bind": "error",
+			"react/jsx-no-constructed-context-values": "error",
+			"react/jsx-no-leaked-render": "error",
+			"react/jsx-no-script-url": "error",
+			"react/jsx-no-target-blank": "error",
+			"react/jsx-no-useless-fragment": "error",
+			"react/jsx-pascal-case": "error",
+			"react/jsx-props-no-spread-multi": "error",
+			"react/jsx-sort-props": "error",
+			"react/jsx-uses-react": "error",
+			"react/jsx-uses-vars": "error",
+			"react/no-access-state-in-setstate": "error",
+			"react/no-array-index-key": "error",
+			"react/no-arrow-function-lifecycle": "error",
+			"react/no-children-prop": "error",
+			"react/no-danger-with-children": "error",
+			"react/no-did-mount-set-state": "error",
+			"react/no-did-update-set-state": "error",
+			"react/no-direct-mutation-state": "error",
+			"react/no-find-dom-node": "error",
+			"react/no-is-mounted": "error",
+			"react/no-namespace": "error",
+			"react/no-object-type-as-default-prop": "error",
+			"react/no-redundant-should-component-update": "error",
+			"react/no-render-return-value": "error",
+			"react/no-string-refs": "error",
+			"react/no-this-in-sfc": "error",
+			"react/no-typos": "error",
+			"react/no-unescaped-entities": "error",
+			"react/no-unsafe": "error",
+			"react/no-unstable-nested-components": "error",
+			"react/no-unused-class-component-methods": "error",
+			"react/no-unused-state": "error",
+			"react/no-will-update-set-state": "error",
+			"react/prefer-read-only-props": "error",
+			"react/prefer-stateless-function": "error",
+			"react/self-closing-comp": "error",
+			"react/style-prop-object": "error",
+			"react/void-dom-elements-no-children": "error",
+		},
+		settings: {
+			react: {
+				version: "detect",
+			},
+		},
+	},
+];