目錄
- 資源鏈接
- 基礎命令
- 模板創建
- 命令幫助
- 選擇模板
- 開始創建
- 開發模板
- 開發背景
- npm 發布流程
- 問題記錄
- 模板創建超時
- 更新日志
資源鏈接
文檔:https://ty.cli.vrteam.top/
源碼:https://github.com/bosombaby/ty-cli
基礎命令
1. npm 全局安裝
npm i ty-cli-market -g2. 快捷鍵 ty/ty-cli3. 幫助命令 ty -h
Usage: ty-cli <command> [options]A simple CLI tool for string manipulationOptions:
-V, --version output the version number
-h, --help display help for commandCommands:
create [options] <project-name> create a new project
help [command] display help for commandRun ty-cli <command> --help for detailed usage of given command.4. 版本查看 ty -V
1.1.0
模板創建
create 命令也就是腳手架的核心指令,用來選擇不同的執行模板并下載
- 配置命令的基本信息
- 解析后面的 options 響應參數
- 存在 force 參數,直接下載
- 不存在 force 參數,判斷是否有重名的模板,給用戶選擇是否覆蓋
- 退出本次操作
- 覆蓋當前文件
- 一步步確認模板的類型
- github 拉取項目信息
- 下載模板到本地
- yarn run build
命令幫助
選擇模板
開始創建
開發模板
當前是小程序的開發模板,具體模板使用說明可以查看相關文檔。
開發背景
目前團隊內部后臺管理系統過多,需求開發的頁面邏輯或者相關組件重復率過高,跨項目開發很容易遇到重復編寫大量代碼、不同項目的技術棧/版本不統一、相關樣式不統一等問題,迫切需要一款標準化、高擴展、簡單便捷的腳手架工具來協助開發。
該工具要求具備的核心能力如下:
- 命令行運行,多種配置可選,可自定義
- 配色方案、核心布局、組件、方法、hooks、http 請求封裝完備
- 設計高擴展性,同程內部的工具鏈路完備
npm 發布流程
1. 切換鏡像源到 npm 原生
npm config get registry
npm config set registry https://registry.npmjs.org/2. npm login 登錄(瀏覽器打開鏈接登錄)3. npm publih 發布(注意不要重名、登錄問題)4. 切換回到淘寶鏡像源
npm config set registry https://registry.npmmirror.com
這里注意發布 npm 需要先進行登錄,登錄發布時需要明確包名稱和版本號的唯一性。
問題記錄
模板創建超時
Git 客戶端無法在指定的時間內連接到 GitHub 服務器上的 443 端口
取消全局 Git 配置中設置的 HTTPS 代理服務器
git config --global --unset http.proxy
git config --global --unset https.proxy
更新日志
- 2024-6-30 V1.0.0 第一版上線
- 2024-7-1 后續 create 命令優化
- 2024-7-3 說明文檔 V1.0.1
- 2024-7-8 GitHub API 權限認證 V1.1.0
- 2024-7-9 https://ty.cli.vrteam.top/ 文檔完善
- GitHub 會有網絡問題,后續整體遷移到 GitLab
- 模板定制化選擇,維度包括:語言版本、組件庫、功能細分
- 后臺管理系統模板優化開發