@kurateh/eslint-plugin 0.1.0

package/dist/index.js

@@ -0,0 +1,411 @@
+'use strict';
+
+var react = require('eslint-plugin-react');
+var reactHook = require('eslint-plugin-react-hooks');
+var globals = require('globals');
+var importPlugin = require('eslint-plugin-import');
+var tseslint = require('typescript-eslint');
+var fs = require('fs');
+var path = require('path');
+var utils = require('@typescript-eslint/utils');
+var js = require('@eslint/js');
+var eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
+var unusedImportsPlugin = require('eslint-plugin-unused-imports');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var react__default = /*#__PURE__*/_interopDefault(react);
+var reactHook__default = /*#__PURE__*/_interopDefault(reactHook);
+var globals__default = /*#__PURE__*/_interopDefault(globals);
+var importPlugin__default = /*#__PURE__*/_interopDefault(importPlugin);
+var tseslint__default = /*#__PURE__*/_interopDefault(tseslint);
+var js__default = /*#__PURE__*/_interopDefault(js);
+var eslintPluginPrettierRecommended__default = /*#__PURE__*/_interopDefault(eslintPluginPrettierRecommended);
+var unusedImportsPlugin__default = /*#__PURE__*/_interopDefault(unusedImportsPlugin);
+
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var createRule = utils.ESLintUtils.RuleCreator.withoutDocs;
+
+// src/rules/import-path.ts
+var TS_CONFIG_FILE_NAMES = ["tsconfig.path.json", "tsconfig.json"];
+var has = (map, path) => {
+  let inner = map;
+  for (const step of path.split(".")) {
+    inner = inner[step];
+    if (inner === void 0) {
+      return false;
+    }
+  }
+  return true;
+};
+var findFilePath = (filename, initialPath) => {
+  let dir = initialPath;
+  do {
+    dir = path.dirname(dir);
+  } while (!fs.existsSync(path.join(dir, filename)) && dir !== "/");
+  const filePath = path.join(dir, filename);
+  if (!fs.existsSync(filePath)) {
+    return;
+  }
+  return filePath;
+};
+var getAbsolutePathInfo = (fileName) => {
+  for (const configPath of TS_CONFIG_FILE_NAMES) {
+    const filePath = findFilePath(configPath, fileName);
+    if (filePath === void 0) {
+      continue;
+    }
+    const baseDir = path.dirname(filePath);
+    const tsPathConfig = JSON.parse(
+      fs.readFileSync(filePath, {
+        encoding: "utf-8"
+      })
+    );
+    const result = {
+      baseUrl: "",
+      paths: {}
+    };
+    if (has(tsPathConfig, "compilerOptions.baseUrl")) {
+      result.baseUrl = path.join(baseDir, tsPathConfig.compilerOptions.baseUrl);
+    }
+    if (has(tsPathConfig, "compilerOptions.paths")) {
+      result.paths = Object.fromEntries(
+        Object.entries(tsPathConfig.compilerOptions.paths).map(
+          ([key, value]) => [
+            key.replace(/\/\*$/, "/"),
+            value.map((path$1) => path.join(baseDir, path$1).replace(/\/\*$/, "/"))
+          ]
+        )
+      );
+    }
+    return result;
+  }
+  return;
+};
+var import_path_default = createRule({
+  meta: {
+    type: "suggestion",
+    fixable: "code",
+    messages: {
+      shouldBeRelativePath: 'When importing a child module, you must use the relative path. Use "{{expectedPath}}" instead of "{{source}}".',
+      shouldBeAbsolutePath: 'When importing a parent module, you must use the absolute path. Use "{{expectedPath}}" instead of "{{source}}".'
+    },
+    schema: [],
+    docs: {
+      description: "Enforce import path according to the location of the imported file."
+    }
+  },
+  defaultOptions: [],
+  create: (context) => {
+    return {
+      ImportDeclaration: (node) => {
+        const fileName = context.getFilename();
+        const absolutePathInfo = getAbsolutePathInfo(fileName);
+        if (absolutePathInfo === void 0) {
+          return;
+        }
+        const source = node.source.value;
+        if (source.startsWith("..")) {
+          const sourceAbsolutePath2 = path.join(path.dirname(fileName), source);
+          for (const [alias, paths] of Object.entries(absolutePathInfo.paths)) {
+            for (const path of paths) {
+              if (sourceAbsolutePath2.startsWith(path)) {
+                const expectedPath2 = sourceAbsolutePath2.replace(path, alias);
+                context.report({
+                  node,
+                  messageId: "shouldBeAbsolutePath",
+                  data: {
+                    expectedPath: expectedPath2,
+                    source
+                  },
+                  fix(fixer) {
+                    return fixer.replaceText(node.source, `"${expectedPath2}"`);
+                  }
+                });
+                return;
+              }
+            }
+          }
+          return;
+        }
+        let sourceAbsolutePath;
+        for (const [alias, paths] of Object.entries(absolutePathInfo.paths)) {
+          for (const path$1 of paths) {
+            if (source.startsWith(alias)) {
+              sourceAbsolutePath = path.join(path$1, source.replace(alias, ""));
+              break;
+            }
+          }
+          if (sourceAbsolutePath !== void 0) {
+            break;
+          }
+        }
+        if (sourceAbsolutePath === void 0) {
+          return;
+        }
+        const sourceRelativePath = path.relative(
+          path.dirname(fileName),
+          sourceAbsolutePath
+        );
+        if (sourceRelativePath.startsWith("..")) {
+          return;
+        }
+        const expectedPath = "./" + sourceRelativePath;
+        context.report({
+          node,
+          messageId: "shouldBeRelativePath",
+          data: {
+            expectedPath,
+            source
+          },
+          fix(fixer) {
+            return fixer.replaceText(node.source, `"${expectedPath}"`);
+          }
+        });
+        return;
+      }
+    };
+  }
+});
+
+// src/rules/index.ts
+var rules_default = {
+  "import-path": import_path_default
+};
+var recommended_default = [
+  js__default.default.configs.recommended,
+  importPlugin__default.default.flatConfigs.recommended,
+  eslintPluginPrettierRecommended__default.default,
+  {
+    languageOptions: {
+      ecmaVersion: 2020,
+      sourceType: "module",
+      globals: __spreadValues(__spreadValues(__spreadValues({}, globals__default.default.es2017), globals__default.default.browser), globals__default.default.node)
+    },
+    plugins: {
+      "unused-imports": unusedImportsPlugin__default.default
+    },
+    ignores: ["node_modules/", "dist/", "build/", "coverage/"],
+    rules: {
+      // eslint
+      "object-shorthand": 1,
+      "no-unused-vars": [
+        1,
+        {
+          ignoreRestSiblings: true,
+          vars: "all",
+          args: "after-used",
+          argsIgnorePattern: "^_",
+          varsIgnorePattern: "^_"
+        }
+      ],
+      "no-param-reassign": [
+        2,
+        {
+          props: true,
+          ignorePropertyModificationsForRegex: ["^draft$", "Draft$"]
+        }
+      ],
+      camelcase: [1, { allow: ["^\\w*_[A-Z]*$"] }],
+      "no-var": 2,
+      // prettier
+      "prettier/prettier": [
+        1,
+        {
+          trailingComma: "all",
+          tabWidth: 2,
+          semi: true,
+          singleQuote: false,
+          endOfLine: "auto"
+        },
+        {
+          usePrettierrc: false
+        }
+      ],
+      // import
+      "import/no-unresolved": 0,
+      "import/no-extraneous-dependencies": [
+        2,
+        {
+          devDependencies: [
+            "**/*.test.*",
+            "**/*.stories.*",
+            "**/*.config.*",
+            "**/*.spec.*"
+          ]
+        }
+      ],
+      "import/order": [
+        1,
+        {
+          alphabetize: {
+            order: "asc",
+            caseInsensitive: true
+          },
+          "newlines-between": "always",
+          groups: [
+            "builtin",
+            "external",
+            "internal",
+            ["parent", "sibling", "index"]
+          ],
+          pathGroups: [
+            {
+              pattern: "~*/**",
+              group: "internal"
+            },
+            {
+              pattern: "@*/**",
+              group: "internal"
+            }
+          ]
+        }
+      ],
+      // unused-imports
+      "unused-imports/no-unused-imports": 2
+    }
+  }
+];
+
+// src/configs/typescript.ts
+var typescript_default = [
+  ...recommended_default,
+  // eslint-disable-next-line import/no-named-as-default-member
+  ...tseslint__default.default.configs.recommended,
+  importPlugin__default.default.flatConfigs.typescript,
+  {
+    // ESLint config block에 file이 있으면 해당 파일을 검사할 차례가 와서야 plugin이 적용됨
+    // 따라서 이 Plugin을 끄려면 Config File에서 file: "~~"을 넣어야 됨
+    // 이 과정을 없애기 위해 plugin 적용을 앞서 진행
+    plugins: {
+      "@kurateh": { rules: rules_default, meta: { name: "@kurateh" } }
+    }
+  },
+  {
+    files: ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
+    settings: {
+      "import/resolver": {
+        typescript: {
+          alwaysTryTypes: true,
+          // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
+          // Choose from one of the "project" configs below or omit to use <root>/tsconfig.json by default
+          // use <root>/path/to/folder/tsconfig.json
+          project: "tsconfig.json"
+          // Multiple tsconfigs (Useful for monorepos)
+          // use a glob pattern
+          // project: "packages/*/tsconfig.json",
+          // use an array
+          // project: [
+          //   "packages/module-a/tsconfig.json",
+          //   "packages/module-b/tsconfig.json"
+          // ],
+          // use an array of glob patterns
+          // project: [
+          //   "packages/*/tsconfig.json",
+          //   "other-packages/*/
+        }
+      }
+    },
+    rules: {
+      // eslint
+      "@kurateh/import-path": 1,
+      "object-shorthand": 1,
+      "no-unused-vars": 0,
+      "@typescript-eslint/no-unused-vars": [
+        1,
+        {
+          ignoreRestSiblings: true,
+          vars: "all",
+          args: "after-used",
+          argsIgnorePattern: "^_",
+          varsIgnorePattern: "^_"
+        }
+      ],
+      "@typescript-eslint/consistent-type-imports": [
+        1,
+        {
+          fixStyle: "inline-type-imports"
+        }
+      ],
+      "no-param-reassign": [
+        2,
+        {
+          props: true,
+          ignorePropertyModificationsForRegex: ["^draft$", "Draft$"]
+        }
+      ],
+      camelcase: [1, { allow: ["^\\w*_[A-Z]*$"] }],
+      "no-var": 2,
+      "import-plugin/no-unresolved": 0
+    }
+  }
+];
+
+// src/configs/react.ts
+var _a, _b;
+var react_default = [
+  ...typescript_default,
+  (_b = (_a = react__default.default.configs.flat) == null ? void 0 : _a.recommended) != null ? _b : {},
+  {
+    plugins: { "react-hooks": reactHook__default.default },
+    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true
+        }
+      },
+      globals: __spreadValues({}, globals__default.default.browser)
+    },
+    rules: __spreadProps(__spreadValues({}, reactHook__default.default.configs.recommended.rules), {
+      "react/react-in-jsx-scope": 0,
+      "react/function-component-definition": [
+        2,
+        {
+          namedComponents: "arrow-function",
+          unnamedComponents: "arrow-function"
+        }
+      ],
+      "react/jsx-curly-brace-presence": [
+        1,
+        {
+          props: "never",
+          children: "never"
+        }
+      ],
+      "react/prop-types": 0,
+      "react/require-default-props": 0,
+      "react/display-name": 0
+    })
+  }
+];
+
+// src/index.ts
+var index_default = {
+  configs: {
+    recommended: recommended_default,
+    typescript: typescript_default,
+    react: react_default
+  },
+  rules: rules_default
+};
+
+module.exports = index_default;