@huangjunsen/encode-fe-lint 1.0.10 → 1.0.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 黄俊森
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/actions/init.js

@@ -60,6 +60,15 @@ const chooseEnablePrettier = async () => {
     });
     return enable;
 };
+const chooseEnableFlatConfig = async (defaultValue) => {
+    const { enable } = await inquirer_1.default.prompt({
+        type: 'confirm',
+        name: 'enable',
+        message: `Step ${++step}. 是否使用 ESLint Flat Config（eslint.config.mjs，推荐，ESLint 9+ 默认）：`,
+        default: defaultValue,
+    });
+    return enable;
+};
 exports.default = async (options) => {
     const cwd = options.cwd || process.cwd();
     const isTest = process.env.NODE_ENV === 'test';
@@ -101,6 +110,12 @@ exports.default = async (options) => {
     else {
         config.enablePrettier = await chooseEnablePrettier();
     }
+    if (typeof options.enableFlatConfig === 'boolean') {
+        config.enableFlatConfig = options.enableFlatConfig;
+    }
+    else {
+        config.enableFlatConfig = await chooseEnableFlatConfig(true);
+    }
     if (!isTest) {
         log_1.default.info(`Step ${++step}. 检查并处理项目中可能存在的依赖和配置冲突`);
         pkg = await (0, conflict_resolve_1.default)(cwd, options.rewriteConfig);

package/lib/actions/scan.js

@@ -21,7 +21,15 @@ exports.default = async (options) => {
     const runErrors = [];
     let results = [];
     if (fix && config.enablePrettier !== false) {
-        await (0, lints_1.doPrettier)(options);
+        try {
+            const prettierErrors = await (0, lints_1.doPrettier)(options);
+            if (prettierErrors.length > 0) {
+                runErrors.push(...prettierErrors);
+            }
+        }
+        catch (e) {
+            runErrors.push(e);
+        }
     }
     if (config.enableESLint !== false) {
         try {

package/lib/config/encode-fe-lint.config.js.ejs

@@ -3,4 +3,5 @@ module.exports = {
   enableStylelint: <%= enableStylelint %>,
   enableMarkdownlint: <%= enableMarkdownlint %>,
   enablePrettier: <%= enablePrettier %>,
+  enableFlatConfig: <%= enableFlatConfig %>,
 };

package/lib/config/eslint.config.mjs.ejs

@@ -1,5 +1,44 @@
-import feSpecConfig from '@huangjunsen/eslint-config/flat';
+<%_
+  const isCustom = eslintType && eslintType.startsWith('custom:');
+  const customPkg = isCustom ? eslintType.replace('custom:', '') : '';
+  const useTs = !isCustom && /typescript/.test(eslintType);
+
+  let mainEntry = '/flat';
+  let mainName = 'baseConfig';
+  if (!isCustom) {
+    if (/vue/.test(eslintType)) {
+      mainEntry = '/flat/vue';
+      mainName = 'vueConfig';
+    } else if (/react/.test(eslintType)) {
+      mainEntry = '/flat/react';
+      mainName = 'reactConfig';
+    } else if (/node/.test(eslintType)) {
+      mainEntry = '/flat/node';
+      mainName = 'nodeConfig';
+    }
+  }
+_%>
+<%_ if (isCustom) { _%>
+// eslint.config.mjs
+// 当前使用自定义/社区预设（<%= customPkg %>），请在此处自行组合 Flat Config：
+// import customConfig from '<%= customPkg %>';
+import baseConfig from '@huangjunsen/eslint-config/flat';
+
+export default [
+  ...baseConfig,
+];
+<%_ } else { _%>
+// eslint.config.mjs
+import <%= mainName %> from '@huangjunsen/eslint-config<%= mainEntry %>';
+<%_ if (useTs) { _%>
+import tsConfig from '@huangjunsen/eslint-config/flat/typescript';
+<%_ } _%>
 
 export default [
-  ...feSpecConfig,
+  ...<%= mainName %>,
+<%_ if (useTs) { _%>
+  // 放在最后，保证 TypeScript 的规则能覆盖前置预设
+  ...tsConfig,
+<%_ } _%>
 ];
+<%_ } _%>

package/lib/lints/eslint/doEslint.d.ts

@@ -1,6 +1,12 @@
+import { ESLint } from 'eslint';
 import { Config, PKG, ScanOptions } from '../../types';
 export interface DoESLintOptions extends ScanOptions {
     pkg: PKG;
     config?: Config;
 }
+type ESLintConstructor = (new (options?: any) => ESLint) & {
+    outputFixes: (results: ESLint.LintResult[]) => Promise<void>;
+};
+export declare function getESLintClass(useFlatConfig: boolean): ESLintConstructor;
 export declare function doESLint(options: DoESLintOptions): Promise<import("../../types").ScanResult[]>;
+export {};

package/lib/lints/eslint/doEslint.js

@@ -3,41 +3,54 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.doESLint = void 0;
+exports.doESLint = exports.getESLintClass = void 0;
 const eslint_1 = require("eslint");
-const fast_glob_1 = __importDefault(require("fast-glob"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = require("path");
 const constants_1 = require("../../utils/constants");
+const glob_1 = require("../../utils/glob");
 const formatESLintResults_1 = require("./formatESLintResults");
 const getESLintConfig_1 = require("./getESLintConfig");
+const FLAT_CONFIG_FILES = [
+    'eslint.config.js',
+    'eslint.config.mjs',
+    'eslint.config.cjs',
+    'eslint.config.ts',
+];
+function getESLintClass(useFlatConfig) {
+    if (useFlatConfig) {
+        try {
+            const risky = require('eslint/use-at-your-own-risk');
+            if (risky && typeof risky.FlatESLint === 'function') {
+                return risky.FlatESLint;
+            }
+        }
+        catch (e) {
+        }
+    }
+    return eslint_1.ESLint;
+}
+exports.getESLintClass = getESLintClass;
 async function doESLint(options) {
     let files;
     if (options.files) {
         files = options.files.filter((name) => constants_1.ESLINT_FILE_EXT.includes((0, path_1.extname)(name)));
     }
     else {
-        files = await (0, fast_glob_1.default)(`**/*.{${constants_1.ESLINT_FILE_EXT.map((t) => t.replace(/^\./, '')).join(',')}}`, {
-            cwd: options.cwd,
-            ignore: constants_1.ESLINT_IGNORE_PATTERN,
-        });
+        files = await (0, glob_1.globFiles)(options.cwd, options.include, constants_1.ESLINT_FILE_EXT, constants_1.ESLINT_IGNORE_PATTERN);
     }
-    const hasFlatConfig = [
-        'eslint.config.js',
-        'eslint.config.mjs',
-        'eslint.config.cjs',
-        'eslint.config.ts',
-    ].some((file) => fs_extra_1.default.existsSync((0, path_1.join)(options.cwd, file)));
+    const hasFlatConfig = FLAT_CONFIG_FILES.some((file) => fs_extra_1.default.existsSync((0, path_1.join)(options.cwd, file)));
+    const ESLintClass = getESLintClass(hasFlatConfig);
     const eslintConfig = hasFlatConfig
         ? {
             fix: options.fix,
             cwd: options.cwd,
         }
         : (0, getESLintConfig_1.getESLintConfig)(options, options.pkg, options.config);
-    const eslint = new eslint_1.ESLint(eslintConfig);
+    const eslint = new ESLintClass(eslintConfig);
     const reports = await eslint.lintFiles(files);
     if (options.fix) {
-        await eslint_1.ESLint.outputFixes(reports);
+        await ESLintClass.outputFixes(reports);
     }
     return (0, formatESLintResults_1.formatESLintResults)(reports, options.quiet, eslint);
 }

package/lib/lints/eslint/getESLintConfig.js

@@ -17,6 +17,7 @@ function getESLintConfig(opts, pkg, config) {
         ignore,
         extensions: constants_1.ESLINT_FILE_EXT,
         errorOnUnmatchedPattern: false,
+        resolvePluginsRelativeTo: cwd,
     };
     if (config.eslintOptions) {
         Object.assign(lintConfig, config.eslintOptions);

package/lib/lints/markdownlint/doMarkdownlint.js

@@ -4,12 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.doMarkdownlint = void 0;
-const fast_glob_1 = __importDefault(require("fast-glob"));
 const fs_extra_1 = require("fs-extra");
 const markdownlint_1 = __importDefault(require("markdownlint"));
 const markdownlint_rule_helpers_1 = __importDefault(require("markdownlint-rule-helpers"));
 const path_1 = require("path");
 const constants_1 = require("../../utils/constants");
+const glob_1 = require("../../utils/glob");
 const formatMarkdownlintResults_1 = require("./formatMarkdownlintResults");
 const getMarkdownlintConfig_1 = require("./getMarkdownlintConfig");
 async function doMarkdownlint(options) {
@@ -18,11 +18,7 @@ async function doMarkdownlint(options) {
         files = options.files.filter((name) => constants_1.MARKDOWN_LINT_FILE_EXT.includes((0, path_1.extname)(name)));
     }
     else {
-        const pattern = (0, path_1.join)(options.include, `**/*.{${constants_1.MARKDOWN_LINT_FILE_EXT.map((t) => t.replace(/^\./, '')).join(',')}}`);
-        files = await (0, fast_glob_1.default)(pattern, {
-            cwd: options.cwd,
-            ignore: constants_1.MARKDOWN_LINT_IGNORE_PATTERN,
-        });
+        files = await (0, glob_1.globFiles)(options.cwd, options.include, constants_1.MARKDOWN_LINT_FILE_EXT, constants_1.MARKDOWN_LINT_IGNORE_PATTERN);
     }
     const results = await markdownlint_1.default.promises.markdownlint({
         ...(0, getMarkdownlintConfig_1.getMarkdownlintConfig)(options, options.pkg, options.config),
@@ -30,10 +26,6 @@ async function doMarkdownlint(options) {
     });
     if (options.fix) {
         await Promise.all(Object.keys(results).map((filename) => formatMarkdownFile(filename, results[filename])));
-        for (const file in results) {
-            if (!Object.prototype.hasOwnProperty.call(results, file))
-                continue;
-        }
     }
     return (0, formatMarkdownlintResults_1.formatMarkdownlintResults)(results, options.quiet);
 }

package/lib/lints/prettier/doPrettier.d.ts

@@ -1,4 +1,4 @@
 import { ScanOptions } from '../../types';
 export interface DoPrettierOptions extends ScanOptions {
 }
-export declare function doPrettier(options: DoPrettierOptions): Promise<void>;
+export declare function doPrettier(options: DoPrettierOptions): Promise<Error[]>;

package/lib/lints/prettier/doPrettier.js

@@ -4,29 +4,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.doPrettier = void 0;
-const fast_glob_1 = __importDefault(require("fast-glob"));
 const fs_extra_1 = require("fs-extra");
 const path_1 = require("path");
 const prettier_1 = __importDefault(require("prettier"));
 const constants_1 = require("../../utils/constants");
+const glob_1 = require("../../utils/glob");
 async function doPrettier(options) {
     let files = [];
     if (options.files) {
         files = options.files.filter((name) => constants_1.PRETTIER_FILE_EXT.includes((0, path_1.extname)(name)));
     }
     else {
-        const pattern = (0, path_1.join)(options.include, `**/*.{${constants_1.PRETTIER_FILE_EXT.map((t) => t.replace(/^\./, '')).join(',')}}`);
-        files = await (0, fast_glob_1.default)(pattern, {
-            cwd: options.cwd,
-            ignore: constants_1.PRETTIER_IGNORE_PATTERN,
-        });
+        files = await (0, glob_1.globFiles)(options.cwd, options.include, constants_1.PRETTIER_FILE_EXT, constants_1.PRETTIER_IGNORE_PATTERN);
     }
-    await Promise.all(files.map(formatFile));
+    const errors = [];
+    await Promise.all(files.map((filepath) => formatFile(options.cwd, filepath, errors)));
+    return errors;
 }
 exports.doPrettier = doPrettier;
-async function formatFile(filepath) {
-    const text = await (0, fs_extra_1.readFile)(filepath, 'utf8');
-    const options = await prettier_1.default.resolveConfig(filepath);
-    const formatted = await prettier_1.default.format(text, { ...options, filepath });
-    await (0, fs_extra_1.writeFile)(filepath, formatted, 'utf8');
+async function formatFile(cwd, filepath, errors) {
+    const absolutePath = (0, path_1.isAbsolute)(filepath) ? filepath : (0, path_1.resolve)(cwd, filepath);
+    try {
+        const text = await (0, fs_extra_1.readFile)(absolutePath, 'utf8');
+        const config = (await prettier_1.default.resolveConfig(absolutePath)) || {};
+        const formatted = await prettier_1.default.format(text, { ...config, filepath: absolutePath });
+        if (formatted !== text) {
+            await (0, fs_extra_1.writeFile)(absolutePath, formatted, 'utf8');
+        }
+    }
+    catch (e) {
+        errors.push(e);
+    }
 }

package/lib/lints/stylelint/doStylelint.js

@@ -4,10 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.doStylelint = void 0;
-const fast_glob_1 = __importDefault(require("fast-glob"));
 const path_1 = require("path");
 const stylelint_1 = __importDefault(require("stylelint"));
 const constants_1 = require("../../utils/constants");
+const glob_1 = require("../../utils/glob");
 const formatStylelintResults_1 = require("./formatStylelintResults");
 const getStylelintConfig_1 = require("./getStylelintConfig");
 async function doStylelint(options) {
@@ -16,11 +16,7 @@ async function doStylelint(options) {
         files = options.files.filter((name) => constants_1.STYLELINT_FILE_EXT.includes((0, path_1.extname)(name)));
     }
     else {
-        const pattern = (0, path_1.join)(options.include, `**/*.{${constants_1.STYLELINT_FILE_EXT.map((t) => t.replace(/^\./, '')).join(',')}}`);
-        files = await (0, fast_glob_1.default)(pattern, {
-            cwd: options.cwd,
-            ignore: constants_1.STYLELINT_IGNORE_PATTERN,
-        });
+        files = await (0, glob_1.globFiles)(options.cwd, options.include, constants_1.STYLELINT_FILE_EXT, constants_1.STYLELINT_IGNORE_PATTERN);
     }
     const data = await stylelint_1.default.lint({
         ...(0, getStylelintConfig_1.getStylelintConfig)(options, options.pkg, options.config),

package/lib/types/index.d.ts

@@ -59,6 +59,7 @@ export interface InitOptions {
     enableStylelint?: boolean;
     enableMarkdownlint?: boolean;
     enablePrettier?: boolean;
+    enableFlatConfig?: boolean;
     disableNpmInstall?: boolean;
 }
 export interface IGetLintConfig {

package/lib/utils/conflict-resolve.js

@@ -31,8 +31,7 @@ const packagePrefixesToRemove = [
 ];
 const checkUselessConfig = (cwd) => {
     return []
-        .concat(glob_1.default.sync('.eslintrc?(.@(yaml|yml|json))', { cwd }))
-        .concat(glob_1.default.sync('.stylelintrc?(.@(yaml|yml|json))', { cwd }))
+        .concat(glob_1.default.sync('.eslintrc?(.@(yaml|yml|json))', { cwd })).concat(glob_1.default.sync('eslint.config?(.@(js|mjs|cjs|ts))', { cwd })).concat(glob_1.default.sync('.stylelintrc?(.@(yaml|yml|json))', { cwd }))
         .concat(glob_1.default.sync('.markdownlint@(rc|.@(yaml|yml|jsonc))', { cwd }))
         .concat(glob_1.default.sync('.prettierrc?(.@(cjs|config.js|config.cjs|yaml|yml|json|json5|toml))', { cwd }))
         .concat(glob_1.default.sync('tslint.@(yaml|yml|json)', { cwd }))

package/lib/utils/constants.js

@@ -58,7 +58,7 @@ exports.PROJECT_TYPES = [
 ];
 exports.ESLINT_FILE_EXT = ['.js', '.jsx', '.ts', '.tsx', '.vue'];
 exports.ESLINT_IGNORE_PATTERN = [
-    'node_modules',
+    '**/node_modules/**',
     'build',
     'dist',
     'coverage',
@@ -70,24 +70,24 @@ exports.ESLINT_IGNORE_PATTERN = [
 ];
 exports.STYLELINT_FILE_EXT = ['.css', '.scss', '.less', '.acss'];
 exports.STYLELINT_IGNORE_PATTERN = [
-    'node_modules/',
-    'build/',
-    'dist/',
-    'coverage/',
-    'es/',
-    'lib/',
+    '**/node_modules/**',
+    'build/**',
+    'dist/**',
+    'coverage/**',
+    'es/**',
+    'lib/**',
     '**/*.min.css',
     '**/*-min.css',
     '**/*.bundle.css',
 ];
 exports.MARKDOWN_LINT_FILE_EXT = ['.md'];
 exports.MARKDOWN_LINT_IGNORE_PATTERN = [
-    'node_modules/',
-    'build/',
-    'dist/',
-    'coverage/',
-    'es/',
-    'lib/',
+    '**/node_modules/**',
+    'build/**',
+    'dist/**',
+    'coverage/**',
+    'es/**',
+    'lib/**',
 ];
 exports.PRETTIER_FILE_EXT = [
     ...exports.STYLELINT_FILE_EXT,
@@ -95,7 +95,7 @@ exports.PRETTIER_FILE_EXT = [
     ...exports.MARKDOWN_LINT_FILE_EXT,
 ];
 exports.PRETTIER_IGNORE_PATTERN = [
-    'node_modules/**/*',
+    '**/node_modules/**',
     'build/**/*',
     'dist/**/*',
     'lib/**/*',

package/lib/utils/glob.d.ts

@@ -0,0 +1,3 @@
+export declare function normalizeInclude(cwd: string, include?: string): string;
+export declare function getFilePattern(cwd: string, include: string | undefined, ext: string[]): string;
+export declare function globFiles(cwd: string, include: string | undefined, ext: string[], ignore: string[]): Promise<string[]>;

package/lib/utils/glob.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.globFiles = exports.getFilePattern = exports.normalizeInclude = void 0;
+const path_1 = __importDefault(require("path"));
+const fast_glob_1 = __importDefault(require("fast-glob"));
+function normalizeInclude(cwd, include) {
+    const target = include && include.trim() ? include : cwd;
+    if (!path_1.default.isAbsolute(target))
+        return target;
+    const relative = path_1.default.relative(cwd, target);
+    return relative || '.';
+}
+exports.normalizeInclude = normalizeInclude;
+function getFilePattern(cwd, include, ext) {
+    const prefix = normalizeInclude(cwd, include);
+    const extensions = ext.map((item) => item.replace(/^\./, '')).join(',');
+    return path_1.default.join(prefix, `**/*.{${extensions}}`);
+}
+exports.getFilePattern = getFilePattern;
+async function globFiles(cwd, include, ext, ignore) {
+    return (0, fast_glob_1.default)(getFilePattern(cwd, include, ext), {
+        cwd,
+        ignore,
+        dot: false,
+        onlyFiles: true,
+    });
+}
+exports.globFiles = globFiles;

package/package.json

@@ -1,17 +1,8 @@
 {
   "name": "@huangjunsen/encode-fe-lint",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "前端编码规范工程化标准脚手架",
-  "bin": "./lib/cli.js",
   "main": "./lib/index.js",
-  "scripts": {
-    "dev": "npm run copyfiles && tsc -w",
-    "build": "rm -rf lib && npm run copyfiles && tsc",
-    "copyfiles": "copyfiles -a -u 1 \"src/config/**\" lib",
-    "test": "npm run build && jest",
-    "coverage": "nyc jest --silent --forceExit",
-    "prepublishOnly": "npm run test"
-  },
   "files": [
     "lib/",
     "README.md"
@@ -47,11 +38,6 @@
     "@babel/eslint-parser": "^7.24.1",
     "@babel/preset-react": "^7.24.1",
     "@commitlint/cli": "^16.3.0",
-    "@huangjunsen/commitlint-config": "^1.0.1",
-    "@huangjunsen/eslint-config": "^1.0.1",
-    "@huangjunsen/markdownlint-config": "^1.0.0",
-    "@huangjunsen/prettier-config": "^1.0.1",
-    "@huangjunsen/stylelint-config": "^1.0.1",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "chalk": "^4.1.2",
@@ -86,7 +72,12 @@
     "stylelint-scss": "^4.7.0",
     "terminal-link": "^2.1.1",
     "text-table": "^0.2.0",
-    "vue-eslint-parser": "^7.11.0"
+    "vue-eslint-parser": "^7.11.0",
+    "@huangjunsen/eslint-config": "^1.0.3",
+    "@huangjunsen/markdownlint-config": "^1.0.0",
+    "@huangjunsen/prettier-config": "^1.0.1",
+    "@huangjunsen/commitlint-config": "^1.0.1",
+    "@huangjunsen/stylelint-config": "^1.0.1"
   },
   "author": "Huangjunsen <951434130@qq.com>",
   "homepage": "https://github.com/Huang-junsen/js-encode-fe-spec#readme",
@@ -97,5 +88,15 @@
   },
   "bugs": {
     "url": "https://github.com/Huang-junsen/js-encode-fe-spec/issues"
+  },
+  "scripts": {
+    "dev": "npm run copyfiles && tsc -w",
+    "build": "rm -rf lib && npm run copyfiles && tsc",
+    "copyfiles": "copyfiles -a -u 1 \"src/config/**\" lib",
+    "test": "npm run build && jest",
+    "coverage": "nyc jest --silent --forceExit"
+  },
+  "bin": {
+    "encode-fe-lint": "./lib/cli.js"
   }
-}
+}