feat: umi cache

docs/docs/api/commands.md

@@ -17,6 +17,7 @@ Commands:
 
     build     build app for production
     config    umi config cli
+    cache     run the script commands, manage umi cache
     dev       dev server for development
     help      show commands help
     lint      lint source code using eslint and stylelint

packages/preset-umi/compiled/treeify/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012-2018 Luke Plaster <[email protected]>
+
+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.

packages/preset-umi/compiled/treeify/index.d.ts

@@ -0,0 +1,28 @@
+// Type definitions for treeify 1.0
+// Project: https://github.com/notatestuser/treeify
+// Definitions by: Mike North <https://github.com/mike-north>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.1
+
+export interface TreeObject {
+    [k: string]: TreeValue;
+}
+export type TreeValue = string | TreeObject;
+
+export function asTree(
+    treeObj: TreeObject,
+    showValues: boolean,
+    hideFunctions: boolean
+): string;
+
+export function asLines(
+    treeObj: TreeObject,
+    showValues: boolean,
+    lineCallback: (line: string) => void
+): string;
+export function asLines(
+    treeObj: TreeObject,
+    showValues: boolean,
+    hideFunctions: boolean,
+    lineCallback: (line: string) => void
+): string;

packages/preset-umi/compiled/treeify/package.json

@@ -0,0 +1 @@
+{"name":"treeify","version":"1.1.0","author":"Luke Plaster <[email protected]>","license":"MIT"}

packages/preset-umi/package.json

@@ -64,12 +64,14 @@
     "@types/ini": "1.3.31",
     "@types/madge": "^5.0.0",
     "@types/multer": "1.4.7",
+    "@types/treeify": "1.0.0",
     "body-parser": "1.20.0",
     "ini": "3.0.0",
     "joi2types": "1.1.1",
     "multer": "1.4.4",
     "os-locale": "^6.0.2",
     "sirv": "2.0.2",
+    "treeify": "1.1.0",
     "vite": "4.2.0"
   },
   "publishConfig": {
@@ -86,6 +88,7 @@
       "ini",
       "joi2types",
       "os-locale",
+      "treeify",
       "sirv"
     ],
     "externals": {

packages/preset-umi/src/commands/cache.ts

@@ -0,0 +1,106 @@
+import { fsExtra, logger } from '@umijs/utils';
+import { join, relative } from 'path';
+import treeify, { type TreeObject } from '../../compiled/treeify';
+import { IApi } from '../types';
+
+const details = `
+umi cache
+# clear cache directory
+umi cache clean
+# display directory information, --depth is the number of directory levels
+umi cache ls [--depth <depth>]
+`;
+
+export default (api: IApi) => {
+  api.registerCommand({
+    name: 'cache',
+    description: 'run the script commands, manage umi cache',
+    details,
+    configResolveMode: 'loose',
+    fn: ({ args }) => {
+      const absCachePath = join(
+        api.cwd,
+        api.config.cacheDirectoryPath || 'node_modules/.cache',
+      );
+      const position = relative(api.cwd, absCachePath);
+      if (fsExtra.existsSync(absCachePath)) {
+        if (args._[0] === 'clean') {
+          fsExtra.removeSync(absCachePath);
+          logger.ready(`[umi cache] cache directory is cleaned (${position})`);
+        } else if (args._[0] === 'ls') {
+          const depth: number = args.depth ?? 1;
+          const dirObj = getDirectorySize({
+            dir: absCachePath,
+            depth: depth + 1,
+          });
+          const tree: Tree = {};
+          const str = `[${getSize(dirObj.size)}] ${position}`;
+          tree[str] = dirObj.tree;
+          logger.info(
+            `[umi cache] dir info\n${treeify.asTree(
+              tree as TreeObject,
+              true,
+              true,
+            )}`,
+          );
+        }
+      } else {
+        logger.warn(`[umi cache] unknown command ${args._[0]}`);
+        console.log(details);
+      }
+    },
+  });
+};
+
+type Tree = null | { [key: string]: null | Tree };
+
+interface IGetDirectorySize {
+  dir: string;
+  depth?: number;
+  current?: number;
+}
+function getDirectorySize({ dir, depth = 2, current = 1 }: IGetDirectorySize) {
+  const obj: {
+    size: number;
+    tree: Tree;
+  } = {
+    size: 0,
+    tree: null,
+  };
+  const needCreateTree = current < depth;
+  if (needCreateTree) {
+    obj.tree = {};
+  }
+  const files = fsExtra.readdirSync(dir);
+  files.forEach((file) => {
+    const filePath = join(dir, file);
+    const stats = fsExtra.statSync(filePath);
+
+    if (stats.isFile()) {
+      const fileSize = Math.floor(stats.size / 1024);
+      obj.size += fileSize;
+      if (obj.tree) {
+        obj.tree[`[${getSize(fileSize)}] ${file}`] = null;
+      }
+    } else {
+      const objChild = getDirectorySize({
+        dir: filePath,
+        current: current + 1,
+        depth,
+      });
+      if (obj.tree) {
+        obj.tree[`[${getSize(objChild.size)}] ${file}`] = objChild.tree;
+      }
+      obj.size += objChild.size;
+    }
+  });
+
+  return obj;
+}
+
+function getSize(size: number) {
+  if (size > 1024) {
+    return `${(size / 1024).toFixed(2)} MB`;
+  }
+  return `${size} KB`;
+}

packages/preset-umi/src/index.ts

@@ -80,6 +80,7 @@ export default () => {
       require.resolve('./commands/verify-commit'),
       require.resolve('./commands/preview'),
       require.resolve('./commands/mfsu/mfsu'),
+      require.resolve('./commands/cache'),
       require.resolve('@umijs/plugin-run'),
     ].filter(Boolean),
   };