@planet-matrix/mobius-mono 0.4.2 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @planet-matrix/mobius-mono
 
+## 0.5.0
+
+### Minor Changes
+
+- 1297345: Update Mobius Mono.
+
+  使用 `.npmignore` 代替 `files` 字段，重新撰写 Mobius Mono 文档等。
+
 ## 0.4.2
 
 ### Patch Changes

package/README.md

@@ -1,153 +1,41 @@
 # Mobius Mono
 
-Mobius Mono 是一个用于规范项目的项目，由规范文本（Specification）、配套工具（Tool）组成。
+Mobius Mono 是一个用于对项目开发进行规范的项目，目标是将项目开发中与核心业务逻辑无关的部分全部标准化，一方面开发者可以专注于业务逻辑的开发，另一方面不同项目可以共享相同的基础设施，从而提升整体的开发体验、协同效率和交付质量。同时，清晰明确的规范也能够提高人与 AI 协同开发或全 AI 驱动开发的效率和质量。
 
-该规范的正式名称为 Mobius Mono。在指称该规范时，可称为“Mobius Mono 规范”或“Mobius Mono Spec”。
+项目开发中，所有的规范都可以具体为对某个或某些文件的要求，基于这样的理解，Mobius Mono 的规范等价于一个规则集，其中每条规则都对应于对某个或某些文件的某种要求，这个规则集会随着时间的推移不断演进和完善，以适应不断变化的开发需求和技术环境。
 
-## Principles
+每条规则都有对应的代码实现，可以通过调用代码来执行目标规则的查看、检查、修正、迁移等操作，调用代码的操作可以手动完成，也可以配合 CI/CD 等工具自动完成，而无需全凭人工注意来保障规则的遵守。
 
-- 不考虑保障不符合 Mobius Mono 规范的项目的开发体验。
-- 优先使用 TypeScript，并且只在必要的时候转译为 JavaScript。
-- 业务代码中优先使用跨运行时、跨平台兼容的特性。
-- 优先使用 Bun 提供的基础设施（infra）。
-- 优先使用 Oxc 生态系统中的工具。
-- 所有敏感信息都只通过环境变量提供。
+## Documentation
 
-## Specification
+- Mobius Mono 规范的文本版本请查阅 [Mobius Mono Specification](./docs/mobius-mono-specification.md)。
+- 如何在项目中使用 Mobius Mono 规范请查阅 [Getting Started](./docs/getting-started.md)。
 
-### Monorepo
+## Todos & Drafts
 
