fenge 0.1.8 → 0.2.0-beta.1

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # fenge
 
+## 0.2.0-beta.1
+
+### Minor Changes
+
+- c7a01e8: refactor(eslint-config): replace `override` and `extend` properties with `append` property for overriding or extending the built-in rules
+- db82f69: feat(fenge): use local ESLint and Prettier first
+
+### Patch Changes
+
+- Updated dependencies [c7a01e8]
+- Updated dependencies [c5a6425]
+- Updated dependencies [d54f6af]
+- Updated dependencies [740fdb7]
+  - @fenge/eslint-config@0.4.0-beta.1
+  - @fenge/types@0.2.0-beta.1
+
+## 0.2.0-beta.0
+
+### Minor Changes
+
+- be7e3d5: chore(fenge): upgrade `prettier` to 3.4.1
+- 4c6fa59: refactor(fenge): optimize tsconfig exports and rename tsconfig.json to index.json
+
+### Patch Changes
+
+- Updated dependencies [5adeeed]
+- Updated dependencies [36d1fb0]
+- Updated dependencies [3605e14]
+- Updated dependencies [0d71378]
+- Updated dependencies [a5fb6f8]
+- Updated dependencies [41c783a]
+- Updated dependencies [b1fc095]
+- Updated dependencies [3f4e737]
+- Updated dependencies [1f5fce3]
+- Updated dependencies [51502cc]
+- Updated dependencies [2f12ec2]
+  - @fenge/prettier-config@0.1.3-beta.0
+  - @fenge/eslint-config@0.4.0-beta.0
+  - @fenge/types@0.2.0-beta.0
+  - @fenge/tsconfig@0.1.1-beta.0
+
 ## 0.1.8
 
 ### Patch Changes

package/README.md

