ts-rc-cli v1.0.0-alpha.9
ts-rc-cli
命令行工具
ts-rc
命令, 例子: ts-rc dev
指令 | 说明 | 参数 |
---|---|---|
create | 创建模板项目 | name(非必须) |
add-template, -at | 添加模板 | gitUrl, name(非必须) |
remove-template, -rt | 删除本地模板 | name(非必须) |
dev | 启动本地服务 | ...env |
build | 执行编译脚本 | ...env |
get-config | 编译 config 文件 | - |
help, -h | 显示帮助 | - |
快速开始
全局安装脚手架
npm i -g ts-rc-cli
# or
yarn global add ts-rc-cli
通过模板快速创建项目
ts-rc create
启动 dev 本地开发服务
yarn dev
# or
npm run dev
生产编译
yarn build
# or
npm run build
自定义配置
创建 config/index.ts
文件
chestnut:
import path from 'path'
import { ReactTsConfigPartial } from 'ts-rc-cli'
const rootPath = process.cwd()
const projectName = 'new-project'
const projectTitle = 'New Project'
const config: ReactTsConfigPartial = {
projectName,
projectTitle,
port: 18081,
htmlOptions: {
template: path.resolve(rootPath, 'src/index.html'),
},
devServerOptions: {
publicPath: '',
},
entry: {
app: path.resolve(rootPath, 'src/index.tsx'),
},
}
export default config
⚠ 注意: config
使用的 tsconfig
是独立的, 如下所示
[
"-m commonjs",
"-t es6",
"--moduleResolution node",
"--resolveJsonModule true",
"--esModuleInterop true",
"--allowSyntheticDefaultImports true",
"--suppressImplicitAnyIndexErrors true",
"--skipLibCheck true",
"--types node",
"--lib esnext,scripthost,es5",
"--outDir ${outPath}"
]
项目根目录需要添加 tsconfig.json
文件.
此外,请按需添加 .eslintignore
, .eslintrc.js
, .browserslistrc
文件.
脚本将自动读取 config
下的配置文件
集成 cross-env
集成了 cross-env, 可以直接添加环境变量:
ts-rc-dev MY_ENV=xxx
ts-rc-build MY_ENV=xxx
默认配置
在 config.d.ts 中查看全部默认配置
- 在生产环境中默认移除了
console.log
, 可以在terserOptions
中修改 @
是src
的别名- 默认
dev-server
端口号:18080
- 默认入口文件:
src/main.ts
- 默认构建环境:
mock
|dev
|prod
环境变量
变量名 | 说明 | 类型 | 默认值 |
---|---|---|---|
CONFIG_PATH | 配置文件路径 | string | config/index.ts |
NODE_ENV | Node 参数 | development/production | auto |
BUILD_ENV | 构建参数 | keyOf ReactTsConfig'env' | dev |
模板开发文档
TODO...
源代码相关
子模块
初始化子模块
git submodule init
拉取子模块
git submodule update
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago