@liuli-util/cli 3.20.2 → 3.22.0

package/src/commands/esbuild/util/nativeNodeModules.ts

@@ -0,0 +1,43 @@
+import { Plugin } from 'esbuild'
+
+/**
+ * 处理 nodejs 原生模块
+ * @link https://github.com/evanw/esbuild/issues/1051#issuecomment-806325487
+ */
+export function nativeNodeModules(): Plugin {
+  return {
+    name: 'native-node-modules',
+    setup(build) {
+      // If a ".node" file is imported within a module in the "file" namespace, resolve
+      // it to an absolute path and put it into the "node-file" virtual namespace.
+      build.onResolve({ filter: /\.node$/, namespace: 'file' }, (args) => ({
+        path: require.resolve(args.path, { paths: [args.resolveDir] }),
+        namespace: 'node-file',
+      }))
+
+      // Files in the "node-file" virtual namespace call "require()" on the
+      // path from esbuild of the ".node" file in the output directory.
+      build.onLoad({ filter: /.*/, namespace: 'node-file' }, (args) => ({
+        contents: `
+        import path from ${JSON.stringify(args.path)}
+        try { module.exports = require(path) }
+        catch {}
+      `,
+      }))
+
+      // If a ".node" file is imported within a module in the "node-file" namespace, put
+      // it in the "file" namespace where esbuild's default loading behavior will handle
+      // it. It is already an absolute path since we resolved it to one above.
+      build.onResolve({ filter: /\.node$/, namespace: 'node-file' }, (args) => ({
+        path: args.path,
+        namespace: 'file',
+      }))
+
+      // Tell esbuild's default loading behavior to use the "file" loader for
+      // these ".node" files.
+      const opts = build.initialOptions
+      opts.loader = opts.loader || {}
+      opts.loader['.node'] = 'file'
+    },
+  }
+}

package/src/commands/esbuild/util/nodeExternal.ts

@@ -0,0 +1,16 @@
+import { Plugin } from 'esbuild'
+
+/**
+ * 排除和替换 node 内置模块
+ */
+export function nodeExternal(): Plugin {
+  return {
+    name: 'nodeExternals',
+    setup(build) {
+      build.onResolve({ filter: /(^node:)/ }, (args) => ({
+        path: args.path.slice(5),
+        external: true,
+      }))
+    },
+  }
+}

package/src/commands/esbuild/util/raw.ts

@@ -0,0 +1,27 @@
+import { Plugin } from 'esbuild'
+import { readFile } from 'fs-extra'
+import * as path from 'path'
+
+/**
+ * 通过 ?raw 将资源作为字符串打包进来
+ * @returns
+ */
+export function raw(): Plugin {
+  return {
+    name: 'raw',
+    setup(build) {
+      build.onResolve({ filter: /\?raw$/ }, (args) => {
+        return {
+          path: path.isAbsolute(args.path) ? args.path : path.join(args.resolveDir, args.path),
+          namespace: 'raw-loader',
+        }
+      })
+      build.onLoad({ filter: /\?raw$/, namespace: 'raw-loader' }, async (args) => {
+        return {
+          contents: await readFile(args.path.replace(/\?raw$/, '')),
+          loader: 'text',
+        }
+      })
+    },
+  }
+}

package/src/commands/esbuild/util/resolve.ts

@@ -0,0 +1,22 @@
+import { build, Plugin } from 'esbuild'
+import path from 'path'
+
+/**
+ * 将指定的 import 重写为另一个
+ * @param entries
+ * @returns
+ */
+export function resolve(entries: [from: string, to: string][]): Plugin {
+  return {
+    name: 'resolve',
+    setup(build) {
+      build.onResolve({ filter: /.*/ }, async (args) => {
+        const findEntries = entries.find((item) => item[0] === args.path)
+        if (!findEntries) {
+          return
+        }
+        return await build.resolve(findEntries[1])
+      })
+    },
+  }
+}

package/src/commands/esbuild/util/sideEffect.ts

@@ -0,0 +1,29 @@
+import { Plugin } from 'esbuild'
+
+/**
+ * 设置指定模块为没有副作用的包，由于 webpack/esbuild 的配置不兼容，所以先使用插件来完成这件事
+ * @param packages
+ * @returns
+ */
+export function sideEffects(packages: string[]): Plugin {
+  return {
+    name: 'sideEffects',
+    setup(build) {
+      build.onResolve({ filter: /.*/ }, async (args) => {
+        if (
+          args.pluginData || // Ignore this if we called ourselves
+          !packages.includes(args.path)
+        ) {
+          return
+        }
+
+        const { path, ...rest } = args
+        rest.pluginData = true // Avoid infinite recursion
+        const result = await build.resolve(path, rest)
+
+        result.sideEffects = false
+        return result
+      })
+    },
+  }
+}

