@liuli-util/cli 3.21.0 → 3.22.1

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

@@ -0,0 +1,67 @@
+import { Plugin } from 'esbuild'
+
+/**
+ * @param {string} str
+ */
+function isValidId(str: string) {
+  try {
+    new Function(`var ${str};`)
+  } catch (err) {
+    return false
+  }
+  return true
+}
+
+/**
+ * Create a map of replacements for environment variables.
+ * @return A map of variables.
+ */
+export function defineProcessEnv() {
+  /**
+   * @type {{ [key: string]: string }}
+   */
+  const definitions: Record<string, string> = {}
+  definitions['process.env.NODE_ENV'] = JSON.stringify(process.env.NODE_ENV || 'development')
+  Object.keys(process.env).forEach((key) => {
+    if (isValidId(key)) {
+      definitions[`process.env.${key}`] = JSON.stringify(process.env[key])
+    }
+  })
+  definitions['process.env'] = '{}'
+
+  return definitions
+}
+
+export function defineImportEnv() {
+  const definitions: Record<string, string> = {}
+  Object.keys(process.env).forEach((key) => {
+    if (isValidId(key)) {
+      definitions[`import.meta.env.${key}`] = JSON.stringify(process.env[key])
+    }
+  })
+  definitions['import.meta.env'] = '{}'
+  return definitions
+}
+
+/**
+ * Pass environment variables to esbuild.
+ * @return An esbuild plugin.
+ */
+export function env(options: { process?: boolean; import?: boolean }): Plugin {
+  return {
+    name: 'env',
+    setup(build) {
+      const { platform, define = {} } = build.initialOptions
+      if (platform === 'node') {
+        return
+      }
+      build.initialOptions.define = define
+      if (options.import) {
+        Object.assign(build.initialOptions.define, defineImportEnv())
+      }
+      if (options.process) {
+        Object.assign(build.initialOptions.define, defineProcessEnv())
+      }
+    },
+  }
+}

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

@@ -0,0 +1,10 @@
+export * from './autoExternal'
+export * from './env'
+export * from './log'
+export * from './metafile'
+export * from './nativeNodeModules'
+export * from './nodeExternal'
+export * from './raw'
+export * from './resolve'
+export * from './sideEffect'
+export * from './userJS'

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

@@ -0,0 +1,20 @@
+import { Plugin, PluginBuild } from 'esbuild'
+
+export function log(): Plugin {
+  return {
+    name: 'log',
+    setup(builder: PluginBuild) {
+      let start: number
+      builder.onStart(() => {
+        start = Date.now()
+      })
+      builder.onEnd((result) => {
+        if (result.errors.length !== 0) {
+          console.error('build failed', result.errors)
+          return
+        }
+        console.log(`build complete, time ${Date.now() - start}ms`)
+      })
+    },
+  }
+}

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

@@ -0,0 +1,17 @@
+import { Plugin } from 'esbuild'
+import { writeJson } from 'fs-extra'
+
+/**
+ * 生成 metafile 的插件
+ * @param metafilePath
+ */
+ export function metafile(metafilePath: string): Plugin {
+  return {
+    name: 'metafile',
+    setup(builder) {
+      builder.onEnd(async (result) => {
+        await writeJson(metafilePath, result.metafile)
+      })
+    },
+  }
+}

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/commands/esbuild/util/esbuildPlugins.d.ts

@@ -1,32 +0,0 @@
-import { Plugin } from 'esbuild';
-/**
- * 处理 nodejs 原生模块
- * @link https://github.com/evanw/esbuild/issues/1051#issuecomment-806325487
- */
-export declare function nativeNodeModules(): Plugin;
-/**
- * 排除和替换 node 内置模块
- */
-export declare function nodeExternals(): Plugin;
-/**
- * 自动排除所有依赖项
- * golang 不支持 js 的一些语法，参考 https://github.com/evanw/esbuild/issues/1634
- */
-export declare function autoExternal(): Plugin;
-/**
- * 通过 ?raw 将资源作为字符串打包进来
- * @returns
- */
-export declare function raw(): Plugin;
-/**
- * Pass environment variables to esbuild.
- * @return An esbuild plugin.
- */
-export declare function envPlugin(): Plugin;
-/**
- * 生成 metafile 的插件
- * @param metafilePath
- */
-export declare function metafile(metafilePath: string): Plugin;
-export declare function userJS(): Plugin;
-//# sourceMappingURL=esbuildPlugins.d.ts.map

package/dist/commands/esbuild/util/esbuildPlugins.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"esbuildPlugins.d.ts","sourceRoot":"","sources":["../../../../src/commands/esbuild/util/esbuildPlugins.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAIhC;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAoC1C;AAED;;GAEG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAUtC;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAerC;AAED;;;GAGG;AACH,wBAAgB,GAAG,IAAI,MAAM,CAkB5B;AAyBD;;;GAGG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAYlC;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CASrD;AAmBD,wBAAgB,MAAM,IAAI,MAAM,CAgB/B"}

package/src/commands/esbuild/__tests__/.temp/package.json

@@ -1 +0,0 @@
-{"name":"test","version":"1.0.0","userjs":{"name":"test","version":"0.1.0","description":"测试脚本","author":"rxliuli","match":["https://twitter.com/*"],"grant":["unsafeWindow"],"license":"MIT"}}

package/src/commands/esbuild/__tests__/.temp/src/index.ts

@@ -1 +0,0 @@
-console.log(unsafeWindow)

package/src/commands/esbuild/util/__tests__/.temp/index.js

@@ -1 +0,0 @@
-console.log(import.meta.env.NODE_ENV)

package/src/commands/esbuild/util/__tests__/esbuildPlugins.test.ts

@@ -1,52 +0,0 @@
-import { build, BuildOptions } from 'esbuild'
-import { remove, mkdirp, writeFile } from 'fs-extra'
-import * as path from 'path'
-import { envPlugin as env, raw } from '../esbuildPlugins'
-
-describe('测试 esbuildPlugins', () => {
-  const tempPath = path.resolve(__dirname, '.temp')
-  beforeEach(async () => {
-    await remove(tempPath)
-    await mkdirp(tempPath)
-  })
-  const options: BuildOptions = {
-    entryPoints: [path.resolve(tempPath)],
-    bundle: true,
-    outfile: path.resolve(tempPath, 'bundle.js'),
-    format: 'esm',
-    write: false,
-  }
-  describe('测试 raw', () => {
-    beforeEach(async () => {
-      await writeFile(path.resolve(tempPath, 'readme.md'), `test`)
-      await writeFile(
-        path.resolve(tempPath, 'index.js'),
-        `
-    import readme from './readme.md?raw'
-    console.log(readme)
-    `,
-      )
-    })
-    it('基本示例', async () => {
-      const res = await build({ ...options, plugins: [raw()] })
-      expect(res.outputFiles![0].text.includes(JSON.stringify('test'))).toBeTruthy()
-    })
-    it('测试不使用插件', async () => {
-      await expect(build(options)).rejects.toThrowError()
-    })
-  })
-
-  describe('测试 env', () => {
-    beforeEach(async () => {
-      await writeFile(path.resolve(tempPath, 'index.js'), `console.log(import.meta.env.NODE_ENV)`)
-    })
-    it('基本示例', async () => {
-      const res = await build({ ...options, plugins: [env()] })
-      expect(res.outputFiles![0].text.includes('"test"')).toBeTruthy()
-    })
-    it('测试不使用插件', async () => {
-      const res = await build({ ...options })
-      expect(res.outputFiles![0].text.includes('"test"')).toBeFalsy()
-    })
-  })
-})