@10stars/config 9.1.0 → 9.1.2

package/.eslintrc.js

@@ -0,0 +1,253 @@
+const builtinModules = require("builtin-modules")
+/**
+ * @todo
+ *   - prohibit "whiteSpace" style rule
+ */
+/**
+ * @return [0, 0.25, -0.25, 0.5, -0.5, 0.75, -0.75, 1, -1, ..., 10, -10]
+ */
+const allowedMagicNumbers = (() => {
+  const magicNumbers = []
+  const max = 10
+
+  for (let i = 0; i < max + 1; i++) {
+    if (i === max) {
+      magicNumbers.push(i, -i)
+      continue
+    }
+
+    if (i === -i) magicNumbers.push(i)
+    else magicNumbers.push(i, -i)
+
+    const numOfDecimals = 4
+    const decimalPoint = 1 / numOfDecimals
+    for (let b = 1; b < numOfDecimals; b++) {
+      const decimal = i + b * decimalPoint
+      magicNumbers.push(decimal, -decimal)
+    }
+  }
+
+  return magicNumbers
+})()
+
+const reactUseHooks = [
+  `useUpdateEffect`,
+  `useIsomorphicLayoutEffect`,
+  `useDeepCompareEffect`,
+  `useShallowCompareEffect`,
+  `useCustomCompareEffect`,
+]
+
+const type = {
+  ignore: 0,
+  warning: 1,
+  error: 2,
+}
+
+module.exports = {
+  root: true, // https://eslint.org/docs/latest/use/configure/configuration-files#using-configuration-files
+  parser: `@typescript-eslint/parser`, // Specifies the ESLint parser
+  parserOptions: {
+    ecmaVersion: `latest`, // Allows for the parsing of modern ECMAScript features
+    sourceType: `module`, // Allows for the use of imports
+    ecmaFeatures: {
+      jsx: true, // Allows for the parsing of JSX
+    },
+  },
+  ignorePatterns: [`**/node_modules`, `**/.git`, `**/dist`, `**/tmp`],
+  plugins: [
+    `@typescript-eslint`,
+    `import`,
+    `react`,
+    `@10stars/react-hooks`, // https://reactjs.org/docs/hooks-rules.html#eslint-plugin
+    `regexp`,
+    `simple-import-sort`,
+    `sort-keys-fix`,
+    // 'prettier' commented as we don't want to run prettier through eslint because of performance
+  ],
+  env: {
+    browser: true,
+    jest: true,
+  },
+  extends: [
+    `eslint:recommended`,
+    `plugin:@typescript-eslint/strict-type-checked`,
+    `plugin:@typescript-eslint/stylistic-type-checked`,
+    `plugin:react/recommended`,
+    `plugin:@10stars/react-hooks/recommended`,
+    `plugin:regexp/recommended`,
+
+    // We use only few custom rules from the import plugin and we override some aspects with simple-import-sort
+    // "plugin:import/typescript",
+    // "plugin:import/warnings",
+    // "plugin:import/errors",
+    `prettier`, // see: https://github.com/prettier/eslint-config-prettier
+  ],
+  settings: {
+    "import/parsers": { "@typescript-eslint/parser": [`.ts`, `.tsx`] },
+    "import/extensions": [`.ts`, `.tsx`, `.js`, `.jsx`],
+    react: {
+      version: `18.0.0`,
+    },
+  },
+  rules: {
+    /**
+     * ESLint core rules
+     */
+    "no-case-declarations": type.ignore, // TypeScript shows us error, if the variable is reused in the same scope, so this rule is not applicable
+    /**
+     * eslint-plugin-import @see https://github.com/benmosher/eslint-plugin-import
+     */
+    "import/order": type.ignore, // turn off in favor of eslint-plugin-simple-import-sort
+    "import/no-unresolved": type.ignore,
+    "import/no-duplicates": type.warning,
+    "import/no-nodejs-modules": [
+      type.error,
+      {
+        allow: builtinModules.flatMap((v) => [
+          `node:${v}`,
+          `node:${v}/promises`,
+        ]),
+      },
+    ],
+    /**
+     * eslint-plugin-simple-import-sort
+     */
+    "sort-imports": type.ignore, // we use eslint-plugin-import instead
+    "simple-import-sort/imports": type.warning,
+    "simple-import-sort/exports": type.warning,
+    /**
+     * React
+     */
+    "react/display-name": type.ignore,
+    "react/no-children-prop": type.ignore,
+    /** we ignore CSS, because we use Emotion @see https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-unknown-property.md#rule-options */
+    "react/no-unknown-property": [type.error, { ignore: [`css`] }],
+    "react/prop-types": type.ignore,
+    "react/react-in-jsx-scope": type.ignore,
+    "react/jsx-filename-extension": [
+      type.warning,
+      { extensions: [`.jsx`, `.tsx`] },
+    ], // also want to use with ".tsx"
+    "react/no-invalid-html-attribute": type.error,
+    "react/prefer-stateless-function": type.error,
+    "react/jsx-boolean-value": [type.warning, "never"],
+    "react/jsx-curly-brace-presence": [type.warning, "always"],
+    "react/jsx-fragments": type.warning,
+    "react/jsx-no-bind": type.warning,
+    "react/jsx-no-constructed-context-values": type.warning,
+    "react/jsx-no-script-url": [
+      type.error,
+      [
+        { name: "Link", props: ["to"] },
+        { name: "NavLink", props: ["to"] },
+        { name: "a", props: ["href", "to"] },
+      ],
+    ],
+    "react/jsx-no-useless-fragment": type.warning,
+    "react/jsx-no-target-blank": type.error,
+    "react/jsx-sort-props": type.warning,
+    /**
+     * Hooks
+     */
+    "@10stars/react-hooks/exhaustive-deps": [
+      type.warning,
+      {
+        additionalHooks: `(${reactUseHooks.join(`|`)})`,
+        ignoreThisDependency: `always`,
+      },
+    ],
+    /**
+     * TypeScript
+     * List of ignored (not recommended) rules we also explored:
+     *   - @typescript-eslint/consistent-type-assertions
+     *   - @typescript-eslint/explicit-module-boundary-types
+     *   - @typescript-eslint/no-require-imports
+     *   - @typescript-eslint/no-type-alias
+     *   - @typescript-eslint/strict-boolean-expressions // doesn't work well
+     */
+    // disabled recommended rules
+    "@typescript-eslint/prefer-nullish-coalescing": 0, // doesn't make sense sometimes and actually could introduce a bug
+    "@typescript-eslint/consistent-indexed-object-style": 0,
+    "@typescript-eslint/no-throw-literal": 0,
+    "@typescript-eslint/no-unnecessary-condition": 0,
+    "@typescript-eslint/no-confusing-void-expression": 0,
+    "@typescript-eslint/no-invalid-void-type": 0,
+    "@typescript-eslint/no-unused-vars": type.ignore, // removed by bundler, so it shouldn't be a rule
+    "@typescript-eslint/no-empty-function": type.ignore, // used for prototyping
+    "@typescript-eslint/no-explicit-any": type.ignore,
+    "@typescript-eslint/ban-types": type.ignore,
+    // ---- we ignore these "no-unsafe-*" as it noticeably slows down the code writing
+    "@typescript-eslint/no-unsafe-assignment": type.ignore,
+    "@typescript-eslint/no-unsafe-member-access": type.ignore,
+    "@typescript-eslint/no-unsafe-return": type.ignore,
+    "@typescript-eslint/no-non-null-assertion": type.ignore, // sometimes TS incorrectly asserts, so there's a need to override
+    "@typescript-eslint/unbound-method": type.ignore,
+    // other
+    quotes: type.ignore,
+    "@typescript-eslint/array-type": [type.warning, { default: `array` }],
+    "@typescript-eslint/quotes": [type.warning, `backtick`],
+    "@typescript-eslint/consistent-type-definitions": [
+      type.warning, // @see https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#differences-between-type-aliases-and-interfaces
+      `interface`, // VSCode's Code lens can only highlight use of properties in "interface" definitions
+    ],
+    "no-magic-numbers": type.ignore,
+    "@typescript-eslint/no-magic-numbers": [
+      type.warning,
+      {
+        ignore: allowedMagicNumbers,
+        ignoreTypeIndexes: true,
+        ignoreReadonlyClassProperties: true,
+        ignoreNumericLiteralTypes: true,
+        ignoreEnums: true,
+      },
+    ],
+    "@typescript-eslint/no-unnecessary-type-arguments": type.warning,
+    "@typescript-eslint/unified-signatures": type.warning,
+    // string
+    "@typescript-eslint/prefer-string-starts-ends-with": type.warning,
+    // RegExp
+    "@typescript-eslint/prefer-regexp-exec": type.warning,
+    // array
+    "@typescript-eslint/prefer-includes": type.warning,
+    "@typescript-eslint/require-array-sort-compare": type.warning,
+    // loops
+    "@typescript-eslint/prefer-for-of": type.warning,
+    // promises
+    "@typescript-eslint/no-misused-promises": [
+      type.warning,
+      { checksVoidReturn: false },
+    ],
+    "@typescript-eslint/no-floating-promises": [
+      type.warning,
+      { ignoreVoid: true },
+    ],
+    // namespace
+    "@typescript-eslint/no-unnecessary-qualifier": type.warning,
+    // for classes
+    "@typescript-eslint/no-extraneous-class": type.warning,
+    "@typescript-eslint/explicit-member-accessibility": type.warning,
+    "@typescript-eslint/member-ordering": [
+      type.warning,
+      {
+        default: [
+          `public-static-field`,
+          `public-instance-field`,
+          `public-constructor`,
+          `private-static-field`,
+          `private-instance-field`,
+          `private-constructor`,
+          `public-instance-method`,
+          `protected-instance-method`,
+          `private-instance-method`,
+        ],
+      },
+    ],
+    "no-useless-constructor": type.ignore,
+    "@typescript-eslint/no-useless-constructor": type.warning,
+    /**
+     * Regex
+     */
+    "regexp/no-useless-escape": type.warning,
+  },
+}

