@icebreakers/monorepo-templates 0.1.16 → 1.0.1

package/templates/vitepress/why/examples/3.npm-basic-package/package.json

@@ -19,14 +19,13 @@
     "dist"
   ],
   "scripts": {
-    "dev": "unbuild --stub",
-    "build:watch": "tsup --watch --sourcemap",
-    "build": "tsup"
+    "dev": "tsdown --watch --sourcemap",
+    "build:watch": "tsdown --watch --sourcemap",
+    "build": "tsdown"
   },
   "devDependencies": {
-    "tsup": "^8.5.0",
+    "tsdown": "0.21.10",
     "tsx": "^4.19.4",
-    "typescript": "^5.8.3",
-    "unbuild": "^3.5.0"
+    "typescript": "^5.8.3"
   }
 }

package/templates/vitepress/why/examples/3.npm-basic-package/tsdown.config.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from 'tsdown'
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  shims: true,
+  format: ['esm', 'cjs'],
+  clean: true,
+  dts: true,
+  target: 'node18',
+  cjsInterop: true,
+  outExtensions({ format }) {
+    return {
+      js: format === 'esm' ? '.mjs' : '.cjs',
+    }
+  },
+})

package/templates/vitepress/why/examples/usage-cjs/index.js

@@ -1,12 +1,8 @@
 /* eslint-disable no-console */
-// import c from 'chalk'
-// const c = require('chalk')
 const { sayHello } = require('icebreaker-npm-basic-package')
 const { sayHello: sayHelloCjs } = require('icebreaker-npm-basic-package-multiple-exports')
+const pc = require('picocolors')
 
 sayHello()
 sayHelloCjs()
-
-import('chalk').then(({ default: c }) => {
-  console.log(c.green('Hello World!'))
-})
+console.log(pc.green('Hello World!'))

package/templates/vitepress/why/examples/usage-cjs/package-lock.json

@@ -9,22 +9,16 @@
       "version": "1.0.0",
       "license": "ISC",
       "dependencies": {
-        "chalk": "^5.6.2",
         "icebreaker-npm-basic-package": "^1.0.5",
-        "icebreaker-npm-basic-package-multiple-exports": "^0.0.0"
+        "icebreaker-npm-basic-package-multiple-exports": "^0.0.0",
+        "picocolors": "^1.1.1"
       }
     },
-    "node_modules/chalk": {
-      "version": "5.6.2",
-      "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz",
-      "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==",
-      "license": "MIT",
-      "engines": {
-        "node": "^12.17.0 || ^14.13 || >=16.0.0"
-      },
-      "funding": {
-        "url": "https://github.com/chalk/chalk?sponsor=1"
-      }
+    "node_modules/picocolors": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz",
+      "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==",
+      "license": "ISC"
     },
     "node_modules/icebreaker-npm-basic-package": {
       "version": "1.0.5",

package/templates/vitepress/why/examples/usage-cjs/package.json

@@ -13,8 +13,8 @@
     "cjs": "node cjs.cjs"
   },
   "dependencies": {
-    "chalk": "^5.6.2",
     "icebreaker-npm-basic-package": "^1.0.5",
-    "icebreaker-npm-basic-package-multiple-exports": "^0.0.0"
+    "icebreaker-npm-basic-package-multiple-exports": "^0.0.0",
+    "picocolors": "^1.1.1"
   }
 }

package/templates/vitepress/why/examples/usage-esm/index.js

@@ -1,8 +1,8 @@
 /* eslint-disable no-console */
-import c from 'chalk'
 import { sayHello } from 'icebreaker-npm-basic-package'
 import { sayHello as sayHello2 } from 'icebreaker-npm-basic-package-multiple-exports'
+import pc from 'picocolors'
 
 sayHello()
 sayHello2()
-console.log(c.green('Hello World!'))
+console.log(pc.green('Hello World!'))

package/templates/vitepress/why/examples/usage-esm/package-lock.json