-- 所有子包均放置在 `packages/` 目录下，仅支持一级子包，不支持多级嵌套。
-- Monorepo 只是为了方便管理多个包，并不影响每个包的独立性，每个子包都拥有独立的 `package.json`、`tsconfig.json`、`README.md`、`LICENSE` 等文件，可以独立发布。
-
-### File
-
-- 文件、目录命名格式应使用 kebab-case，约定俗成的文件或目录可以例外，如 `node_modules` 等。
-- 文件、目录命名区分大小写且应该尽可能只使用小写字母，约定俗成的文件或目录可以例外，如 `README.md`、`CHANGELOG.md`、`LICENSE` 等。
-- 文件、目录命名时，表示集合用复数，如 `scripts`、`tests`、`docs` 等，表示概念用单数，如 `dist`、`signal`、`build` 等，约定俗成的文件或目录可以例外，如 `src`、`bin` 等。
-
-### Package
-
-- 使用 Bun 作为包管理工具。
-- 无论是源代码还是打包产物，都只支持 ES Modules。
-- 本地发包时，npm token 写在操作者的全局 `.npmrc` 中，CI/CD 发包时，使用 [Trusted publishing](https://docs.npmjs.com/trusted-publishers)。
-- 除敏感文件、临时文件、`node_modules` 外，其它所有文件均作为包的一部分进行发布。
-
-- `package.json` 一定要设置 `name` 字段。
-- `package.json` 一定要设置 `version` 字段。
-- `package.json` 一定要设置 `description` 字段。
-- `package.json` 一定要设置 `keywords` 字段。
-- `package.json` 一定要设置 `homepage` 字段，若没有 Homepage，该字段的值可设置为项目的仓库地址。
-- `package.json` 一定要设置 `bugs` 字段，`bugs` 字段的值一定要是对象，该对象一定要包含 `url` 字段，且 `url` 字段的值一定要是项目的 issue 地址，该对象一定要包含 `email` 字段，且 `email` 字段的值一定要是项目所有者的邮箱地址。
-- `package.json` 一定要设置 `license` 字段。
-- `package.json` 一定要设置 `author` 字段，且 `author` 字段的值一定要是对象，该对象一定要包含 `name` 字段，且 `name` 字段的值一定要是项目所有者的名称，该对象一定要包含 `email` 字段，且 `email` 字段的值一定要是项目所有者的邮箱地址，该对象一定要包含 `url` 字段，且 `url` 字段的值一定要是项目所有者的主页地址。
-- `package.json` 一定要设置 `contributors` 字段。
-- `package.json` 一定要设置 `files` 字段，`files` 字段的值一定要是 `["*"]`。
-- `package.json` 一定要设置 `bin` 字段，`bin` 字段的值一定要是对象。
-- `package.json` 一定要设置 `man` 字段，`man` 字段的值一定要是数组。
-- `package.json` 一定要设置 `type` 字段，该字段的值一定要是 `module`。
-- `package.json` 一定要设置 `exports` 字段，`exports` 字段的值一定要是对象，该对象至少要包含 `.` 字段用于指定包的主要入口文件，且 `.` 字段的值一定要是包含且只包含 `import` 字段的对象（只支持 ES Modules），且 `import` 字段的值一定要是对象，该对象的字段包含且只包含 `@planet-matrix/mobius-mono`、`bun`、`types` 和 `default` 四个字段（顺序一定要与描述一致，虽然 Node.js [推荐](https://nodejs.org/api/packages.html#community-conditions-definitions)总是将 `types` 作为第一个 condition，但 Live TypeScript 追求直接指向 `.ts` 文件，因此将 `types` condition 后移）。示例如下：
-  ```jsonc
-  {
-    // other fields of package.json omitted
-    "exports": {
-      ".": {
-        "import": {
-          "@planet-matrix/mobius-mono": "./src/index.ts",
-          "bun": "./src/index.ts",
-          "types": "./dist/index.d.ts",
-          "default": "./dist/index.js"
-        }
-      },
-      // other subpath omitted
-    },
-    // other fields of package.json omitted
-  }
-  ```
-- `package.json` 一定要设置 `imports` 字段。示例如下：
-  ```jsonc
-  {
-    // other fields of package.json omitted
-    "imports": {
-      "#Project/*": {
-        "import": {
-          "@planet-matrix/mobius-mono": "./*",
-          "bun": "./*",
-          "default": "./*"
-        }
-      },
-      "#Source/*": {
-        "import": {
-          "@planet-matrix/mobius-mono": "./src/*",
-          "bun": "./src/*",
-          "default": "./src/*"
-        }
-      },
-      // other subpath omitted
-    },
-    // other fields of package.json omitted
-  }
-  ```
-- `package.json` 一定不要设置 `main` 字段。
-- `package.json` 一定要设置 `repository` 字段，且 `repository` 字段的值一定要是对象，该对象一定要包含 `type` 字段，且 `type` 字段的值一定要是 `git`，该对象一定要包含 `url` 字段，且 `url` 字段的值一定要是项目的仓库地址，如果该包位于 monorepo 中且该 `package.json` 不位于仓库根目录，该对象一定要包含 `directory` 字段，且 `directory` 字段的值一定要是该包相对于仓库根目录的路径。
-- `package.json` 一定要设置 `scripts` 字段。
-- `package.json` 一定要设置 `dependencies` 字段。
-- `package.json` 一定要设置 `devDependencies` 字段。
-- `package.json` 一定要设置 `peerDependencies` 字段。
-- `package.json` 一定要设置 `peerDependenciesMeta` 字段。
-- `package.json` 一定要设置 `bundleDependencies` 字段。
-- `package.json` 一定要设置 `optionalDependencies` 字段。
-- `package.json` 一定要设置 `overrides` 字段。
-
-### TypeScript
-
-- 仅将 TypeScript（此处不是指作为语言的 TypeScript，而是指配套的库或工具）作为提升开发体验的工具使用，将类型文件输出、代码转译等工作交给其它工具来完成。
-- TypeScript 配置尽量与 Bun 的推荐配置保持一致，见：https://bun.com/docs/typescript。
-
-- 将 `compilerOptions.allowImportingTsExtensions` 设置为 `true`，导入任意文件都一定要包含文件扩展名。
-- 将 `@planet-matrix/mobius-mono` 设置为 `compilerOptions.customConditions` 的第一项，遵循 Mobius Mono 规范的项目会将 `@planet-matrix/mobius-mono` 作为 conditional exports 的第一个 condition，从而实现 Live TypeScript（aka. Live Types）。
-- 将 `compilerOptions.module` 设置为 `preserve`，虽然我们不使用 TypeScript 来转译代码，但设置这个字段有助于 TypeScript 正确处理类型，从而提升开发体验。
-- 将 `compilerOptions.moduleResolution` 设置为 `bundler`，从而让 TypeScript 可以正确消费 `package.json` 中的 `imports` 和 `exports` 字段。
-- 将 `compilerOptions.noUncheckedSideEffectImports` 设置为 `true`，从而让 TypeScript 严格检查所有的副作用导入语句，避免导入不存在的模块。
-- 将 `compilerOptions.paths` 设置为 `{}`（即不使用该功能），使用 [subpath imports](https://nodejs.org/api/packages.html#subpath-imports) 作为替代方案，后者被 Node.js、Bun 等运行时原生支持，且在 `package.json` 中进行定义可以更加显式地体现包的情况。
-- 将 `compilerOptions.resolveJsonModule` 设置为 `true`，从而允许导入 JSON 文件。
-- 将 `compilerOptions.resolvePackageJsonExports` 设置为 `true`，从而让 TypeScript 可以正确消费 `package.json` 中的 `exports` 字段。
-- 将 `compilerOptions.resolvePackageJsonImports` 设置为 `true`，从而让 TypeScript 可以正确消费 `package.json` 中的 `imports` 字段。
-- 将 `compilerOptions.rewriteRelativeImportExtensions` 设置为 `false`，我们不使用 TypeScript 来转译代码，开启该选项会产生额外的报错，如 `This import uses a '.ts' extension to resolve to an input TypeScript file, but will not be rewritten during emit because it is not a relative path.`。
-- 将 `compilerOptions.typeRoots` 设置为 `["${configDir}/node_modules/@types"]`，从而让 TypeScript 只消费项目直接依赖的类型定义文件。
-- 将 `compilerOptions.types` 字段注释，否则 `compilerOptions.typeRoots` 不会生效。
-- 将 `compilerOptions.noEmit` 设置为 `true`，原因之一是我们不使用 TypeScript 来转译代码，原因之二是我们开启了 `compilerOptions.allowImportingTsExtensions`，开启该选项要求 `either --noEmit or --emitDeclarationOnly to be set`。
-- 将 `compilerOptions.forceConsistentCasingInFileNames` 设置为 `true`。
-- 将 `compilerOptions.isolatedDeclarations` 设置为 `true`。
-- 将 `compilerOptions.isolateModules` 设置为 `true`。
-- 将 `compilerOptions.verbatimModuleSyntax` 设置为 `true`。
-- 将 `compilerOptions.lib` 设置为 `["ESNext", "DOM", "WebWorker", "ScriptHost"]`，即默认启用所有不同运行环境的 API，以保持开发体验的一致性，正确性和跨平台兼容性由代码来保障。
-- 将 `compilerOptions.moduleDetection` 设置为 `force`，即要求尽可能将所有代码编写成模块。
-- 将 `compilerOptions.noLib` 设置为 `false`。
-- 将 `compilerOptions.target` 设置为 `esnext`，即拥抱最新的 JavaScript 特性。
-
-### Lint
-
-- 将 Formatting 视为 Linting 的一部分。
-- import 任意文件都一定要包含文件扩展名。
-
-### Build
-
-- `bin` 目录下的文件不需要打包，优先使用 Bun 直接运行。
-
-### Change
+- [ ] 当 oxfmt 支持在 monorepo 中为不同的包添加不同的配置之后将其引入。
+- [ ] 当 oxlint `extends` 字段支持指定包产物时，更新所有相关配置。
+- [ ] `change publish` 支持 dry-run 参数。
+- [ ] 规则稳定之后，将其实现为代码。
 
-- 基于 [changesets](https://github.com/changesets/changesets) 做变更管理。
+几乎所有操作都可以理解为对文件的操作，包括但不限于：
 
-## Tool
+- 新增不存在的文件。
+- 检查已存在的文件。
+- 修改已存在的文件。
+- 删除已存在的文件。
 
 ```
-
+bun mono repository init
+bun mono repository check
+bun mono repository correct
+bun mono file check
+bun mono package add --template <template-name>
+bun mono package remove
+bun mono package check
+bun mono package correct
+bun mono typescript check
+bun mono change add
+bun mono change version
+bun mono change publish
 ```
-
-## Todos
-
-- [ ] 当 oxfmt 支持在 monorepo 中为不同的包添加不同的配置之后将其引入。
-- [ ] 当 oxlint `extends` 字段支持指定包产物时，更新所有相关配置。
-- [ ] `change publish` 支持 dry-run 参数。
-- [ ] 规范稳定之后，将其固化为工具。

package/docs/getting-started.md

@@ -0,0 +1,27 @@
+# Getting Started
+
+Mobius Mono 提供包含完整功能的 SDK、包含常用功能的 CLI、包含完整功能的 REPL、包含完整功能的 TUI，下载一个包即可获得前述所有。
+
+```bash
+bun add @planet-matrix/mobius-mono -D
+```
+
+## SDK
+
+```typescript
+import { /* ... */ } from "@planet-matrix/mobius-mono";
+```
+
+## CLI
+
+```bash
+bun mono --help
+```
+
+## REPL
+
+Planning...
+
+## TUI
+
+Planning...

package/docs/mobius-mono-specification.md

@@ -0,0 +1,207 @@
+# Mobius Mono Specification
+
+此文档是 Mobius Mono 规范的文本版本。
+
+此规范的正式名称为 Mobius Mono 规范（zh_CN）、Mobius Mono Specification（en_US）。
+
+## Principles
+
+- 不考虑保障不符合 Mobius Mono 规范的项目的开发体验。
+- 优先使用 TypeScript，并且只在必要的时候转译为 JavaScript。
+- 业务代码中优先使用跨运行时、跨平台兼容的特性。
+- 优先使用 Bun 提供的基础设施（infra）。
+- 优先使用 Oxc 生态系统中的工具。
+- 放弃向后兼容性（backward compatibility），追求工程一致性（engineering consistency）。
+- 追求显式性（explicitness），放弃隐式性（implicitness）。
+
+## Rules
+
+### Repository
+
+- 仓库应该使用 Monorepo，无论有多少个包。
+- 所有包都应该使用 Bun 作为包管理工具（包括 Root Package 在内）。
+- 所有包都应该放在 `packages/` 目录下，不使用二级目录，不对包进行分组管理，仅支持一级包，不支持多级嵌套。
+- 每个包都应该拥有独立的 `package.json`、`README.md`、 `CHANGELOG.md`、`LICENSE` 等文件，Monorepo 只是为了方便管理多个包，并不影响每个包的独立性，每个包都可以独立发布。
+- 所有包名称（`package.json` 中的 `name` 字段）都应该使用相同的前缀，对于组织的包，名称是 `@<organization-name>/<common-prefix>-<package-name>`，对于个人的包，名称是 `<common-prefix>-<package-name>`。
+
+- 仓库根目录一定要有 `.gitignore` 文件。标准的 `.gitignore` 文件内容如下：
+  ```
+  ```
+- 仓库根目录一定要有 `bunfig.toml` 文件。
+- 仓库根目录一定要有 `README.md` 文件。
+- 仓库根目录一定要有 `package.json` 文件。
+- 仓库根目录一定要有 `.vscode/` 目录，且该目录下一定要有 `settings.json` 文件和 `extensions.json` 文件。
+
+### File
+
+- 文件、目录命名格式应使用 kebab-case，约定俗成的文件或目录可以例外，如 `node_modules` 等。
+- 文件、目录命名区分大小写且应该尽可能只使用小写字母，约定俗成的文件或目录可以例外，如 `README.md`、`CHANGELOG.md`、`LICENSE` 等。
+- 文件、目录命名时，表示集合用复数，如 `scripts`、`tests`、`docs` 等，表示概念用单数，如 `dist`、`signal`、`build` 等，约定俗成的文件或目录可以例外，如 `src`、`bin` 等。
+- 文件、目录命名时，尽量避免使用缩写，约定俗成的文件或目录可以例外，如 `src`、`doc` 等。
+
+### Package
+
+- 一定要有 `package.json` 文件。
+- 一定要有 `.npmignore` 文件。
+- 一定要有 `README.md` 文件。
+- 一定要有 `CHANGELOG.md` 文件。
+- 一定要有 `LICENSE` 文件。
+- 一定要有 `tsconfig.json` 文件。
+- 一定要有 `.oxlintrc.json` 文件。
+- ……
+
+### Package Setting
+
+- `package.json` 一定要设置 `name` 字段。
+- `package.json` 一定要设置 `version` 字段。
+- `package.json` 一定要设置 `description` 字段。
+- `package.json` 一定要设置 `keywords` 字段。
+- `package.json` 一定要设置 `homepage` 字段，若没有 Homepage，该字段的值可设置为项目的仓库地址。
+- `package.json` 一定要设置 `bugs` 字段，`bugs` 字段的值一定要是对象，该对象一定要包含 `url` 字段，且 `url` 字段的值一定要是项目的 issue 地址，该对象一定要包含 `email` 字段，且 `email` 字段的值一定要是项目所有者的邮箱地址。
+- `package.json` 一定要设置 `license` 字段。
+- `package.json` 一定要设置 `author` 字段，且 `author` 字段的值一定要是对象，该对象一定要包含 `name` 字段，且 `name` 字段的值一定要是项目所有者的名称，该对象一定要包含 `email` 字段，且 `email` 字段的值一定要是项目所有者的邮箱地址，该对象一定要包含 `url` 字段，且 `url` 字段的值一定要是项目所有者的主页地址。
+- `package.json` 一定要设置 `contributors` 字段。
+- `package.json` 一定不要设置 `files` 字段。
+- `package.json` 一定要设置 `bin` 字段，`bin` 字段的值一定要是对象。
+- `package.json` 一定要设置 `man` 字段，`man` 字段的值一定要是数组。
+- `package.json` 一定要设置 `type` 字段，该字段的值一定要是 `module`，源代码只支持 ES Modules。
+- `package.json` 一定要设置 `exports` 字段，`exports` 字段的值一定要是对象，该对象至少要包含 `.` 字段用于指定包的主要入口文件，且 `.` 字段的值一定要是包含且只包含 `import` 字段的对象（只支持 ES Modules），且 `import` 字段的值一定要是对象，该对象的字段包含且只包含 `@planet-matrix/mobius-mono`、`bun`、`types` 和 `default` 四个字段（顺序一定要与描述一致，虽然 Node.js [推荐](https://nodejs.org/api/packages.html#community-conditions-definitions)总是将 `types` 作为第一个 condition，但 Live TypeScript 追求直接指向 `.ts` 文件，因此将 `types` condition 后移）。示例如下：
+  ```jsonc
+  {
+    // other fields of package.json omitted
+    "exports": {
+      ".": {
+        "import": {
+          "@planet-matrix/mobius-mono": "./src/index.ts",
+          "bun": "./src/index.ts",
+          "types": "./dist/index.d.ts",
+          "default": "./dist/index.js"
+        }
+      },
+      // other subpath omitted
+    },
+    // other fields of package.json omitted
+  }
+  ```
+- `package.json` 一定要设置 `imports` 字段。示例如下：
+  ```jsonc
+  {
+    // other fields of package.json omitted
+    "imports": {
+      "#Project/*": {
+        "import": {
+          "@planet-matrix/mobius-mono": "./*",
+          "bun": "./*",
+          "default": "./*"
+        }
+      },
+      "#Source/*": {
+        "import": {
+          "@planet-matrix/mobius-mono": "./src/*",
+          "bun": "./src/*",
+          "default": "./src/*"
+        }
+      },
+      // other subpath omitted
+    },
+    // other fields of package.json omitted
+  }
+  ```
+- `package.json` 一定不要设置 `main` 字段。
+- `package.json` 一定要设置 `repository` 字段，且 `repository` 字段的值一定要是对象，该对象一定要包含 `type` 字段，且 `type` 字段的值一定要是 `git`，该对象一定要包含 `url` 字段，且 `url` 字段的值一定要是项目的仓库地址，如果该包位于 monorepo 中且该 `package.json` 不位于仓库根目录，该对象一定要包含 `directory` 字段，且 `directory` 字段的值一定要是该包相对于仓库根目录的路径。
+- `package.json` 一定要设置 `scripts` 字段。
+- `package.json` 一定要设置 `dependencies` 字段。
+- `package.json` 一定要设置 `devDependencies` 字段。
+- `package.json` 一定要设置 `peerDependencies` 字段。
+- `package.json` 一定要设置 `peerDependenciesMeta` 字段。
+- `package.json` 一定要设置 `bundleDependencies` 字段。
+- `package.json` 一定要设置 `optionalDependencies` 字段。
+- `package.json` 一定要设置 `overrides` 字段。
+
+### Package Publishing
+
+- 本地发包时，npm token 写在操作者的全局 `.npmrc` 中，CI/CD 发包时，使用 [Trusted publishing](https://docs.npmjs.com/trusted-publishers)。
+- 除敏感文件（含 token 等敏感信息的文件）、临时文件（代码构建时或运行时产生的缓存文件等）、`node_modules` 外，其它所有文件均作为包文件进行发布，所有包都应该使用 `.npmignore` 文件来排除不需要发布的文件。标准的 `.npmignore` 文件内容如下：
+  ```
+  # Mobius Mono ignores
+  .env/*
+  .env
+  .env.*
+
+  # npm default ignores
+
+  ## OS / Editor
+  *.orig
+  .*.swp
+  .DS_Store
+  ._*
+
+  ## VCS
+  .git
+  .hg
+  .svn
+  CVS
+
+  ## Node
+  node_modules
+  npm-debug.log
+
+  ## Lock files (for libraries)
+  package-lock.json
+  pnpm-lock.yaml
+  yarn.lock
+  bun.lockb
+
+  ## npm
+  .npmrc
+
+  ## Build
+  .lock-wscript
+  .wafpickle-N
+  config.gypi
+  ```
+
+### TypeScript
+
+- 仅将 TypeScript（此处不是指作为语言的 TypeScript，而是指配套的库或工具）作为提升开发体验的工具使用，将类型文件输出、代码转译等工作交给其它工具来完成。
+- TypeScript 配置尽量与 Bun 的推荐配置保持一致，见：https://bun.com/docs/typescript。
+
+- 将 `compilerOptions.allowImportingTsExtensions` 设置为 `true`，导入任意文件都一定要包含文件扩展名。
+- 将 `@planet-matrix/mobius-mono` 设置为 `compilerOptions.customConditions` 的第一项，遵循 Mobius Mono 规范的项目会将 `@planet-matrix/mobius-mono` 作为 conditional exports 的第一个 condition，从而实现 Live TypeScript（aka. Live Types）。
+- 将 `compilerOptions.module` 设置为 `preserve`，虽然我们不使用 TypeScript 来转译代码，但设置这个字段有助于 TypeScript 正确处理类型，从而提升开发体验。
+- 将 `compilerOptions.moduleResolution` 设置为 `bundler`，从而让 TypeScript 可以正确消费 `package.json` 中的 `imports` 和 `exports` 字段。
+- 将 `compilerOptions.noUncheckedSideEffectImports` 设置为 `true`，从而让 TypeScript 严格检查所有的副作用导入语句，避免导入不存在的模块。
+- 将 `compilerOptions.paths` 设置为 `{}`（即不使用该功能），使用 [subpath imports](https://nodejs.org/api/packages.html#subpath-imports) 作为替代方案，后者被 Node.js、Bun 等运行时原生支持，且在 `package.json` 中进行定义可以更加显式地体现包的情况。
+- 将 `compilerOptions.resolveJsonModule` 设置为 `true`，从而允许导入 JSON 文件。
+- 将 `compilerOptions.resolvePackageJsonExports` 设置为 `true`，从而让 TypeScript 可以正确消费 `package.json` 中的 `exports` 字段。
+- 将 `compilerOptions.resolvePackageJsonImports` 设置为 `true`，从而让 TypeScript 可以正确消费 `package.json` 中的 `imports` 字段。
+- 将 `compilerOptions.rewriteRelativeImportExtensions` 设置为 `false`，我们不使用 TypeScript 来转译代码，开启该选项会产生额外的报错，如 `This import uses a '.ts' extension to resolve to an input TypeScript file, but will not be rewritten during emit because it is not a relative path.`。
+- 将 `compilerOptions.typeRoots` 设置为 `["${configDir}/node_modules/@types"]`，从而让 TypeScript 只消费项目直接依赖的类型定义文件。
+- 将 `compilerOptions.types` 字段注释，否则 `compilerOptions.typeRoots` 不会生效。
+- 将 `compilerOptions.noEmit` 设置为 `true`，原因之一是我们不使用 TypeScript 来转译代码，原因之二是我们开启了 `compilerOptions.allowImportingTsExtensions`，开启该选项要求 `either --noEmit or --emitDeclarationOnly to be set`。
+- 将 `compilerOptions.forceConsistentCasingInFileNames` 设置为 `true`。
+- 将 `compilerOptions.isolatedDeclarations` 设置为 `true`。
+- 将 `compilerOptions.isolateModules` 设置为 `true`。
+- 将 `compilerOptions.verbatimModuleSyntax` 设置为 `true`。
+- 将 `compilerOptions.lib` 设置为 `["ESNext", "DOM", "WebWorker", "ScriptHost"]`，即默认启用所有不同运行环境的 API，以保持开发体验的一致性，正确性和跨平台兼容性由代码来保障。
+- 将 `compilerOptions.moduleDetection` 设置为 `force`，即要求尽可能将所有代码编写成模块。
+- 将 `compilerOptions.noLib` 设置为 `false`。
+- 将 `compilerOptions.target` 设置为 `esnext`，即拥抱最新的 JavaScript 特性。
+
+### Lint
+
+- 将 Formatting 视为 Linting 的一部分。
+- 使用 Oxlint 作为 Lint 工具。
+- 使用 Oxfmt 作为 Format 工具。
+
+- import 任意文件都一定要包含文件扩展名。
+
+### Build
+
+- `bin` 目录下的文件不需要打包，优先使用 Bun 直接运行。
+- 打包产物只支持 ES Modules。
+
+### Change
+
+- 基于 [changesets](https://github.com/changesets/changesets) 做变更管理。
+- 仓库根目录一定要有 `.changeset/` 目录，且该目录下一定要有 `README.md` 文件和 `config.json` 文件。

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@planet-matrix/mobius-mono",
-  "version": "0.4.2",
-  "description": "Mobius Mono 是一个用于规范项目的项目，由规范文本（Specification）、配套工具（Tool）组成。",
+  "version": "0.5.0",
+  "description": "Mobius Mono 是一个用于对项目开发进行规范的项目，目标是将项目开发中与核心业务逻辑无关的部分全部标准化，一方面开发者可以专注于业务逻辑的开发，另一方面不同项目可以共享相同的基础设施，从而提升整体的开发体验、协同效率和交付质量。同时，清晰明确的规范也能够提高人与 AI 协同开发或全 AI 驱动开发的效率和质量。",
   "keywords": [
     "mobius",
     "monorepo"
@@ -18,9 +18,6 @@
     "url": "https://github.com/kongxiangyan"
   },
   "contributors": [],
-  "files": [
-    "*"
-  ],
   "bin": {
     "mono": "./src/app/index.ts"
   },
@@ -72,9 +69,9 @@
   "devDependencies": {
     "@types/bun": "^1.3.5",
     "@types/node": "^25.0.3",
-    "oxlint": "^1.36.0",
+    "oxlint": "^1.37.0",
     "oxlint-tsgolint": "^0.10.1",
-    "oxfmt": "^0.21.0",
+    "oxfmt": "^0.22.0",
     "typescript": "^5.9.0",
     "@typescript/native-preview": "^7.0.0-dev.20260101.1"
   },