package/.prettierrc.js

@@ -0,0 +1,38 @@
+module.exports = {
+  parser: "typescript",
+  arrowParens: "always",
+  trailingComma: "all",
+  tabWidth: 2,
+  semi: false,
+  singleQuote: false,
+  overrides: [
+    {
+      files: "*.yml",
+      options: { parser: "yaml" },
+    },
+    {
+      files: "*.yaml",
+      options: { parser: "yaml" },
+    },
+    {
+      files: "*.md",
+      options: { parser: "markdown" },
+    },
+    {
+      files: "*.mdx",
+      options: { parser: "mdx" },
+    },
+    {
+      files: "*.json",
+      options: { parser: "json" },
+    },
+    {
+      files: "*.html",
+      options: { parser: "html" },
+    },
+    {
+      files: "*.css",
+      options: { parser: "css" },
+    },
+  ],
+}

package/commitlint.config.js

@@ -0,0 +1,29 @@
+module.exports = {
+  extends: [`@commitlint/config-conventional`],
+  /**
+   * For explanation on how to write rules @see https://commitlint.js.org/#/reference-rules
+   */
+  rules: {
+    "body-leading-blank": [1, `always`],
+    "footer-leading-blank": [1, `always`],
+    "header-max-length": [2, `always`, 72],
+    "scope-case": [2, `always`, `lower-case`],
+    "subject-case": [2, `never`, [`start-case`, `pascal-case`, `upper-case`]],
+    "subject-empty": [2, `never`],
+    "subject-full-stop": [2, `never`, `.`],
+    "type-case": [2, `always`, `upper-case`],
+    "type-empty": [2, `never`],
+    "type-enum": [
+      2,
+      `always`,
+      [
+        `ADDED`, // new features
+        `CHANGED`, // changes in existing functionality
+        `DEPRECATED`, // soon-to-be removed features
+        `FIXED`, // any bug fixes
+        `REMOVED`, // removed features
+        `SECURITY`, // in case of vulnerabilities
+      ],
+    ],
+  },
+}

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "name": "@10stars/config",
-  "version": "9.1.0",
+  "version": "9.1.2",
   "author": "10stars.dev <web@alexandrov.co> (https://alexandrov.co)",
   "license": "MIT",
   "module": "./src/index.ts",