jiek 1.1.12 → 2.0.0

package/package.json

@@ -1,11 +1,20 @@
 {
   "name": "jiek",
   "type": "module",
-  "version": "1.1.12",
-  "description": "YiJie's personal kits.",
+  "version": "2.0.0",
+  "description": "A lightweight toolkit for compiling and managing libraries based on `package.json` metadata and suitable for `Monorepo`.",
+  "author": "YiJie <yijie4188@gmail.com>",
+  "repository": {
+    "url": "nwylzw/jiek",
+    "directory": "packages/jiek"
+  },
+  "homepage": "https://github.com/NWYLZW/jiek/tree/master/packages/jiek#readme",
+  "bugs": "https://github.com/NWYLZW/jiek/issues?q=is%3Aissue+is%3Aopen+jiek",
   "bin": {
     "jiek": "bin/jiek.js",
-    "jk": "bin/jiek.js"
+    "jk": "bin/jiek.js",
+    "jiek-build": "bin/jiek-build.js",
+    "jb": "bin/jiek-build.js"
   },
   "files": [
     "dist",
@@ -26,6 +35,11 @@
       "require": "./dist/cli.cjs",
       "default": "./dist/cli.js"
     },
+    "./cli-only-build": {
+      "source": "./src/cli-only-build.ts",
+      "require": "./dist/cli-only-build.cjs",
+      "default": "./dist/cli-only-build.js"
+    },
     "./rollup": {
       "source": "./src/rollup/index.ts",
       "require": "./dist/rollup/index.cjs",
@@ -36,12 +50,10 @@
     "#~/*": "./src/*"
   },
   "dependencies": {
-    "@jiek/rollup-plugin-dts": "^6.1.2",
+    "@jiek/rollup-plugin-dts": "^6.2.1",
     "@rollup/plugin-commonjs": "^28.0.0",
     "@rollup/plugin-json": "^6.0.1",
     "@rollup/plugin-node-resolve": "^15.3.0",
-    "@rollup/plugin-terser": "^0.4.4",
-    "autoprefixer": "^10.4.16",
     "cli-progress": "^3.12.0",
     "commander": "^12.0.0",
     "detect-indent": "^6.1.0",
@@ -50,21 +62,24 @@
     "js-yaml": "^4.1.0",
     "jsonc-parser": "^3.2.1",
     "rollup": "4.13.2",
-    "rollup-plugin-esbuild": "^6.1.0",
-    "typescript": "^5.0.0",
     "@jiek/pkger": "^0.2.0",
     "@jiek/utils": "^0.2.3"
   },
   "optionalDependencies": {
+    "@rollup/plugin-terser": "^0.4.4",
     "@pnpm/filter-workspace-packages": "^7.2.13",
     "esbuild-register": "^3.5.0",
     "postcss": "^8.4.47",
-    "rollup-plugin-postcss": "^4.0.2"
+    "rollup-plugin-postcss": "^4.0.2",
+    "rollup-plugin-esbuild": "^6.1.0",
+    "rollup-plugin-swc3": "^0.12.1",
+    "typescript": "^4.0.0||^5.0.0"
   },
   "devDependencies": {
     "@npm/types": "^1.0.2",
     "@pnpm/filter-workspace-packages": "^7.2.13",
     "@pnpm/workspace.pkgs-graph": "^2.0.15",
+    "@rollup/plugin-terser": "^0.4.4",
     "@types/cli-progress": "^3.11.5",
     "@types/inquirer": "^9.0.7",
     "@types/js-yaml": "^4.0.9",
@@ -73,10 +88,12 @@
     "micromatch": "^4.0.5",
     "node-sass": "^9.0.0",
     "postcss": "^8.4.47",
-    "rollup-plugin-postcss": "^4.0.2"
+    "rollup-plugin-postcss": "^4.0.2",
+    "rollup-plugin-esbuild": "^6.1.0",
+    "rollup-plugin-swc3": "^0.12.1"
   },
   "scripts": {
-    "prepublish": "jk build --noMin"
+    "prepublish": "jb --noMin"
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",

package/src/cli-only-build.ts

@@ -0,0 +1,7 @@
+import './utils/filterSupport'
+import './commands/base'
+import './commands/build'
+
+import { program } from 'commander'
+
+program.parse(process.argv)

package/src/cli.ts

@@ -1,9 +1,3 @@
-import './utils/filterSupport'
-import './commands/base'
-import './commands/build'
 import './commands/init'
 import './commands/publish'
-
-import { program } from 'commander'
-
-program.parse(process.argv)
+import 'jiek/cli-only-build'

package/src/commands/base.ts

@@ -1,8 +1,18 @@
 import { program } from 'commander'
 import pkg from 'jiek/package.json'
 
+import { filterDescription } from '#~/commands/descriptions.ts'
+import { IS_WORKSPACE } from '#~/commands/meta.ts'
+import { type } from '#~/utils/filterSupport.ts'
+
 program
+  .name('jk/jiek')
   .version(pkg.version)
-  .description(pkg.description)
-  .option('--root <root>', 'root path')
-  .option('-c, --config-path <configPath>', 'config path')
+  .description(`${pkg.description} - Version ${pkg.version}`)
+  .option('--root <root>', 'The root path of the project')
+  .option('-c, --config-path <configPath>', 'Custom jiek config path')
+
+if (type !== '' && IS_WORKSPACE) {
+  program
+    .option('-f, --filter <filter>', filterDescription)
+}

package/src/commands/build.ts

@@ -6,13 +6,16 @@ import { MultiBar, Presets } from 'cli-progress'
 import { program } from 'commander'
 import { execaCommand } from 'execa'
 
-import { actionDone, actionRestore } from '../inner'
+import { entriesDescription, filterDescription, outdirDescription } from '#~/commands/descriptions.ts'
+import { IS_WORKSPACE } from '#~/commands/meta.ts'
+import type { ProjectsGraph } from '#~/utils/filterSupport.ts'
+import { filterPackagesGraph, getSelectedProjectsGraph } from '#~/utils/filterSupport.ts'
+import { getWD } from '#~/utils/getWD.ts'
+import { loadConfig } from '#~/utils/loadConfig.ts'
+import { tsRegisterName } from '#~/utils/tsRegister.ts'
+
 import type { RollupProgressEvent, TemplateOptions } from '../rollup/base'
-import type { ProjectsGraph } from '../utils/filterSupport'
-import { filterPackagesGraph, getSelectedProjectsGraph } from '../utils/filterSupport'
-import { loadConfig } from '../utils/loadConfig'
-import { tsRegisterName } from '../utils/tsRegister'
-import { outdirDescription } from './descriptions'
+import { BUILDER_TYPE_PACKAGE_NAME_MAP, BUILDER_TYPES } from '../rollup/base'
 
 declare module 'jiek' {
   export interface Config {
@@ -33,13 +36,21 @@ module.exports = require('jiek/rollup').template(${JSON.stringify(manifest, null
 
 const require = createRequire(import.meta.url)
 
+const isDefault = process.env.JIEK_IS_ONLY_BUILD === 'true'
+
 const description = `
-Build the package according to the 'exports' field in the package.json.
-If you want to rewrite the rollup command options, you can pass the options after '--'.
-e.g. \`jiek build -- --watch\`
+Build the package according to the 'exports' field from the package.json.
+If you want to rewrite the \`rollup\` command options, you can pass the options after '--'.
+${isDefault ? 'This command is the default command.' : ''}
 `.trim()
 
-interface BuildOptions extends Record<string, unknown> {
+interface BuildOptions {
+  /**
+   * Auto-detect the builder from the installed dependencies.
+   * If the builder is not installed, it will prompt the user to install it.
+   * If exists multiple builders, it will fall back to the 'esbuild'.
+   */
+  type?: typeof BUILDER_TYPES[number]
   /**
    * The output directory of the build, which relative to the target subpackage root directory.
    * Support with variables: 'PKG_NAME',
@@ -48,9 +59,11 @@ interface BuildOptions extends Record<string, unknown> {
    * @default 'dist'
    */
   outdir: string
+  watch: boolean
   silent: boolean
-  entries: string
   verbose: boolean
+  entries?: string
+  external?: string
   noJs: boolean
   noDts: boolean
   noMin: boolean
@@ -59,6 +72,53 @@ interface BuildOptions extends Record<string, unknown> {
    */
   noClean: boolean
   onlyMin: boolean
+  /**
+   * The type of minify, support 'terser' and 'builder'.
+   *
+   * @default 'builder'
+   */
+  minType?: string
+  /**
+   * The path of the tsconfig file which is used to generate js and dts files.
+   * If not specified, it will be loaded from:
+   * - ./tsconfig.json
+   * - ./tsconfig.dts.json
+   * - ./tsconfig.build.json
+   */
+  tsconfig?: string
+  /**
+   * The path of the tsconfig file which is used to generate dts files.
+   * If not specified, it will be loaded from:
+   * - ./tsconfig.json
+   * - ./tsconfig.dts.json
+   */
+  dtsconfig?: string
+}
+
+async function checkDependency(dependency: string) {
+  try {
+    require.resolve(dependency)
+  } catch (e) {
+    console.error(`The package '${dependency}' is not installed, please install it first.`)
+    const answer = prompt('Do you want to install it now? (Y/n)', 'Y')
+    const { notWorkspace } = getWD()
+    if (answer === 'Y') {
+      await execaCommand(`pnpm install -${notWorkspace ? '' : 'w'}D ${dependency}`)
+    } else {
+      return
+    }
+  }
+}
+
+let DEFAULT_BUILDER_TYPE: typeof BUILDER_TYPES[number]
+Object.entries(BUILDER_TYPE_PACKAGE_NAME_MAP).forEach(([type, packageName]) => {
+  try {
+    require.resolve(packageName)
+    DEFAULT_BUILDER_TYPE = type as typeof BUILDER_TYPES[number]
+  } catch { /* empty */ }
+})
+if (!DEFAULT_BUILDER_TYPE!) {
+  DEFAULT_BUILDER_TYPE = 'esbuild'
 }
 
 function parseBoolean(v?: unknown) {
@@ -66,38 +126,109 @@ function parseBoolean(v?: unknown) {
   return Boolean(v)
 }
 
-program
-  .command('build')
+const buildFilterDescription = `
+${filterDescription}
+If you pass the --filter option, it will merge into the filters of the command.
+`.trim()
+
+const buildEntriesDescription = `
+${entriesDescription}
+If you pass the --entries option, it will merge into the entries of the command.
+`.trim()
+
+const command = isDefault
+  ? program
+    .name('jb/jiek-build')
+    .helpCommand(false)
+  : program
+
+if (IS_WORKSPACE) {
+  if (isDefault) {
+    command.argument('[filters]', buildFilterDescription)
+  } else {
+    command.command('build [filters]')
+  }
+} else {
+  if (isDefault) {
+    command.argument('[entries]', buildEntriesDescription)
+  } else {
+    command.command('build [entries]')
+  }
+}
+
+command
   .description(description)
+  .option('-t, --type <TYPE>', `The type of build, support ${BUILDER_TYPES.map(s => `"${s}"`).join(', ')}.`, v => {
+    if (!BUILDER_TYPES.includes(v as any)) {
+      throw new Error(`The value of 'type' must be ${BUILDER_TYPES.map(s => `"${s}"`).join(', ')}`)
+    }
+    return String(v)
+  }, 'esbuild')
   .option('-o, --outdir <OUTDIR>', outdirDescription, String, 'dist')
-  .option('-e, --entries <ENTRIES>', "Specify the entries of the package.json's 'exports' field.(support glob)")
+  .option('-e, --entries <ENTRIES>', entriesDescription)
+  .option('--external <EXTERNAL>', 'Specify the external dependencies of the package.', String)
   .option('-nj, --noJs', 'Do not output js files.', parseBoolean)
   .option('-nd, --noDts', 'Do not output dts files.', parseBoolean)
   .option('-nm, --noMin', 'Do not output minify files.', parseBoolean)
+  .option(
+    '--minType <MINTYPE>',
+    'The type of minify, support "builder" and "terser".',
+    v => {
+      if (!['builder', 'terser'].includes(v)) {
+        throw new Error('The value of `minType` must be "builder" or "terser"')
+      }
+      return String(v)
+    }
+  )
   .option('-nc, --noClean', 'Do not clean the output directory before building.', parseBoolean)
   .option(
     '-om, --onlyMin',
     'Only output minify files, but dts files will still be output, it only replaces the js files.',
     parseBoolean
   )
+  .option('--tsconfig <TSCONFIG>', 'The path of the tsconfig file which is used to generate js and dts files.', String)
+  .option('--dtsconfig <DTSCONFIG>', 'The path of the tsconfig file which is used to generate dts files.', String)
+  .option('-w, --watch', 'Watch the file changes.', parseBoolean)
   .option('-s, --silent', "Don't display logs.", parseBoolean)
   .option('-v, --verbose', 'Display debug logs.', parseBoolean)
-  .action(async ({
-    outdir,
-    silent,
-    entries,
-    verbose,
-    noJs: withoutJs,
-    noDts: withoutDts,
-    noMin: withoutMin,
-    noClean,
-    onlyMin: onlyMin
-  }: BuildOptions) => {
+  .action(async (commandFiltersOrEntries: string | undefined, options: BuildOptions) => {
+    /* eslint-disable prefer-const */
+    let {
+      type,
+      outdir,
+      watch,
+      silent,
+      verbose,
+      entries: optionEntries,
+      external,
+      noJs: withoutJs,
+      noDts: withoutDts,
+      noMin: withoutMin,
+      minType: minifyType,
+      noClean,
+      onlyMin,
+      tsconfig,
+      dtsconfig
+    } = options
+    /* eslint-enable prefer-const */
+    const resolvedType = type ?? DEFAULT_BUILDER_TYPE
+    if (!withoutJs) {
+      await checkDependency(BUILDER_TYPE_PACKAGE_NAME_MAP[resolvedType]!)
+      if (minifyType === 'builder') {
+        minifyType = resolvedType
+      }
+    }
+    if (!withoutMin) {
+      await checkDependency(
+        {
+          ...BUILDER_TYPE_PACKAGE_NAME_MAP,
+          terser: '@rollup/plugin-terser'
+        }[resolvedType]!
+      )
+    }
     let shouldPassThrough = false
 
-    const passThroughOptions = program
-      .parseOptions(process.argv)
-      .unknown
+    const passThroughOptions = process.argv
       .reduce(
         (acc, value) => {
           if (shouldPassThrough) {
@@ -110,7 +241,6 @@ program
         },
         [] as string[]
       )
-    actionRestore()
     const { build } = loadConfig()
     silent = silent ?? build?.silent ?? false
 
@@ -121,15 +251,27 @@ program
       throw new Error('Cannot use --without-js and --only-minify at the same time')
     }
 
+    let entries: string | undefined = [
+      optionEntries,
+      IS_WORKSPACE ? undefined : commandFiltersOrEntries
+    ].filter(Boolean).join(',')
+    if (entries.length === 0) {
+      entries = undefined
+    }
     const env = {
       ...process.env,
+      JIEK_BUILDER: type,
       JIEK_OUT_DIR: outdir,
       JIEK_CLEAN: String(!noClean),
       JIEK_ENTRIES: entries,
+      JIEK_EXTERNAL: external,
       JIEK_WITHOUT_JS: String(withoutJs),
       JIEK_WITHOUT_DTS: String(withoutDts),
       JIEK_WITHOUT_MINIFY: String(withoutMin),
-      JIEK_ONLY_MINIFY: String(onlyMin)
+      JIEK_ONLY_MINIFY: String(onlyMin),
+      JIEK_MINIFY_TYPE: minifyType,
+      JIEK_TSCONFIG: tsconfig,
+      JIEK_DTSCONFIG: dtsconfig
     }
 
     const multiBars = new MultiBar({
@@ -169,12 +311,15 @@ program
             `${escapeManifestName ?? `anonymous-${i++}`}.rollup.config.js`
           )
           fs.writeFileSync(configFile, FILE_TEMPLATE(manifest))
-          let prefix = ''
+          const command = [rollupBinaryPath, '--silent', '-c', configFile]
           if (tsRegisterName) {
-            prefix = `node -r ${tsRegisterName} `
+            command.unshift(`node -r ${tsRegisterName}`)
+          }
+          if (watch) {
+            command.push('--watch')
           }
-          const command = [`${prefix}${rollupBinaryPath} --silent -c ${configFile}`, ...passThroughOptions].join(' ')
-          const child = execaCommand(command, {
+          command.push(...passThroughOptions)
+          const child = execaCommand(command.join(' '), {
             ipc: true,
             cwd: dir,
             env: {
@@ -202,7 +347,11 @@ program
                     conditions
                   }))
                 )
-              console.log(`Package '${manifest.name}' has ${targetsLength} targets to build`)
+              let initMessage = `Package '${manifest.name}' has ${targetsLength} targets to build`
+              if (watch) {
+                initMessage += ' and watching...'
+              }
+              console.log(initMessage)
               leafs.forEach(({ input }) => {
                 inputMaxLen = Math.max(inputMaxLen, input.length)
               })
@@ -285,9 +434,23 @@ program
         })
       )
     }
-    const filters = (program.getOptionValue('filter') as string | undefined)?.split(',')
+    const commandFilters = IS_WORKSPACE ? commandFiltersOrEntries : undefined
+    const filters = [
+      ...new Set([
+        ...(program.getOptionValue('filter') as string | undefined)
+          ?.split(',')
+          .map(s => s.trim())
+          .filter(s => s.length > 0)
+          ?? [],
+        ...commandFilters
+          ?.split(',')
+          .map(s => s.trim())
+          .filter(s => s.length > 0)
+          ?? []
+      ])
+    ]
     try {
-      if (filters) {
+      if (filters.length > 0) {
         const packages = await filterPackagesGraph(filters)
         await Promise.all(packages.map(buildPackage))
       } else {
@@ -296,6 +459,4 @@ program
     } finally {
       multiBars.stop()
     }
-
-    actionDone()
   })

package/src/commands/descriptions.ts

@@ -1,3 +1,15 @@
+export const entriesDescription = `
+Specify the build entry-points of the package.json's 'exports' field.
+Support glob pattern and array.
+.e.g. '.', './*', './sub/*', './a,./b'.
+`.trim()
+
+export const filterDescription = `
+Filter the packages from the workspace.
+Support fuzzy match and array.
+.e.g. 'core,utils'.
+`.trim()
+
 export const outdirDescription = `
 The output directory of the build, which relative to the target subpackage root directory.
 Support with variables: 'PKG_NAME',

package/src/commands/meta.ts

@@ -0,0 +1,5 @@
+import { getWD } from '#~/utils/getWD.ts'
+
+const { notWorkspace } = getWD()
+
+export const IS_WORKSPACE = !notWorkspace

package/src/rollup/base.ts

@@ -17,6 +17,13 @@ export interface ConfigGenerateContext {
 
 export type OutputControl = boolean | ((context: ConfigGenerateContext) => boolean)
 
+export const BUILDER_TYPES = ['esbuild', 'swc'] as const
+
+export const BUILDER_TYPE_PACKAGE_NAME_MAP = {
+  esbuild: 'rollup-plugin-esbuild',
+  swc: 'rollup-plugin-swc3'
+}
+
 export interface TemplateOptions {
   /**
    * When the user configures type: module, the generated output from entry points that don't
@@ -27,6 +34,21 @@ export interface TemplateOptions {
    * @default true
    */
   crossModuleConvertor?: boolean
+  /**
+   * Auto-detect the builder from the installed dependencies.
+   * If the builder is not installed, it will prompt the user to install it.
+   * If exists multiple builders, it will fall back to the 'esbuild'.
+   *
+   * @default 'esbuild'
+   */
+  builder?:
+    | typeof BUILDER_TYPES[number]
+    | ({
+      type: 'esbuild'
+    } & import('rollup-plugin-esbuild').Options)
+    | ({
+      type: 'swc'
+    } & import('rollup-plugin-swc3').PluginOptions)
   output?: {
     /**
      * @default true
@@ -35,6 +57,24 @@ export interface TemplateOptions {
      * When minify is set to 'only-minify', the output will direct output minified files.
      */
     minify?: boolean | 'only-minify'
+    minifyOptions?:
+      | typeof BUILDER_TYPES[number]
+      | 'terser'
+      | (
+        {
+          type: 'terser'
+        } & import('@rollup/plugin-terser').Options
+      )
+      | (
+        {
+          type: 'esbuild'
+        } & Parameters<typeof import('rollup-plugin-esbuild').minify>[0]
+      )
+      | (
+        {
+          type: 'swc'
+        } & Parameters<typeof import('rollup-plugin-swc3').minify>[0]
+      )
     /**
      * @default 'dist'
      */
@@ -44,6 +84,10 @@ export interface TemplateOptions {
     js?: OutputControl
     dts?: OutputControl
   }
+  /**
+   * Set the external dependencies of the package.
+   */
+  external?: (string | RegExp)[]
   plugins?:
     | InputPluginOption
     | ((type: 'js' | 'dts', context: ConfigGenerateContext) => InputPluginOption)