fenge 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # fenge
 
+## 0.1.4
+
+### Patch Changes
+
+- 3783bd5: feat(fenge): `format` and `lint` properties in `fenge.config.js` are additionally accepting a function now
+
+## 0.1.3
+
+### Patch Changes
+
+- a9afc71: feat(fenge): support `--config` option
+- Updated dependencies [9e94865]
+  - @fenge/prettier-config@0.1.1
+  - @fenge/eslint-config@0.1.3
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -195,16 +195,18 @@ $ fenge -u
 
 This tool does not require a configuration file. However, you can add a `fenge.config.js` file to customize formatting and linting rules. This file should export an object with two properties:
 
-- `format`: Accept a [Prettier Config](https://prettier.io/docs/en/configuration.html).
-- `lint`: Accept a [ESLint Flat Config](https://eslint.org/docs/latest/use/configure/configuration-files).
+- `format`: Accept a function that returns a [Prettier Config](https://prettier.io/docs/en/configuration.html).
+- `lint`: Accept a function that returns an [ESLint Flat Config](https://eslint.org/docs/latest/use/configure/configuration-files).
+
+> Tips: These two functions can be async or sync. So you can add `async` or not in font of the function.
 
 ```js
 export default {
-  format: {
+  format: async () => ({
     semi: false,
     singleQuote: true,
-  },
-  lint: [
+  }),
+  lint: async () => [
     {
       files: ["**/*.{js,cjs,mjs,jsx}", "**/*.{ts,cts,mts,tsx}"],
       rules: {
@@ -219,37 +221,40 @@ Usually, we recommend reusing the built-in configurations rather than writing th
 
 ```js
 // @ts-check
-// See https://www.npmjs.com/package/@fenge/eslint-config for eslint-config detail usage
-import { Builder } from "fenge/eslint-config";
-// See https://www.npmjs.com/package/@fenge/prettier-config for prettier-config detail usage
-import prettierConfig from "fenge/prettier-config";
-
 export default {
-  format: {
-    ...prettierConfig,
-    // add config below to override the default behavior
-    semi: false,
+  format: async () => {
+    // See https://www.npmjs.com/package/@fenge/prettier-config for prettier-config detail usage
+    const prettierConfig = (await import("fenge/prettier-config")).default;
+    return {
+      ...prettierConfig,
+      // add config below to override the default behavior
+      semi: false,
+    };
+  },
+  lint: async () => {
+    // See https://www.npmjs.com/package/@fenge/eslint-config for eslint-config detail usage
+    const Builder = (await import("fenge/eslint-config")).Builder;
+    return new Builder()
+      .enablePackagejson({
+        pick: ["packagejson/top-types"], // only these rules will work for package.json files
+      })
+      .enableJavascript({
+        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
+          "@typescript-eslint/no-explicit-any": "error",
+          "@typescript-eslint/consistent-type-assertions": [
+            "error",
+            { assertionStyle: "never" },
+          ],
+          "@typescript-eslint/no-non-null-assertion": "error",
+        },
+      })
+      .toConfig();
   },
-  lint: new Builder()
-    .enablePackagejson({
-      pick: ["packagejson/top-types"], // only these rules will work for package.json files
-    })
-    .enableJavascript({
-      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
-        "@typescript-eslint/no-explicit-any": "error",
-        "@typescript-eslint/consistent-type-assertions": [
-          "error",
-          { assertionStyle: "never" },
-        ],
-        "@typescript-eslint/no-non-null-assertion": "error",
-      },
-    })
-    .toConfig(),
 };
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fenge",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "A CLI tool for code quality",
   "keywords": [
     "cli",
@@ -48,11 +48,11 @@
     "lint-staged": "15.2.10",
     "ora": "8.1.1",
     "prettier": "3.3.3",
-    "@fenge/eslint-config": "0.1.2",
-    "@fenge/prettier-config": "0.1.0",
+    "@fenge/eslint-config": "0.1.3",
     "@fenge/tsconfig": "0.1.0",
     "@fenge/types": "0.1.0",
-    "prettier-ignore": "0.1.3"
+    "prettier-ignore": "0.1.3",
+    "@fenge/prettier-config": "0.1.1"
   },
   "devDependencies": {
     "@types/node": "22.7.5"

package/src/bin/cli.js

@@ -26,6 +26,7 @@ program
     "automatically format code only, will not fix linting problems",
   )
   .option("-u, --update", "automatically format code and fix linting problems")
+  .option("-c, --config <path>", "path to configuration file")
   .option(
     "-d, --dry-run",
     "print what command will be executed under the hood instead of executing",

package/src/command/format.js

@@ -6,12 +6,14 @@ import { dir, execAsync, getBinPath } from "../utils.js";
 
 /**
  * @param {Array<string>} paths
- * @param {{update?: boolean, write?: boolean, dryRun?: boolean}} options
+ * @param {{update?: boolean, write?: boolean, dryRun?: boolean, config?: string}} options
  */
 export async function format(paths = [], options = {}) {
-  const { update = false, write = false, dryRun = false } = options;
+  const { update = false, write = false, dryRun = false, config } = options;
 
-  const cwd = process.cwd();
+  if (config) {
+    process.env["FENGE_CONFIG"] = config;
+  }
   const ignores = [".gitignore", ".prettierignore", prettierignore]
     .map((p) => path.resolve(p))
     .flatMap((p) => ["--ignore-path", p]);
@@ -27,7 +29,9 @@ export async function format(paths = [], options = {}) {
       "--ignore-unknown",
       "--no-error-on-unmatched-pattern", // Not a good option name. It's for skipping formatting symlinks. https://github.com/prettier/prettier/pull/15533
       ...(update || write ? ["--write"] : ["--check"]),
-      ...(paths.length <= 0 ? ["."] : paths).map((p) => path.resolve(cwd, p)),
+      ...(paths.length <= 0 ? ["."] : paths).map((p) =>
+        path.resolve(process.cwd(), p),
+      ),
     ],
     { topic: "💃 Checking formatting", dryRun },
   );

package/src/command/lint.js

@@ -5,12 +5,14 @@ import { dir, execAsync, getBinPath } from "../utils.js";
 
 /**
  * @param {Array<string>} paths
- * @param {{update?: boolean, fix?: boolean, dryRun?: boolean}} options
+ * @param {{update?: boolean, fix?: boolean, dryRun?: boolean, config?: string}} options
  */
 export async function lint(paths = [], options = {}) {
-  const { update = false, fix = false, dryRun = false } = options;
+  const { update = false, fix = false, dryRun = false, config } = options;
 
-  const cwd = process.cwd();
+  if (config) {
+    process.env["FENGE_CONFIG"] = config;
+  }
   process.env["ESLINT_USE_FLAT_CONFIG"] = "true"; // TODO remove it once upgrade to eslint 9
   return execAsync(
     [
@@ -19,7 +21,9 @@ export async function lint(paths = [], options = {}) {
       "--config",
       path.join(dir(import.meta.url), "..", "config", "eslint.config.js"),
       ...(update || fix ? ["--fix"] : []),
-      ...(paths.length <= 0 ? ["."] : paths).map((p) => path.resolve(cwd, p)),
+      ...(paths.length <= 0 ? ["."] : paths).map((p) =>
+        path.resolve(process.cwd(), p),
+      ),
     ],
     { topic: "📏 Checking linting", dryRun },
   );

package/src/config/eslint.config.js

@@ -1,6 +1,14 @@
 // @ts-check
+import process from "node:process";
 import { resolveConfig } from "../utils.js";
 
-export default (await resolveConfig("fenge"))?.config?.lint ??
+async function getLintConfig() {
+  const lint = (await resolveConfig("fenge", process.env["FENGE_CONFIG"]))
+    ?.config?.lint;
+  if (!lint) return undefined;
+  return typeof lint === "function" ? await lint() : lint;
+}
+
+export default (await getLintConfig()) ??
   (await resolveConfig("eslint"))?.config ??
   (await import("../re-export/eslint.config.js")).default;

package/src/config/prettier.config.js

@@ -1,6 +1,14 @@
 // @ts-check
+import process from "node:process";
 import { resolveConfig } from "../utils.js";
 
-export default (await resolveConfig("fenge"))?.config?.format ??
+async function getFormatConfig() {
+  const format = (await resolveConfig("fenge", process.env["FENGE_CONFIG"]))
+    ?.config?.format;
+  if (!format) return undefined;
+  return typeof format === "function" ? await format() : format;
+}
+
+export default (await getFormatConfig()) ??
   (await resolveConfig("prettier"))?.config ??
   (await import("../re-export/prettier.config.js")).default;

package/src/utils.js

@@ -31,11 +31,13 @@ export function dir(importMetaUrl) {
 
 /**
  * @param {string} module
+ * @param {string} [loadPath]
  */
-export async function resolveConfig(module) {
-  return await lilconfig(module, { stopDir: process.cwd() }).search(
-    process.cwd(),
-  );
+export async function resolveConfig(module, loadPath) {
+  const searcher = lilconfig(module, { stopDir: process.cwd() });
+  return loadPath
+    ? await searcher.load(loadPath)
+    : await searcher.search(process.cwd());
 }
 
 /**