@toruslabs / torus-scripts
库、React和Node包的Vite+配置片段。预设不安装框架构建插件。
安装
安装 @toruslabs/torus-scripts 和 vite-plus 在你的项目中。
建立预设
@toruslabs/torus-scripts/library:libraryPreset({ entry: "src/index.ts" })用于构建ESM库。@toruslabs/torus-scripts/react:reactPreset()选择自动JSX运行时。添加@vitejs/plugin-react用于快速刷新或其转换。@toruslabs/torus-scripts/node:nodePreset({ entry: "src/index.ts" })以Node为目标,并保持依赖关系在外部。对装饰器元数据使用单独的构建。
编译Vue单文件组件 @vitejs/plugin-vue 在你的项目中。使用 libraryPreset({ entry: "src/index.ts" }) 为了族群。
这些片段不设置CSS注入、浏览器目标、资产、SSR转换等 use client。在项目中设置这些选项。
格式
formatPreset() 是在 @toruslabs/torus-scripts/fmt。它设置150列、双引号、分号、ES5尾随逗号和导入排序。它不会对导出进行排序。
import { formatPreset } from "@toruslabs/torus-scripts/fmt";
import { defineConfig } from "vite-plus";
export default defineConfig({ fmt: formatPreset() });
线头
安装其中之一 @toruslabs/oxlint-config-typescript, @toruslabs/oxlint-config-react, @toruslabs/oxlint-config-vue,或者 @toruslabs/oxlint-config-node。TypeScript预设同时检查JavaScript和TypeScript。React、Vue和Node扩展了它。这个包不能导出 /lint 或者 /vue-lint.
Vue预设只启用Vize模板规则 vueTemplateRules,并且夹具测试证明了每一个。它使用了Vize Oxlint插件 vp lint 和 vp check。这些命令可以跳过a .vue 没有的文件 <script> 块,因此它们不检查仅模板文件。预设是原生的 no-unused-vars 选项报告未使用的参数和捕获的错误 .ts 文件,但 vp lint 不报那条规则为 .vue 脚本块。对这些差距进行单独检查,并在项目中进行验证。
React和Vue各自导出一个可选选项 tailwindLintPreset({ entryPoint: "src/styles.css" }) 片段。安装 oxlint-tailwindcss 如果你使用这个片段。Vue项目从 @toruslabs/oxlint-config-vue,而不是React包。
不要将片段和框架预设与普通对象展开组合在一起。 { ...vueLintPreset(), ...tailwindLintPreset({ entryPoint }) } 替换 jsPlugins, rules, settings。这将删除大小规则和 oxlint-plugin-vize,或者React Hooks规则,而lint仍然可以退出0。合并每个字段:
import { tailwindLintPreset, vueLintPreset } from "@toruslabs/oxlint-config-vue";
import { defineConfig } from "vite-plus";
const framework = vueLintPreset();
const tailwind = tailwindLintPreset({ entryPoint: "src/styles.css" });
export default defineConfig({
lint: {
...framework,
jsPlugins: [...(framework.jsPlugins ?? []), ...(tailwind.jsPlugins ?? [])],
rules: { ...framework.rules, ...tailwind.rules },
settings: { ...framework.settings, ...tailwind.settings },
},
});
对于React,导入 reactLintPreset 和 tailwindLintPreset 从 @toruslabs/oxlint-config-react 并合并相同的字段。顺风类检查运行在JS、TS、JSX和TSX上,包括支持的Vue脚本块;它们不检查Vue模板类或CSS文件。
旧的 @toruslabs/eslint-config-* 包被移除。不要把Oxlint规则等同于旧的ESLint规则,直到你在项目中测试它。
从旧的CLI升级
该套餐包括代理技能 skills/migrating-to-torus-cli/SKILL.md。在消费者项目中,请在 node_modules/@toruslabs/torus-scripts/skills/migrating-to-torus-cli/SKILL.md。若要使其在光标中作为项目技能可用,请将其复制到 .cursor/skills/migrating-to-torus-cli/SKILL.md 在那个项目中。保持技能和这个README来自同一个包版本。
运行 torus-scripts-upgrade <path> 在不更改文件的情况下检查旧项目。它报告不支持的自定义行为,并在这些情况下退出非零。运行 vp migrate 在工作空间根目录,而不是在每个包中,并检查其更改。诊断程序未运行 vp migrate 给你。
替换旧命令:
torus-scripts build→定义pack在消费者的vite.config.ts,然后跑vp pack.torus-scripts lint→选择Oxlint包,设置rootlint和fmt配置,然后运行vp check.torus-scripts start→设置用户的Vite+ dev任务。没有共享的开发服务器船。torus-scripts release→在存储库根目录下使用变更集。- Lerna工作区任务→运行
vp run -r build使用显式构建任务。
打印稿概要文件
@toruslabs/config 出口 tsconfig.base.json, tsconfig.library.json, tsconfig.node.json。取代 tsconfig.default.json 或者 tsconfig.build.json 具有匹配的配置文件。