@@ -125,7 +125,7 @@ Config `tsconfig.json` file in your project root.
 }
 ```
 
-Config `tsconfig.build.json` file in sub-package or project root.
+Config `tsconfig.build.json` file in your project root.
 
 ```json
 {
@@ -242,9 +242,8 @@ export default {
         omit: ["no-var"], // these rules will not work for js files
       })
       .enableTypescript({
-        project: "tsconfig.json", // tsconfig.json path
-        extend: {
-          // apply additional rules for ts files
+        // apply additional rules or override the built-in rules for ts files
+        append: {
           "@typescript-eslint/no-explicit-any": "error",
           "@typescript-eslint/consistent-type-assertions": [
             "error",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fenge",
-  "version": "0.1.8",
+  "version": "0.2.0-beta.1",
   "description": "A CLI tool for code quality",
   "keywords": [
     "cli",
@@ -35,9 +35,12 @@
     "./types": {
       "types": "./types/index.d.ts"
     },
-    "./tsconfig": "./tsconfig/tsconfig.json",
-    "./tsconfig/*": "./tsconfig/*.json",
-    "./tsconfig/*.json": "./tsconfig/*.json"
+    "./tsconfig": "./tsconfig/index.json",
+    "./tsconfig.json": "./tsconfig/index.json",
+    "./tsconfig/esm": "./tsconfig/esm.json",
+    "./tsconfig/esm.json": "./tsconfig/esm.json",
+    "./tsconfig/cjs": "./tsconfig/cjs.json",
+    "./tsconfig/cjs.json": "./tsconfig/cjs.json"
   },
   "bin": "./src/bin/cli.js",
   "dependencies": {
@@ -47,11 +50,11 @@
     "lilconfig": "3.1.2",
     "lint-staged": "15.2.10",
     "ora": "8.1.1",
-    "prettier": "3.3.3",
-    "@fenge/eslint-config": "0.3.0",
-    "@fenge/prettier-config": "0.1.2",
-    "@fenge/tsconfig": "0.1.0",
-    "@fenge/types": "0.1.0",
+    "prettier": "3.4.1",
+    "@fenge/eslint-config": "0.4.0-beta.1",
+    "@fenge/prettier-config": "0.1.3-beta.0",
+    "@fenge/tsconfig": "0.1.1-beta.0",
+    "@fenge/types": "0.2.0-beta.1",
     "prettier-ignore": "0.1.3"
   },
   "devDependencies": {
@@ -69,6 +72,6 @@
     "node": ">=18"
   },
   "scripts": {
-    "build": "tsc --noEmit -p tsconfig.build.json"
+    "build": "tsc --noEmit"
   }
 }

package/src/bin/cli.js

@@ -29,7 +29,7 @@ program
   .option("-c, --config <path>", "path to configuration file")
   .option(
     "--default",
-    "force to use built-in default config, ignore specified config and local config",
+    "force to use built-in default config, built-in prettier and built-in eslint. ignore specified config, local config, local prettier and local eslint",
   )
   .option(
     "-d, --dry-run",

package/src/command/format.js

@@ -9,22 +9,21 @@ import { dir, execAsync, getBinPath } from "../utils.js";
  * @param {{update?: boolean, write?: boolean, dryRun?: boolean, config?: string, default?: boolean}} options
  */
 export async function format(paths = [], options = {}) {
-  const { update = false, write = false, dryRun = false, config } = options;
-  const useDefaultConfig = options["default"] ?? false;
+  const {
+    update = false,
+    write = false,
+    dryRun = false,
+    config,
+    default: useDefaultConfig = false,
+  } = options;
 
-  if (config) {
-    process.env["FENGE_CONFIG"] = config;
-  }
-  if (useDefaultConfig) {
-    process.env["FENGE_USE_DEFAULT_CONFIG"] = "true";
-  }
   const ignores = [".gitignore", ".prettierignore", prettierignore]
     .map((p) => path.resolve(p))
     .flatMap((p) => ["--ignore-path", p]);
   return execAsync(
     [
       // "node",
-      await getBinPath("prettier"),
+      await getPrettierPath(useDefaultConfig),
       ...ignores,
       "--log-level",
       "warn",
@@ -37,6 +36,26 @@ export async function format(paths = [], options = {}) {
         path.resolve(process.cwd(), p),
       ),
     ],
-    { topic: "💃 Checking formatting", dryRun },
+    {
+      topic: "💃 Checking formatting",
+      dryRun,
+      env: {
+        ...(config && { FENGE_CONFIG: config }),
+        ...(useDefaultConfig && { FENGE_USE_DEFAULT_CONFIG: "true" }),
+      },
+    },
+  );
+}
+
+/**
+ * @param {boolean} useDefaultConfig
+ */
+async function getPrettierPath(useDefaultConfig) {
+  const builtinBinPath = await getBinPath("prettier");
+  if (useDefaultConfig) {
+    return builtinBinPath;
+  }
+  return await getBinPath("prettier", process.cwd()).catch(
+    () => builtinBinPath,
   );
 }

package/src/command/lint.js

@@ -8,20 +8,18 @@ import { dir, execAsync, getBinPath } from "../utils.js";
  * @param {{update?: boolean, fix?: boolean, dryRun?: boolean, config?: string, default?: boolean}} options
  */
 export async function lint(paths = [], options = {}) {
-  const { update = false, fix = false, dryRun = false, config } = options;
-  const useDefaultConfig = options["default"] ?? false;
+  const {
+    update = false,
+    fix = false,
+    dryRun = false,
+    config,
+    default: useDefaultConfig = false,
+  } = options;
 
-  if (config) {
-    process.env["FENGE_CONFIG"] = config;
-  }
-  if (useDefaultConfig) {
-    process.env["FENGE_USE_DEFAULT_CONFIG"] = "true";
-  }
-  process.env["ESLINT_USE_FLAT_CONFIG"] = "true"; // TODO remove it once upgrade to eslint 9
   return execAsync(
     [
       // "node",
-      await getBinPath("eslint"),
+      await getEslintPath(useDefaultConfig),
       "--config",
       path.join(dir(import.meta.url), "..", "config", "eslint.config.js"),
       ...(update || fix ? ["--fix"] : []),
@@ -29,6 +27,25 @@ export async function lint(paths = [], options = {}) {
         path.resolve(process.cwd(), p),
       ),
     ],
-    { topic: "📏 Checking linting", dryRun },
+    {
+      topic: "📏 Checking linting",
+      dryRun,
+      env: {
+        ESLINT_USE_FLAT_CONFIG: "true", // TODO remove it once upgrade to eslint 9
+        ...(config && { FENGE_CONFIG: config }),
+        ...(useDefaultConfig && { FENGE_USE_DEFAULT_CONFIG: "true" }),
+      },
+    },
   );
 }
+
+/**
+ * @param {boolean} useDefaultConfig
+ */
+async function getEslintPath(useDefaultConfig) {
+  const builtinBinPath = await getBinPath("eslint");
+  if (useDefaultConfig) {
+    return builtinBinPath;
+  }
+  return await getBinPath("eslint", process.cwd()).catch(() => builtinBinPath);
+}

package/src/utils.js

@@ -48,7 +48,7 @@ export async function resolveConfig(module, loadPath) {
  */
 export async function importJson(importMetaUrl, jsonPath) {
   return JSON.parse(
-    await fs.readFile(path.resolve(dir(importMetaUrl), jsonPath), "utf-8"),
+    await fs.readFile(path.resolve(dir(importMetaUrl), jsonPath), "utf8"),
   );
 }
 
@@ -69,23 +69,25 @@ function getSpentTime(startTime) {
 
 /**
  * @param {string[]} command
- * @param {{topic: string, dryRun: boolean}} options
+ * @param {{topic: string, dryRun: boolean, env: Record<string, string>}} options
  * @returns {Promise<number>}
  */
-export async function execAsync(command, { topic, dryRun }) {
-  const [cmd, ...args] = command;
-  if (!cmd) {
-    throw new Error("cmd not found");
-  }
-  if (dryRun) {
-    console.log(`${chalk.green(cmd)} ${args.join(" ")}`);
-    return 0;
-  }
-  const startTime = Date.now();
-  return new Promise((resolve) => {
+export function execAsync(command, { topic, dryRun, env }) {
+  return new Promise((resolve, reject) => {
+    const startTime = Date.now();
+
+    const [cmd, ...args] = command;
+    if (!cmd) {
+      return reject(new Error("cmd not found"));
+    }
+    if (dryRun) {
+      console.log(`${chalk.green(cmd)} ${args.join(" ")}`);
+      return resolve(0);
+    }
+
     const spinner = ora(`${topic}...`).start();
     const cp = childProcess.spawn(cmd, args, {
-      env: { FORCE_COLOR: "true", ...process.env },
+      env: { FORCE_COLOR: "true", ...process.env, ...env },
     });
     let stdout = Buffer.from([]);
     let stderr = Buffer.from([]);
@@ -143,10 +145,18 @@ function getExitCode(error) {
 
 /**
  * @param {string} moduleName `eslint` or `prettier` or `@commitlint/cli` or `lint-staged`
- * @param {string} cliName
+ * @param {string} from directory path or file path
  */
-export async function getBinPath(moduleName, cliName = moduleName) {
-  const packageJsonPath = createRequire(import.meta.url).resolve(
+export async function getBinPath(
+  moduleName,
+  from = fileURLToPath(import.meta.url),
+) {
+  const fromPath =
+    !from.endsWith(path.sep) && (await fs.stat(from)).isDirectory()
+      ? from + path.sep
+      : from;
+  const cliName = moduleName;
+  const packageJsonPath = createRequire(fromPath).resolve(
     `${moduleName}/package.json`,
   );
   /** @type {any} */

package/tsconfig.json

@@ -1,3 +1,3 @@
 {
-  "extends": "./tsconfig/tsconfig.json"
+  "extends": "./tsconfig/index.json"
 }

package/tsconfig.build.json

@@ -1,5 +0,0 @@
-{
-  "extends": "./tsconfig",
-  "include": ["src"],
-  "exclude": ["**/*.spec.ts", "**/*.test.ts"]
-}