alex-c-line
这是我的命令行工具,它作为开发人员工具包,可以在任何存储库中使用,以简化开发人员的工作流程。它提供了一个灵活的配置系统,因此您可以自定义其行为以匹配您的工作流程。
alex-c-line 它被设计为开发人员优先,在重要的地方固执己见,并且在默认情况下是安全的,特别是在更改存储库状态时。
安装
要安装命令行工具,您可以在每个工作存储库本地使用以下命令:
npm install alex-c-line
npm 可以用您选择的包管理器替换。
或者,您可以全局安装它,以便在整个系统中,在任何工作存储库中使用它。这将允许您随后使用 alex-c-line 在不一定直接支持它的存储库中,因此您仍然可以感受到一些与上下文无关的命令的好处。
npm install -g alex-c-line
快速启动
你可以通过输入来使用任何命令 alex-c-line 在终端中,后跟要运行的命令。例如:
alex-c-line say-hello
有些命令甚至可能需要额外的参数。例如:
alex-c-line version increment v1.2.3 major
标志也可以通过以下方式传递。
alex-c-line version increment v1.2.3 major --no-prefix
请注意 local-package use 具体来说,您需要添加 -- 在当地之前 alex-c-line 参数,以确保正确传递所有标志。例子:
alex-c-line local-package use alex-c-line -- version increment v1.2.3 major --no-prefix
配置
有些命令还支持使用config系统。例如, pre-commit 支持 alex-c-line.config.js 文件, local-package use 支持更具体的用户 .alex-c-line.private.config.js 文件。 alex-c-line.config.js 用于每个存储库的共享配置,而 .alex-c-line.private.config.js 用于特定于用户使用的配置。
这个 configs Subpath提供了一些在构造这些配置时可能有用的辅助函数和类型。也就是说, defineAlexCLineConfig 可以用作类型帮助器,以便在编辑器中获得更好的类型提示。
import { defineAlexCLineConfig } from "alex-c-line/configs";
export default defineAlexCLineConfig({
template: {
pullRequest: {
category: "general",
projectType: "package",
}
},
preCommit: {
packageManager: "pnpm",
steps: ["build", "format", "lint", "test"],
},
})
或者,你可以创建一个TypeScript文件,然后将其构建为一个纯JavaScript文件,这样做的好处是你可以直接使用类型,这可能更好,因为它甚至在预提交步骤中使用类型参数。
import type { AlexCLineConfig } from "alex-c-line/configs";
import { scripts } from "./package.json" with { type: "json" };
const alexCLineConfig: AlexCLineConfig<keyof typeof scripts> = {
template: {
pullRequest: {
category: "general",
projectType: "package",
}
},
preCommit: {
packageManager: "pnpm",
steps: ["build", "format", "lint", "test"],
},
};
export default alexCLineConfig;
不过请注意,我们还不支持直接用TypeScript运行配置文件。这可能会在不久的将来计划,但现在,将纯TypeScript文件构建为纯JavaScript,并将其用作配置文件是目前最好的选择。
私有配置可以用同样的方式处理,除了类型是 AlexCLinePrivateConfig,函数 defineAlexCLinePrivateConfig. 还请注意,如果您在共享存储库中创建私有配置,则必须将其添加到 .gitignore 这样它就可以保持用户特定,而不会被包含在版本控制中。
文档
一个完整的文档网站即将推出。与此同时,你可以逃跑 alex-c-line --help 有关如何使用所有命令的详细信息。
官方的 alex-c-line 主题曲
这是官方的歌词视频 alex-c-line 主题曲:
