@142vip/utils
Version:
通用型基础工具集合,对常用模块的二次集成
173 lines (165 loc) • 3.71 kB
TypeScript
interface CliCommandBaseOptions {
/**
* 试运行
*/
dryRun?: boolean;
/**
* 142vip 组织专用功能,用户标记是否用于142vip组织的项目
*/
vip?: boolean;
/**
* 是否开启日志追踪模式,打印重要执行日志
*/
logger?: boolean;
}
declare enum CpuArchitectureEnum {
LINUX_ARM = "linux/arm64",
LINUX_AMD = "linux/amd64"
}
/**
* CLI exit codes.
* @see https://nodejs.org/api/process.html#process_exit_codes
*/
declare enum ProcessExitCodeEnum {
/**
* 正常退出
*/
SUCCESS = 0,
/**
* 程序异常退出
*/
FatalError = 1,
UsageError = 2,
ParseError = 3,
InternalError = 4,
IOError = 5,
PermissionError = 6,
ConfigError = 7,
DependencyError = 8,
InvalidArgument = 9,
TimeoutError = 10
}
/**
* Git提交信息
*/
interface GitInfo {
hash: string;
message: string;
}
/**
* git commit解析
* - 提交类型
* - 提交范围
* - 提交信息
*/
interface GitCommit {
/**
* 提交类型
*/
type: string;
/**
* 提交范围
*/
scope?: string;
/**
* 提交信息
*/
subject?: string;
}
/**
* 常用分支
*/
declare enum GitGeneralBranch {
MAIN = "main",
NEXT = "next",
MASTER = "master"
}
/**
* 状态码
*/
declare enum HttpStatus {
CONTINUE = 100,
SWITCHING_PROTOCOLS = 101,
PROCESSING = 102,
EARLY_HINTS = 103,
OK = 200,
CREATED = 201,
ACCEPTED = 202,
NON_AUTHORITATIVE_INFORMATION = 203,
NO_CONTENT = 204,
RESET_CONTENT = 205,
PARTIAL_CONTENT = 206,
AMBIGUOUS = 300,
MOVED_PERMANENTLY = 301,
FOUND = 302,
SEE_OTHER = 303,
NOT_MODIFIED = 304,
TEMPORARY_REDIRECT = 307,
PERMANENT_REDIRECT = 308,
BAD_REQUEST = 400,
UNAUTHORIZED = 401,
PAYMENT_REQUIRED = 402,
FORBIDDEN = 403,
NOT_FOUND = 404,
METHOD_NOT_ALLOWED = 405,
NOT_ACCEPTABLE = 406,
PROXY_AUTHENTICATION_REQUIRED = 407,
REQUEST_TIMEOUT = 408,
CONFLICT = 409,
GONE = 410,
LENGTH_REQUIRED = 411,
PRECONDITION_FAILED = 412,
PAYLOAD_TOO_LARGE = 413,
URI_TOO_LONG = 414,
UNSUPPORTED_MEDIA_TYPE = 415,
REQUESTED_RANGE_NOT_SATISFIABLE = 416,
EXPECTATION_FAILED = 417,
I_AM_A_TEAPOT = 418,
MISDIRECTED = 421,
UNPROCESSABLE_ENTITY = 422,
FAILED_DEPENDENCY = 424,
PRECONDITION_REQUIRED = 428,
TOO_MANY_REQUESTS = 429,
INTERNAL_SERVER_ERROR = 500,
NOT_IMPLEMENTED = 501,
BAD_GATEWAY = 502,
SERVICE_UNAVAILABLE = 503,
GATEWAY_TIMEOUT = 504,
HTTP_VERSION_NOT_SUPPORTED = 505
}
/**
* 路由类型枚举
* - 请求方法
*/
declare enum HttpMethod {
GET = "GET",
POST = "POST",
PUT = "PUT",
DELETE = "DELETE",
PATCH = "PATCH",
OPTIONS = "OPTIONS",
HEAD = "HEAD",
ALL = "ALL"
}
declare enum RegistryAddressEnum {
DOCKER = "https://registry.cn-hangzhou.aliyuncs.com",
NPM = "https://registry.npmjs.org",
VIP_DOCKER = "registry.cn-hangzhou.aliyuncs.com",
VIP_NPM = "https://registry.142vip.com",
VIP_NPM_ALIBABA = "https://registry.npmmirror.com",
VIP_NPM_TENCENT = "https://mirrors.tencent.com/npm/"
}
/**
* 发布的版本类型
*/
declare enum ReleaseVersionTypeEnum {
MAJOR = "major",
PRE_MAJOR = "premajor",
MINOR = "minor",
PRE_MINOR = "preminor",
PATCH = "patch",
PRE_PATCH = "prepatch",
PRE_RELEASE = "prerelease",
NEXT = "next"
}
export { type CliCommandBaseOptions, CpuArchitectureEnum, type GitCommit, GitGeneralBranch, type GitInfo, HttpMethod, HttpStatus, ProcessExitCodeEnum, RegistryAddressEnum, ReleaseVersionTypeEnum };