@@ -9,22 +9,16 @@
       "version": "1.0.0",
       "license": "ISC",
       "dependencies": {
-        "chalk": "^5.6.2",
         "icebreaker-npm-basic-package": "1.0.5",
-        "icebreaker-npm-basic-package-multiple-exports": "^0.0.0"
+        "icebreaker-npm-basic-package-multiple-exports": "^0.0.0",
+        "picocolors": "^1.1.1"
       }
     },
-    "node_modules/chalk": {
-      "version": "5.6.2",
-      "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz",
-      "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==",
-      "license": "MIT",
-      "engines": {
-        "node": "^12.17.0 || ^14.13 || >=16.0.0"
-      },
-      "funding": {
-        "url": "https://github.com/chalk/chalk?sponsor=1"
-      }
+    "node_modules/picocolors": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz",
+      "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==",
+      "license": "ISC"
     },
     "node_modules/icebreaker-npm-basic-package": {
       "version": "1.0.5",

package/templates/vitepress/why/examples/usage-esm/package.json

@@ -14,8 +14,8 @@
     "cjs": "node cjs.cjs"
   },
   "dependencies": {
-    "chalk": "^5.6.2",
     "icebreaker-npm-basic-package": "1.0.5",
-    "icebreaker-npm-basic-package-multiple-exports": "^0.0.0"
+    "icebreaker-npm-basic-package-multiple-exports": "^0.0.0",
+    "picocolors": "^1.1.1"
   }
 }

package/templates/vitepress/why/modern/bundlers.md

@@ -7,64 +7,37 @@
 - `webpack` 我不用，因为打出来的产物代码丑，配置复杂
 - `rollup` 我最早用的就是这个，现在不用因为要装的包太多了，而且需要你对打包器有一定的理解，在打包复杂需要高度自定义的场景下使用
 - `esbuild` 用的少，直接用不是很方便，但是可以基于它做高度自定义(写插件)
-- `tsup` 基于 `esbuild` 的傻瓜无脑式的打包器，非常好用
-- `unbuild` 基于 `rollup` 的傻瓜无脑式的打包器，众多 `vite plugin` 源代码的御用打包器，还有基于 `jiti` 的 `stub` 模式，非常好用
 - `vite` 在 Vite 8 中默认基于 `rolldown` + `oxc`，假如你需要构建前端组件，这个就是首选，毕竟你也懒得去自己处理各种各样的样式文件吧，比如打包新版本 `vue` 组件，只能使用这个的库模式进行打包。
 - `rolldown`/`tsdown` 适合更偏向库构建和工具链场景，但生态兼容面和迁移经验仍然不如 `vite`/`rollup` 成熟，是否采用要看你的实际约束
 
-所以本篇文章，主要介绍 `tsup` 和 `unbuild` 这两个通用打包器的使用和配置方式，以及 `vite` 库模式进行打包 `vue` 组件，其他的请自行查看对应的文档。
+当前这个仓库已经把通用类库模板收敛到 `tsdown`，组件库则继续使用 `vite` 库模式。
 
-## tsup
+## 过时的方案
 