package/src/commands/esbuild/util/userJS.ts

@@ -0,0 +1,38 @@
+import { Plugin } from 'esbuild'
+import { readJson } from 'fs-extra'
+import path from 'path'
+
+function generateBanner(meta: object) {
+  return (
+    [
+      '// ==UserScript==',
+      ...Object.entries(meta)
+        .map(([key, value]) => {
+          if (Array.isArray(value)) {
+            return value.map((item) => `// @${key} ${item}`)
+          }
+          return `// @${key} ${value}`
+        })
+        .flat(),
+      '// ==/UserScript==',
+    ].join('\n') + '\n'
+  )
+}
+
+export function userJS(): Plugin {
+  return {
+    name: 'userJS',
+    async setup(build) {
+      const json = (await readJson(path.resolve(build.initialOptions.absWorkingDir!, 'package.json'))) as {
+        userjs: object
+      }
+      if (!json.userjs) {
+        throw new Error('userjs is not supported')
+      }
+      if (!build.initialOptions.banner) {
+        build.initialOptions.banner = {}
+      }
+      build.initialOptions.banner!['js'] = generateBanner(json.userjs)
+    },
+  }
+}

package/templates/cli/package.json

@@ -1,33 +1,35 @@
-{
-  "name": "@liuli-util/cli-template",
-  "version": "0.1.0",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
-  "license": "MIT",
-  "scripts": {
-    "build": "liuli-cli build cli",
-    "dev": "liuli-cli build cli -w",
-    "start": "esno src/bin.ts"
-  },
-  "bin": {
-    "cli-name": "./bin.js"
-  },
-  "dependencies": {
-    "commander": "^8.2.0",
-    "enquirer": "^2.3.6",
-    "fs-extra": "^10.0.0"
-  },
-  "devDependencies": {
-    "@liuli-util/cli": "^3.18.0",
-    "@types/fs-extra": "^9.0.13",
-    "@types/jest": "^27.0.2",
-    "@types/node": "^16.9.6",
-    "esno": "^0.9.1",
-    "jest": "^27.4.7",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^27.1.3",
-    "type-fest": "^2.3.4",
-    "typescript": "^4.5.5"
-  }
-}
+{
+  "name": "@liuli-util/cli-template",
+  "version": "0.2.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "build": "liuli-cli build cli",
+    "dev": "liuli-cli build cli -w",
+    "start": "esno src/bin.ts"
+  },
+  "bin": {
+    "cli-name": "./bin.js"
+  },
+  "dependencies": {
+    "commander": "^9.4.0",
+    "enquirer": "^2.3.6",
+    "fs-extra": "^10.1.0"
+  },
+  "devDependencies": {
+    "@liuli-util/cli": "workspace:^3.21.0",
+    "@types/fs-extra": "^9.0.13",
+    "@types/node": "^18.6.4",
+    "esno": "^0.16.3",
+    "rimraf": "^3.0.2",
+    "type-fest": "^2.18.0",
+    "typescript": "^4.7.4"
+  },
+  "exports": {
+    "import": "./dist/index.esm.js",
+    "require": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  }
+}

package/templates/lib/package.json

@@ -1,19 +1,24 @@
-{
-  "name": "@liuli-util/lib-template",
-  "private": true,
-  "version": "0.1.0",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
-  "license": "MIT",
-  "scripts": {
-    "build": "liuli-cli build lib",
-    "dev": "liuli-cli build lib -w"
-  },
-  "devDependencies": {
-    "@liuli-util/cli": "^3.18.0",
-    "rimraf": "^3.0.2",
-    "type-fest": "^2.3.4",
-    "typescript": "^4.5.5"
-  }
-}
+{
+  "name": "@liuli-util/lib-template",
+  "private": true,
+  "version": "0.2.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "build": "liuli-cli build lib",
+    "dev": "liuli-cli build lib -w"
+  },
+  "devDependencies": {
+    "@liuli-util/cli": "workspace:^3.21.0",
+    "rimraf": "^3.0.2",
+    "type-fest": "^2.18.0",
+    "typescript": "^4.7.4"
+  },
+  "exports": {
+    "import": "./dist/index.esm.js",
+    "require": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  }
+}

package/dist/PathUtil.d.ts

@@ -1,7 +0,0 @@
-export declare class PathUtil {
-    /**
-     * 从这个项目的根目录读取，开发环境是 src/../，运行时则是 dist/../
-     */
-    static readonly RootPath: string;
-}
-//# sourceMappingURL=PathUtil.d.ts.map

package/dist/PathUtil.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PathUtil.d.ts","sourceRoot":"","sources":["../src/PathUtil.ts"],"names":[],"mappings":"AAEA,qBAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,QAAQ,SAAgC;CACzD"}

package/dist/bin.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=bin.d.ts.map

package/dist/bin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":""}