feat: add config command

.changeset/config.json

@@ -18,7 +18,8 @@
   "ignore": [
     "@examples/hackernews",
     "@examples/normal",
-    "@examples/normal",
+    "@examples/shadcn-cli",
+    "@examples/tailwindcss",
     "@examples/with-antd4"
   ]
 }

.changeset/rotten-monkeys-trade.md

@@ -0,0 +1,5 @@
+---
+'@umijs/tnf': patch
+---
+
+feat: add config command

README.md

@@ -55,6 +55,7 @@ $ pnpm preview
 - `tnf generate/g <type> <name>`: Generate a new page (or component and other types in the future).
 - `tnf preview`: Preview the product after building the project.
 - `tnf sync --mode=<mode>`: Sync the project to the temporary directory.
+- `tnf config [ list | get | set | remove ] [name] [value]`: Quickly view and modify configurations through the command line.
 
 ## API
 

package.json

@@ -60,6 +60,7 @@
     "get-port-please": "^3.1.2",
     "http-proxy-middleware": "^3.0.3",
     "json5": "^2.2.3",
+    "magicast": "^0.3.5",
     "pathe": "^1.1.2",
     "picocolors": "^1.1.1",
     "random-color": "^1.0.1",

src/cli.ts

@@ -59,6 +59,9 @@ async function run(cwd: string) {
     case 'sync':
       const { sync } = await import('./sync/sync.js');
       return sync({ context });
+    case 'config':
+      const { config } = await import('./config/config.js');
+      return config({ context });
     default:
       throw new Error(`Unknown command: ${cmd}`);
   }

src/config/config.ts

@@ -2,7 +2,10 @@ import {
   loadConfig as loadC12Config,
   watchConfig as watchC12Config,
 } from 'c12';
+import { updateConfig } from 'c12/update';
+import pc from 'picocolors';
 import { CONFIG_FILE } from '../constants';
+import type { Context } from '../types';
 import type { Config } from './types';
 import { ConfigSchema } from './types';
 
@@ -48,3 +51,109 @@ function createLoadConfigOpts({ cwd, defaults, overrides }: ConfigOpts) {
     overrides,
   };
 }
+
+export function list(config: Config, name?: string) {
+  const getValue = (value: any) => {
+    if (typeof value !== 'function') {
+      return value;
+    }
+    return pc.yellow('The value data type does not support the view');
+  };
+  const print = (key: string) => {
+    console.log(
+      ` - ${pc.blue(`[key: ${key}]`)}`,
+      getValue(config[key as keyof Config]),
+    );
+    console.log();
+  };
+  console.log();
+  console.log(`  Configs:`);
+  console.log();
+  if (name) {
+    if (
+      !config[name as keyof Config] &&
+      config[name as keyof Config] !== false
+    ) {
+      // current key not existed
+      throw new Error(`key '${name}' not found`);
+    }
+    print(name as string);
+  } else {
+    // list all
+    Object.keys(config).forEach((key) => {
+      print(key);
+    });
+  }
+
+  console.log();
+}
+
+export async function setConfig({
+  cwd,
+  name,
+  value,
+  type = 'set',
+}: {
+  cwd: string;
+  name: string | number | undefined;
+  value: any;
+  type?: string | 'set' | 'remove';
+}) {
+  const configOpts = createLoadConfigOpts({ cwd });
+  await updateConfig({
+    ...configOpts,
+    onUpdate: (_config) => {
+      if (!name) {
+        console.log(pc.yellow(`key '${name}' not found`));
+        return;
+      }
+      const _value = _config[name];
+      if (type === 'remove') {
+        if (_config.hasOwnProperty(name)) {
+          delete _config[name];
+        }
+      } else {
+        if (value) {
+          let safeValue: string | number | boolean | undefined = value;
+          if (safeValue === 'true') {
+            safeValue = true;
+          } else if (safeValue === 'false') {
+            safeValue = false;
+          }
+          _config[name] = safeValue as string | number | undefined;
+        }
+      }
+      const result = ConfigSchema.safeParse(_config);
+      if (!result.success) {
+        console.log(
+          pc.yellow(`Invalid configuration: ${result.error.message}`),
+        );
+        // Verification failed, recall modification
+        _config[name] = _value;
+      } else {
+        console.log(
+          pc.green(`${type} config:${name} on ${configOpts.configFile}`),
+        );
+      }
+    },
+  });
+}
+export async function config({ context }: { context: Context }) {
+  const { _ } = context.argv;
+  const [, command, name, value] = _;
+
+  switch (command) {
+    case 'list':
+      list(context.config);
+      break;
+    case 'get':
+      list(context.config, `${name}`);
+      break;
+    case 'set':
+    case 'remove':
+      setConfig({ cwd: context.cwd, name, value, type: command });
+      break;
+    default:
+      throw new Error(`Unsupported sub command ${command} for tnf config.`);
+  }
+}