fenge 0.7.7 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # fenge
 
+## 0.8.0
+
+### Minor Changes
+
+- 8e6f32a: refactor(fenge)!: remove `@fenge/types`, drop support for type patches
+
+### Patch Changes
+
+- 57b9b81: chore: upgrade deps
+- Updated dependencies [aa7d44f]
+- Updated dependencies [57b9b81]
+- Updated dependencies [fa9dc89]
+  - @fenge/eslint-config@0.6.9
+  - @fenge/prettier-config@0.3.1
+
+## 0.7.8
+
+### Patch Changes
+
+- Updated dependencies [3c6eafe]
+  - @fenge/eslint-config@0.6.8
+
 ## 0.7.7
 
 ### Patch Changes

package/README.md

@@ -126,7 +126,7 @@ In summary, Type Safety, Formatting, and Linting are three indispensable aspects
 
 Based on the philosophy outlined above, this tool offers the following features:
 
-- 💪 **Enhanced Type Safety**: This tool provides the strictest `tsconfig` settings and type patches to bolster the type safety of TypeScript projects. It is also compatible with pure JavaScript projects.
+- 💪 **Enhanced Type Safety**: This tool provides the strictest `tsconfig` settings to bolster the type safety of TypeScript projects. It is also compatible with pure JavaScript projects.
 - 💃 **Formatting**: This tool ensures code consistency across your codebase and minimizes merge conflicts by automatically formatting code. It additionally supports the sorting of imports and `package.json` files.
 - 📏 **Linting**: This tool comes equipped with a comprehensive set of rules for static code analysis, which helps catch errors and prevent poor coding practices in JavaScript.
 - 🪝 **Git Hooks**: After installation, committing code via Git triggers automatic formatting and linting checks. No additional package installations are required.