-本项目的模板之一 [tsup](https://github.com/sonofmagic/monorepo-template/tree/main/templates/tsup)
-
-:::code-group
-
-```ts [tsup.config.ts]
-import { defineConfig } from 'tsup'
+:::warning 不推荐继续使用
+`tsup` 和 `unbuild` 在这个模板仓库里已经被标记为过时方案，不再作为新项目的推荐构建工具。
+:::
 
-export default defineConfig({
-  entry: ['src/index.ts'], // , 'src/cli.ts'],
-  shims: true,
-  format: ['cjs', 'esm'],
-  clean: true,
-  dts: true,
-  cjsInterop: true,
-  splitting: true,
-  outExtension({ format }) {
-    return {
-      js: `.${format === 'esm' ? 'mjs' : 'cjs'}`,
-    }
-  },
-})
-```
+- `tsup` 曾经用于部分 TypeScript 包和服务模板，但现在这些模板已经迁移到 `tsdown`。如果旧项目里还有 `tsup.config.ts`，建议改成 `tsdown.config.ts`，并把 `build` / `dev` 脚本切到 `tsdown`。
+- `unbuild` 曾经用于库包开发时的 stub 流程，但这里的新模板已经统一使用 `tsdown --watch` 处理开发构建。新项目不要继续引入 `unbuild`。
 
-:::
+新建 TypeScript 类库优先使用 `tsdown` 模板；Vue 组件库继续使用 `vite` 库模式。
 
-## unbuild
+## tsdown
 
-本项目的模板之一 [unbuild](https://github.com/sonofmagic/monorepo-template/tree/main/templates/unbuild)
+本项目当前的通用类库模板是 [tsdown](https://github.com/sonofmagic/monorepo-template/tree/main/templates/tsdown)
 
 :::code-group
 
-```ts [build.config.ts]
-import path from 'node:path'
-import { defineBuildConfig } from 'unbuild'
-
-export default defineBuildConfig({
-  entries: ['./src/index'],
-  rollup: {
-    inlineDependencies: true,
-    emitCJS: true,
-    cjsBridge: true,
-    dts: {
-      respectExternal: false,
-    },
-  },
-  alias: {
-    '@': path.resolve(__dirname, './src'),
-  },
-  declaration: true,
+```ts [tsdown.config.ts]
+import { defineConfig } from 'tsdown'
+
+export default defineConfig({
+  entry: ['./src/index.ts'],
+  format: ['cjs', 'esm'],
+  dts: true,
+  clean: true,
+  target: 'node18',
 })
 ```
 

package/templates/vue-lib/eslint.config.js

@@ -1,9 +1,9 @@
-import { icebreaker } from '@icebreakers/eslint-config'
+import { defineEslintConfig } from 'repoctl/tooling'
 
-export default icebreaker(
-  {
+export default await defineEslintConfig({
+  options: {
     vue: true,
     typescript: true,
     ignores: ['**/fixtures/**'],
   },
-)
+})

package/templates/vue-lib/package.json

@@ -16,8 +16,12 @@
   "keywords": [],
   "sideEffects": false,
   "exports": {
-    ".": "./src/index.ts"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./src/index.ts"
+    }
   },
+  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -28,7 +32,8 @@
     "release": "pnpm publish",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "typecheck": "vue-tsc -b"
+    "typecheck": "vue-tsc -b",
+    "tsd": "pnpm build && tsd --typings dist/index.d.ts --files test-d/**/*.test-d.ts"
   },
   "publishConfig": {
     "exports": {
@@ -44,13 +49,13 @@
     "types": "./dist/index.d.ts"
   },
   "devDependencies": {
-    "@vitejs/plugin-vue": "^6.0.5",
-    "@vue/test-utils": "^2.4.6",
-    "@vue/tsconfig": "^0.9.0",
-    "jsdom": "^29.0.0",
-    "vite": "^8.0.0",
-    "vite-plugin-dts": "^4.5.4",
-    "vue": "^3.5.30",
-    "vue-tsc": "^3.2.6"
+    "@vitejs/plugin-vue": "^6.0.6",
+    "@vue/test-utils": "^2.4.10",
+    "@vue/tsconfig": "^0.9.1",
+    "jsdom": "^29.1.1",
+    "vite": "^8.0.10",
+    "vite-plugin-dts": "^5.0.0",
+    "vue": "^3.5.33",
+    "vue-tsc": "^3.2.8"
   }
 }

package/templates/vue-lib/test-d/index.test-d.ts

@@ -0,0 +1,6 @@
+import type { Component } from 'vue'
+import { expectAssignable } from 'tsd'
+// eslint-disable-next-line antfu/no-import-dist
+import { HelloWorld } from '../dist/index'
+
+expectAssignable<Component>(HelloWorld)

package/templates/vue-lib/tsconfig.test.json

@@ -7,7 +7,7 @@
       "ES2023"
     ],
     "moduleDetection": "force",
-    "baseUrl": ".",
+    "ignoreDeprecations": "6.0",
     "module": "ESNext",
     /* Bundler mode */
     "moduleResolution": "bundler",

package/templates/vue-lib/vitest.config.ts

@@ -1,12 +1,13 @@
 import Vue from '@vitejs/plugin-vue'
+import { defineVitestProjectConfig } from 'repoctl/tooling'
 import { mergeConfig } from 'vitest/config'
 import { sharedConfig } from './vite.shared.config'
 
 export default mergeConfig(sharedConfig, {
-  test: {
-    globals: true,
-    testTimeout: 60_000,
-    environment: 'jsdom',
-  },
+  ...await defineVitestProjectConfig({
+    options: {
+      environment: 'jsdom',
+    },
+  }),
   plugins: [Vue()],
 })

package/assets/monorepo.config.ts

@@ -1,22 +0,0 @@
-import { defineMonorepoConfig } from '@icebreakers/monorepo'
-
-export default defineMonorepoConfig({
-  commands: {
-    create: {
-      defaultTemplate: 'unbuild',
-      renameJson: false,
-    },
-    clean: {
-      autoConfirm: false,
-      includePrivate: true,
-    },
-    sync: {
-      concurrency: 4,
-      command: 'cnpm sync {name}',
-    },
-    upgrade: {
-      skipOverwrite: false,
-      mergeTargets: true,
-    },
-  },
-})

package/assets/nano-staged.js

@@ -1,18 +0,0 @@
-export default {
-  '*.{js,jsx,mjs,ts,tsx,mts}': [
-    'eslint --fix',
-  ],
-  '*.vue': [
-    'eslint --fix',
-    'stylelint --fix --allow-empty-input',
-  ],
-  '*.{json,md,mdx,html,yml,yaml}': [
-    // 'prettier --with-node-modules --ignore-path .prettierignore --write',
-    'eslint --fix',
-  ],
-  '*.{css,scss,sass,less}': [
-    'stylelint --fix --allow-empty-input',
-  ],
-  // for rust
-  // '*.rs': ['cargo fmt --'],
-}

package/templates/tsup/build.config.ts

@@ -1,24 +0,0 @@
-import path from 'node:path'
-import { defineBuildConfig } from 'unbuild'
-
-export default defineBuildConfig({
-  // entries: ['./src/index', './src/cli'],
-  rollup: {
-    // 内联，相当于 nodeResolve
-    inlineDependencies: true,
-    // cjs
-    emitCJS: true,
-    // 添加 cjs 注入
-    cjsBridge: true,
-    dts: {
-      // https://github.com/unjs/unbuild/issues/135
-      respectExternal: false,
-    },
-  },
-  alias: {
-    // 别名
-    '@': path.resolve(__dirname, './src'),
-  },
-  // dts
-  declaration: true,
-})

package/templates/tsup/package.json

@@ -1,49 +0,0 @@
-{
-  "name": "@icebreakers/tsup-template",
-  "type": "module",
-  "version": "0.0.0",
-  "description": "tsup package template",
-  "author": "ice breaker <hi@sonofmagic.top>",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sonofmagic/monorepo-template.git",
-    "directory": "templates/tsup"
-  },
-  "bugs": {
-    "url": "https://github.com/sonofmagic/monorepo-template/issues"
-  },
-  "keywords": [],
-  "sideEffects": false,
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "stub": "unbuild --stub",
-    "dev": "tsup --watch --sourcemap",
-    "build": "tsup",
-    "test": "vitest run",
-    "test:dev": "vitest",
-    "release": "pnpm publish",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "typecheck": "tsc -p tsconfig.json"
-  },
-  "publishConfig": {}
-}

package/templates/tsup/src/index.ts

@@ -1,12 +0,0 @@
-export function bar() {
-  return 'foo'
-}
-
-export function getDirname() {
-  return __dirname
-}
-
-export enum xx {
-  id,
-  dd,
-}

package/templates/tsup/test/index.test.ts

@@ -1,18 +0,0 @@
-import { bar, getDirname, xx } from '@/index'
-
-describe('index', () => {
-  it('foo bar', () => {
-    expect(bar()).toBe('foo')
-  })
-
-  it('getDirname returns a directory path', () => {
-    const dirname = getDirname()
-    expect(typeof dirname).toBe('string')
-    expect(dirname.length).toBeGreaterThan(0)
-  })
-
-  it('xx enum exposes numeric indices', () => {
-    expect(xx.id).toBe(0)
-    expect(xx.dd).toBe(1)
-  })
-})

package/templates/tsup/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "@/*": [
-        "src/*"
-      ]
-    }
-  },
-  "include": [
-    "src",
-    "test"
-  ]
-}

package/templates/tsup/tsup.config.ts

@@ -1,18 +0,0 @@
-import { defineConfig } from 'tsup'
-
-export default defineConfig({
-  entry: ['src/index.ts'], // , 'src/cli.ts'],
-  shims: true,
-  format: ['cjs', 'esm'],
-  clean: true,
-  dts: true,
-  // https://github.com/egoist/tsup/pull/1056
-  // https://github.com/egoist/tsup/issues?q=cjsInterop
-  cjsInterop: true,
-  splitting: true,
-  outExtension({ format }) {
-    return {
-      js: `.${format === 'esm' ? 'mjs' : 'cjs'}`,
-    }
-  },
-})

package/templates/tsup/vitest.config.ts

@@ -1,15 +0,0 @@
-import path from 'node:path'
-import { defineProject } from 'vitest/config'
-
-export default defineProject({
-  test: {
-    alias: [
-      {
-        find: '@',
-        replacement: path.resolve(__dirname, './src'),
-      },
-    ],
-    globals: true,
-    testTimeout: 60_000,
-  },
-})

package/templates/unbuild/build.config.ts

@@ -1,24 +0,0 @@
-import path from 'node:path'
-import { defineBuildConfig } from 'unbuild'
-
-export default defineBuildConfig({
-  // entries: ['./src/index', './src/cli'],
-  rollup: {
-    // 内联，相当于 nodeResolve
-    inlineDependencies: true,
-    // cjs
-    emitCJS: true,
-    // 添加 cjs 注入
-    cjsBridge: true,
-    dts: {
-      // https://github.com/unjs/unbuild/issues/135
-      respectExternal: false,
-    },
-  },
-  alias: {
-    // 别名
-    '@': path.resolve(__dirname, './src'),
-  },
-  // dts
-  declaration: true,
-})

package/templates/unbuild/package.json

@@ -1,49 +0,0 @@
-{
-  "name": "@icebreakers/unbuild-template",
-  "type": "module",
-  "version": "0.0.0",
-  "description": "unbuild package template",
-  "author": "ice breaker <hi@sonofmagic.top>",
-  "license": "ISC",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sonofmagic/monorepo-template.git",
-    "directory": "templates/unbuild"
-  },
-  "bugs": {
-    "url": "https://github.com/sonofmagic/monorepo-template/issues"
-  },
-  "keywords": [],
-  "sideEffects": false,
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "dev": "unbuild --stub",
-    "build:watch": "unbuild --watch --sourcemap",
-    "build": "unbuild",
-    "test": "vitest run",
-    "test:dev": "vitest",
-    "release": "pnpm publish",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "typecheck": "tsc -p tsconfig.json"
-  },
-  "publishConfig": {}
-}

package/templates/unbuild/src/index.ts

@@ -1,9 +0,0 @@
-export function foo() {
-  return 'bar'
-}
-
-export function getDirname() {
-  return __dirname
-}
-
-export { format } from '@/utils'

package/templates/unbuild/src/utils.ts

@@ -1,5 +0,0 @@
-const lowercaseLetterPattern = /[a-z]/g
-
-export function format(str: string) {
-  return str.replaceAll(lowercaseLetterPattern, s => s.toUpperCase())
-}

package/templates/unbuild/test/index.test.ts

@@ -1,18 +0,0 @@
-import { foo, format, getDirname } from '@/index'
-
-describe('index', () => {
-  it('foo bar', () => {
-    expect(foo()).toBe('bar')
-  })
-
-  it('format uppercases alphabetical characters', () => {
-    expect(format('abc-123')).toBe('ABC-123')
-  })
-
-  it('getDirname exposes template directory path', () => {
-    const dirname = getDirname()
-    expect(typeof dirname).toBe('string')
-    expect(dirname.length).toBeGreaterThan(0)
-    expect(dirname).toContain('unbuild')
-  })
-})