jiek 2.0.2-alpha.12 → 2.0.2-alpha.14

package/README.md

@@ -0,0 +1,78 @@
+# Jiek
+
+| zh-Hans
+| [en](https://github.com/NWYLZW/jiek/blob/master/packages/jiek/.about/en/README.md)
+
+[![npm version](https://img.shields.io/npm/v/jiek)](https://npmjs.com/package/jiek)
+[![npm downloads](https://img.shields.io/npm/dm/jiek)](https://npm.chart.dev/jiek)
+
+> 基于 `package.json` 元数据并适用于 `Monorepo` 的**轻便**工具库编译管理套件。
+
+- [x] 自动推断：基于 `package.json` 的相关字段自动推断出构建规则，减少配置文件的编写，更加轻便与符合标准
+  - `exports`：根据入口文件推断构建目标与类型
+  - `imports`：定义路径别名，并在构建的时候自动 bundle 进来
+  - `type: module`：根据选项智能决定输出文件后缀，不需要考虑 `cjs` 与 `esm` 的适配问题
+  - `dependencies`、`peerDependencies`、`optionalDependencies`：自动将符合规则的依赖标记为 `external`
+  - `devDependencies`：将标记为开发依赖的 bundle 进对应的最终产物之中
+- [ ] 构建工具：支持多种构建工具，无需纠结于用 swc 还是 esbuild 又或者是 tsc
+  - [x] `esbuild`
+  - [x] `swc`
+  - [ ] `typescript`
+- [x] 工作空间友好：支持在 pnpm 下的工作空间开发范式
+  - [ ] 支持更多的 PM
+  - [ ] 更好的工作空间任务流
+- [x] 类型定义文件：支持聚合生成类型定义文件
+- [x] 监听模式：适配 rollup 的监听模式
+- [x] 发布适配：支持同构生成 `package.json` 等相关字段
+  - [ ] 根据 `package.json` 中的路径自动替换 README.md 中的相对路径链接为对应的网络链接
+- [x] CommonJS：产物兼容正在使用 cjs 的用户
+- [ ] 插件化
+  - [ ] Dotenv：支持 dotenv 配置文件
+  - [ ] Replacer：支持替换文件内容
+
+## 安装
+
+```bash
+npm i -D jiek
+# or
+pnpm i -D jiek
+# or
+yarn add -D jiek
+```
+
+## 快速起步
+
+通过一些简单的方式能又快又轻松的生成需要的产物。
+
+- 在 `package.json` 中添加入口文件，这里需要设置为原文件路径。
+
+  你可以在 Node.js 文档中查看更多对于 [exports](https://nodejs.org/api/packages.html#exports) 的相关内容。
+
+```json
+{
+  ...
+  "exports": "./src/index.ts",
+  ...
+}
+```
+
+- 假设你在工作空间下有一个包名字为 `@monorepo/utils` ，那么你可以运行 `jb utils` 来构建这个包。
+
+- 当你完成了开发的相关步骤后，在发布阶段你可以使用 `jk -f utils publish` 来发布你的包，本工具会自动转化并填充 `package.json` 对应的字段。
+
+  你可以添加 `-p/--preview` 参数来预览待发布的 `package.json` 的内容。
+
+## CLI
+
+```text
+Usage: jk [options] [command]
+```
+
+## 为什么不使用 X？
+
+在这里与 `jiek` 类似的工具有：[tsup](https://github.com/egoist/tsup)、[unbuild](https://github.com/unjs/unbuild)、[bunchee](https://github.com/huozhi/bunchee)、[pkgroll](https://github.com/privatenumber/pkgroll)、[tsdown](https://github.com/sxzz/tsdown)。但是他们都有着一些共同问题没有解决，比如说：
+
+- `monorepo` 的支持存在一定的问题，在依赖工作空间其他的包时必须重新编译相关依赖
+- 编写入口文件的规则过于繁琐，不够自然
+- 无法处理 `tsconfig.json` 中的 `Project Reference` 相关问题
+- 根据`conditions`

package/bin/jiek-build.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+import { existsSync } from 'node:fs'
+import { createRequire } from 'node:module'
+import { dirname, resolve } from 'node:path'
+import process from 'node:process'
+
+process.env.JIEK_IS_ONLY_BUILD = 'true'
+
+const __dirname = dirname(import.meta.url.replace('file://', ''))
+if (existsSync(resolve(__dirname, '../.jiek-dev-tag'))) {
+  const require = createRequire(import.meta.url)
+  require('esbuild-register')
+  require('../src/cli-only-build.ts')
+} else {
+  import('jiek/cli-only-build')
+}

package/bin/jiek.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import { existsSync } from 'node:fs'
+import { createRequire } from 'node:module'
+import { dirname, resolve } from 'node:path'
+
+const __dirname = dirname(import.meta.url.replace('file://', ''))
+if (existsSync(resolve(__dirname, '../.jiek-dev-tag'))) {
+  const require = createRequire(import.meta.url)
+  require('esbuild-register')
+  require('../src/cli.ts')
+} else {
+  import('jiek/cli')
+}

package/cli-only-build.cjs

@@ -116,7 +116,7 @@ async function getSelectedProjectsGraph(filter = commander.program.getOptionValu
 
 var name = "jiek";
 var type = "module";
-var version = "2.0.2-alpha.11";
+var version = "2.0.2-alpha.13";
 var description$1 = "A lightweight toolkit for compiling and managing libraries based on `package.json` metadata and suitable for `Monorepo`.";
 var author = "YiJie <yijie4188@gmail.com>";
 var repository = {

package/cli-only-build.js

@@ -108,7 +108,7 @@ async function getSelectedProjectsGraph(filter = program.getOptionValue("filter"
 
 var name = "jiek";
 var type = "module";
-var version = "2.0.2-alpha.11";
+var version = "2.0.2-alpha.13";
 var description$1 = "A lightweight toolkit for compiling and managing libraries based on `package.json` metadata and suitable for `Monorepo`.";
 var author = "YiJie <yijie4188@gmail.com>";
 var repository = {

package/cli.cjs

@@ -4667,6 +4667,16 @@ async function prepublish() {
       modifyVersionPackageJSON,
       jsoncParser.modify(modifyVersionPackageJSON, ["publishConfig", "directory"], resolvedOutdir, { formattingOptions })
     );
+    if (!fs__default.default.existsSync(resolveByDir(resolvedOutdir))) {
+      fs__default.default.mkdirSync(resolveByDir(resolvedOutdir));
+    }
+    const jiekTempDir = resolveByDir("node_modules/.jiek/.tmp");
+    if (!fs__default.default.existsSync(resolveByDir(jiekTempDir))) {
+      fs__default.default.mkdirSync(resolveByDir(jiekTempDir), { recursive: true });
+    }
+    fs__default.default.writeFileSync(resolveByDir(resolvedOutdir, "package.json"), newJSONString);
+    fs__default.default.writeFileSync(resolveByDir(jiekTempDir, "package.json"), modifyVersionPackageJSON);
+    fs__default.default.writeFileSync(resolveByDir("package.json"), withPublishConfigDirectoryOldJSONString);
     if (oldJSON.files) {
       if (!Array.isArray(oldJSON.files)) {
         throw new Error(`${dir}/package.json files field must be an array`);
@@ -4676,17 +4686,17 @@ async function prepublish() {
       }
     }
     const resolvedOutdirAbs = resolveByDir(resolvedOutdir);
-    const files = oldJSON.files ?? fs__default.default.readdirSync(resolveByDir(".")).filter((file) => file === "node_modules" || resolveByDir(file) !== resolvedOutdirAbs);
+    const files = (oldJSON.files ?? fs__default.default.readdirSync(resolveByDir("."))).filter((file) => file === "node_modules" || resolveByDir(file) !== resolvedOutdirAbs);
     for (const file of files) {
       const path2 = resolveByDir(file);
       try {
         const stat = fs__default.default.statSync(path2);
         if (stat.isDirectory()) {
-          fs__default.default.symlinkSync(path2, resolveByDir(resolvedOutdir, file), "dir");
+          fs__default.default.cpSync(path2, resolveByDir(resolvedOutdir, file), { recursive: true });
           continue;
         }
         if (stat.isFile()) {
-          fs__default.default.symlinkSync(path2, resolveByDir(resolvedOutdir, file), "file");
+          fs__default.default.cpSync(path2, resolveByDir(resolvedOutdir, file));
           continue;
         }
       } catch (e) {
@@ -4695,16 +4705,6 @@ async function prepublish() {
       }
       throw new Error(`file type of ${path2} is not supported`);
     }
-    if (!fs__default.default.existsSync(resolveByDir(resolvedOutdir))) {
-      fs__default.default.mkdirSync(resolveByDir(resolvedOutdir));
-    }
-    const jiekTempDir = resolveByDir("node_modules/.jiek/.tmp");
-    if (!fs__default.default.existsSync(resolveByDir(jiekTempDir))) {
-      fs__default.default.mkdirSync(resolveByDir(jiekTempDir), { recursive: true });
-    }
-    fs__default.default.writeFileSync(resolveByDir(resolvedOutdir, "package.json"), newJSONString);
-    fs__default.default.writeFileSync(resolveByDir(jiekTempDir, "package.json"), modifyVersionPackageJSON);
-    fs__default.default.writeFileSync(resolveByDir("package.json"), withPublishConfigDirectoryOldJSONString);
   });
 }
 async function postpublish() {

package/cli.js

@@ -4637,6 +4637,16 @@ async function prepublish() {
       modifyVersionPackageJSON,
       modify(modifyVersionPackageJSON, ["publishConfig", "directory"], resolvedOutdir, { formattingOptions })
     );
+    if (!fs.existsSync(resolveByDir(resolvedOutdir))) {
+      fs.mkdirSync(resolveByDir(resolvedOutdir));
+    }
+    const jiekTempDir = resolveByDir("node_modules/.jiek/.tmp");
+    if (!fs.existsSync(resolveByDir(jiekTempDir))) {
+      fs.mkdirSync(resolveByDir(jiekTempDir), { recursive: true });
+    }
+    fs.writeFileSync(resolveByDir(resolvedOutdir, "package.json"), newJSONString);
+    fs.writeFileSync(resolveByDir(jiekTempDir, "package.json"), modifyVersionPackageJSON);
+    fs.writeFileSync(resolveByDir("package.json"), withPublishConfigDirectoryOldJSONString);
     if (oldJSON.files) {
       if (!Array.isArray(oldJSON.files)) {
         throw new Error(`${dir}/package.json files field must be an array`);
@@ -4646,17 +4656,17 @@ async function prepublish() {
       }
     }
     const resolvedOutdirAbs = resolveByDir(resolvedOutdir);
-    const files = oldJSON.files ?? fs.readdirSync(resolveByDir(".")).filter((file) => file === "node_modules" || resolveByDir(file) !== resolvedOutdirAbs);
+    const files = (oldJSON.files ?? fs.readdirSync(resolveByDir("."))).filter((file) => file === "node_modules" || resolveByDir(file) !== resolvedOutdirAbs);
     for (const file of files) {
       const path2 = resolveByDir(file);
       try {
         const stat = fs.statSync(path2);
         if (stat.isDirectory()) {
-          fs.symlinkSync(path2, resolveByDir(resolvedOutdir, file), "dir");
+          fs.cpSync(path2, resolveByDir(resolvedOutdir, file), { recursive: true });
           continue;
         }
         if (stat.isFile()) {
-          fs.symlinkSync(path2, resolveByDir(resolvedOutdir, file), "file");
+          fs.cpSync(path2, resolveByDir(resolvedOutdir, file));
           continue;
         }
       } catch (e) {
@@ -4665,16 +4675,6 @@ async function prepublish() {
       }
       throw new Error(`file type of ${path2} is not supported`);
     }
-    if (!fs.existsSync(resolveByDir(resolvedOutdir))) {
-      fs.mkdirSync(resolveByDir(resolvedOutdir));
-    }
-    const jiekTempDir = resolveByDir("node_modules/.jiek/.tmp");
-    if (!fs.existsSync(resolveByDir(jiekTempDir))) {
-      fs.mkdirSync(resolveByDir(jiekTempDir), { recursive: true });
-    }
-    fs.writeFileSync(resolveByDir(resolvedOutdir, "package.json"), newJSONString);
-    fs.writeFileSync(resolveByDir(jiekTempDir, "package.json"), modifyVersionPackageJSON);
-    fs.writeFileSync(resolveByDir("package.json"), withPublishConfigDirectoryOldJSONString);
   });
 }
 async function postpublish() {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jiek",
   "type": "module",
-  "version": "2.0.2-alpha.12",
+  "version": "2.0.2-alpha.14",
   "description": "A lightweight toolkit for compiling and managing libraries based on `package.json` metadata and suitable for `Monorepo`.",
   "author": "YiJie <yijie4188@gmail.com>",
   "repository": {

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

@@ -0,0 +1,2 @@
+import './commands/publish'
+import 'jiek/cli-only-build'

package/src/commands/base.ts

@@ -0,0 +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} - 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)
+}