@@ -195,26 +195,6 @@ tsc -p ./tsconfig.build.json --noEmit
 
 For more beat practices, please refer to [@fenge/tsconfig](https://www.npmjs.com/package/@fenge/tsconfig).
 
-#### Import type patch
-
-Add a [triple-slash-directive](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html) `/// <reference types="fenge/types" />` at the top of the ts file that serves as the entry point for your application or package. This will make the entire project more type-safe. The built-in type patch `fenge/types` re-exports from [@fenge/types](https://www.npmjs.com/package/@fenge/types).
-
-Application/Package Entry Point (eg: `src/main.ts` or `src/app.ts`)
-
-```ts
-/// <reference types="fenge/types" />
-import foo from "./foo";
-```
-
-Other File (eg: `src/other-file.ts`)
-
-<!-- prettier-ignore-start -->
-```ts
-console.log(JSON.parse('{"foo":"foo"}').bar.length);
-         // ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ❌ Object is of type 'unknown'.
-```
-<!-- prettier-ignore-end -->
-
 ### Formatting & Linting
 
 Here are some main commands to format or lint code.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fenge",
-  "version": "0.7.7",
+  "version": "0.8.0",
   "description": "A CLI tool for code quality",
   "keywords": [
     "cli",
@@ -32,9 +32,6 @@
   "exports": {
     "./eslint-config": "./src/re-export/eslint.config.js",
     "./prettier-config": "./src/re-export/prettier.config.js",
-    "./types": {
-      "types": "./types/index.d.ts"
-    },
     "./tsconfig": "./tsconfig/index.json",
     "./tsconfig.json": "./tsconfig/index.json",
     "./tsconfig/esm": "./tsconfig/esm.json",
@@ -47,15 +44,14 @@
     "commander": "13.1.0",
     "eslint": "9.22.0",
     "lilconfig": "3.1.3",
-    "lint-staged": "15.5.1",
+    "lint-staged": "15.5.2",
     "ora": "8.2.0",
     "prettier": "3.5.3",
     "yoctocolors": "2.1.1",
-    "@fenge/eslint-config": "0.6.7",
-    "@fenge/prettier-config": "0.3.0",
     "@fenge/tsconfig": "0.5.0",
-    "@fenge/types": "0.3.0",
-    "prettier-ignore": "0.3.0"
+    "prettier-ignore": "0.3.0",
+    "@fenge/eslint-config": "0.6.9",
+    "@fenge/prettier-config": "0.3.1"
   },
   "devDependencies": {
     "@types/node": "22.14.1"

package/src/bin/fenge.cli.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 // @ts-check
-import os from "node:os";
 import process from "node:process";
 import { initAction, setup } from "@fenge/tsconfig/setup";
 import { Command } from "commander";
@@ -10,22 +9,6 @@ import { install } from "../command/install.js";
 import { lint } from "../command/lint.js";
 import { uninstall } from "../command/uninstall.js";
 
-/**
- * @param {{code: number|null, signal: NodeJS.Signals | null}} param
- * @returns {never}
- */
-function exit({ code, signal }) {
-  if (code !== null) {
-    process.exit(code);
-  } else if (signal !== null) {
-    process.exit(128 + os.constants.signals[signal]);
-  } else {
-    throw new Error(
-      "Internal Error. Code and signal should not be null at the same time.",
-    );
-  }
-}
-
 const program = new Command().enablePositionalOptions();
 
 program
@@ -53,13 +36,13 @@ program
   .argument("[paths...]", "dir or file paths to format and lint")
   .action(async (paths, options) => {
     let result = await format(paths, options);
-    if (result.code === 0) {
+    if (result === 0) {
       result = await lint(paths, options);
-      if (result.code === 0) {
+      if (result === 0) {
         result = await format(paths, options);
       }
     }
-    exit(result);
+    process.exit(result);
   });
 
 program
@@ -78,7 +61,7 @@ program
     "print what command will be executed under the hood instead of executing",
   )
   .argument("[paths...]", "dir or file paths to lint")
-  .action(async (paths, options) => exit(await lint(paths, options)));
+  .action(async (paths, options) => process.exit(await lint(paths, options)));
 
 program
   .command("format")
@@ -95,7 +78,7 @@ program
     "print what command will be executed under the hood instead of executing",
   )
   .argument("[paths...]", "dir or file paths to format")
-  .action(async (paths, options) => exit(await format(paths, options)));
+  .action(async (paths, options) => process.exit(await format(paths, options)));
 
 program
   .command("install")

package/src/command/format.js

@@ -8,23 +8,24 @@ import { dir, execAsync, getBinPath } from "../utils.js";
  * @param {Array<string>} paths
  * @param {{update?: boolean, write?: boolean, dryRun?: boolean, config?: string, default?: boolean}} options
  */
-export async function format(paths = [], options = {}) {
-  const {
+export async function format(
+  paths = [],
+  {
     update = false,
     write = false,
     dryRun = false,
     config,
     default: useDefaultConfig = false,
-  } = options;
-
-  const ignores = [".gitignore", ".prettierignore", prettierignore]
-    .map((p) => path.resolve(p))
-    .flatMap((p) => ["--ignore-path", p]);
+  } = {},
+) {
   return execAsync(
     [
       // "node",
       await getPrettierPath(useDefaultConfig),
-      ...ignores,
+      // setup 3 ignore files
+      ...[".gitignore", ".prettierignore", prettierignore]
+        .map((p) => path.resolve(p))
+        .flatMap((p) => ["--ignore-path", p]),
       "--log-level",
       "warn",
       "--config",

package/src/command/lint.js

@@ -7,16 +7,17 @@ import { dir, execAsync, getBinPath } from "../utils.js";
  * @param {Array<string>} paths
  * @param {{update?: boolean, fix?: boolean, dryRun?: boolean, config?: string, default?: boolean, timing?: boolean}} options
  */
-export async function lint(paths = [], options = {}) {
-  const {
+export async function lint(
+  paths = [],
+  {
     update = false,
     fix = false,
     dryRun = false,
     config,
     default: useDefaultConfig = false,
     timing = false,
-  } = options;
-
+  } = {},
+) {
   return execAsync(
     [
       // "node",

package/src/utils.js

@@ -3,6 +3,7 @@ import { Buffer } from "node:buffer";
 import childProcess from "node:child_process";
 import fs from "node:fs/promises";
 import { createRequire } from "node:module";
+import os from "node:os";
 import path from "node:path";
 import process from "node:process";
 import { fileURLToPath } from "node:url";
@@ -58,21 +59,20 @@ function getSpentTime(startTime) {
 /**
  * @param {string[]} command
  * @param {{topic: string, dryRun: boolean, env: Record<string, string>}} options
- * @returns {Promise<{code: number|null, signal: NodeJS.Signals | null}>}
+ * @returns {Promise<number>}
  */
 export function execAsync(command, { topic, dryRun, env }) {
+  const [cmd, ...args] = command;
+  if (!cmd) {
+    return Promise.reject(new Error("cmd not found"));
+  }
+  if (dryRun) {
+    process.stdout.write(`${colors.green(cmd)} ${args.join(" ")};\n\n`);
+    return Promise.resolve(0);
+  }
+
   return new Promise((resolve, reject) => {
     const startTime = Date.now();
-
-    const [cmd, ...args] = command;
-    if (!cmd) {
-      return reject(new Error("cmd not found"));
-    }
-    if (dryRun) {
-      process.stdout.write(`${colors.green(cmd)} ${args.join(" ")};\n\n`);
-      return resolve({ code: 0, signal: null });
-    }
-
     const spinner = ora(`${topic}...`).start();
     /**
      * @type {childProcess.ChildProcessWithoutNullStreams | undefined}
@@ -106,8 +106,11 @@ export function execAsync(command, { topic, dryRun, env }) {
       }
       process.stdout.write(stdout);
       process.stderr.write(stderr);
-      cp = undefined; // When the cp exited, we should clean cp to prevent memory leak.
-      resolve({ code, signal });
+      // When the cp exited, we should clean cp and the buffer to prevent memory leak.
+      stdout = Buffer.alloc(0);
+      stderr = Buffer.alloc(0);
+      cp = undefined;
+      resolve(code ?? (signal ? 128 + os.constants.signals[signal] : 1));
     });
 
     /**

package/types/index.d.ts

@@ -1 +0,0 @@
-import "@fenge/types";