UNPKG

appbir

Version:

常用脚手架库 -【app-lib-cli】

211 lines (179 loc) 16.1 kB
<!-------------------------------common start flag-------------------------> <center> <div align="center"> <h1>常用脚手架库-【app-lib-cli】</h1> <a href="https://img.shields.io/badge/success: https local reason - goback refresh you brower can show badge image now-brightgree" title="click can show badge"> <img src="https://appbir.github.io/appbir-resource-statics/image/logo.png" height="60" /> </a> <h1>appbir</h1> <a href="https://appbir/library"> <img src="https://img.shields.io/badge/appbir-library-blue"/> </a> <a href="https://appbir/library/-/web/detail/appbir"> <img src="https://img.shields.io/badge/npm-v1.0.2-green"> </a> <a href="https://appbir"> <img src="https://img.shields.io/badge/license-ISC-brightgree"/> </a> <div> </center> <!-------------------------------common end flag---------------------------> <!-------------------------------background start flag---------------------> # 一、背景介绍 * 个人工作更高效,重复的事情让脚本去做1。 <!-------------------------------background end flag-----------------------> <!-------------------------------functions start flag----------------------> # 二、功能描述 <!-------------------------------functions end flag------------------------> <!-------------------------------attention start flag----------------------> # 三、注意事项 1. 第一次开发的时候或者重新安装nodemodules > 需要copy asset资源到安装的node_modules目录的bin下才能正常执行名 1. 类的方法输出 在md中不能呈现 在doc/html文档中可以 <!-------------------------------attention end flag------------------------> <!-------------------------------examples start flag-----------------------> # 四、使用案列 运行appbir查看支持的命令 ``` info usage [ appbir --help ] , show support commond > ┌─────────┬──────────┬────────────────────────┬────────┬───────────┬───────────────────┐ │ (index) │ commond │ see commond helpenabletype │ discription │ ├─────────┼──────────┼────────────────────────┼────────┼───────────┼───────────────────┤ │ 0 │ 'plugin''appbir plugin --help'true'package''//TODO 插件管理' │ │ 1 │ 'git''appbir git --help'true'package''GIT操作' │ │ 2 │ 'build''appbir build --help'true'package''构建编译' │ │ 3 │ 'md''appbir md --help'true'package''markdown编译' │ │ 4 │ 'run''appbir run --help'true'package''自定义命令' │ │ 5 │ 'server''appbir server --help'true'package''启动服务' │ │ 6 │ 'init''appbir init --help'true'package''初始工程' │ │ 7 │ 'doc''appbir doc --help'true'package''API文档' │ └─────────┴──────────┴────────────────────────┴────────┴───────────┴───────────────────┘ info usage [appbir run xxx] ,support convenient commond > ┌─────────┬───────────────────────────┬───────────────────────────────────────────────────────────────┐ │ (index) │ run commond │ exeute run coommond detail │ ├─────────┼───────────────────────────┼───────────────────────────────────────────────────────────────┤ │ 0 │ 'appbir run dev''server-es' │ │ 1 │ 'appbir run start''server-es' │ │ 2 │ 'appbir run build''build-es' │ │ 3 │ 'appbir run doc''doc-nov' │ │ 4 │ 'appbir run example''exp-es' │ │ 5 │ 'appbir run example-node''exp-node' │ │ 6 │ 'appbir run git''git-submit' │ │ 7 │ 'appbir run gits''git-submits' │ │ 8 │ 'appbir run pub''pub-es' │ │ 9 │ 'appbir run unpub''npm-unpub ' │ │ 10 │ 'appbir run pub-es''build-es & md-pkg & md-log & doc & md-api & npm-pub & git' │ │ 11 │ 'appbir run pub-bin''build-bin & md-pkg & md-log & doc & md-api & npm-pub & git' │ │ 12 │ 'appbir run pub-node''build-node & md-pkg & md-log & doc & md-api & npm-pub & git' │ │ 13 │ 'appbir run doc-nov''doc es -r -f' │ │ 14 │ 'appbir run dov-ver''doc es -r -f -p' │ │ 15 │ 'appbir run server''server -p 8888' │ │ 16 │ 'appbir run server-es''server -p 8888' │ │ 17 │ 'appbir run server-bin''npm bin' │ │ 18 │ 'appbir run server-node''npm node' │ │ 19 │ 'appbir run exp-es''server -p 8888 --model example' │ │ 20 │ 'appbir run exp-node''node ./example/node/index.js' │ │ 21 │ 'appbir run build-es''build-static & b-e' │ │ 22 │ 'appbir run build-bin''build-static & b-b' │ │ 23 │ 'appbir run build-node''build-static & b-n' │ │ 24 │ 'appbir run build-static''build static' │ │ 25 │ 'appbir run static''build static' │ │ 26 │ 'appbir run b-e-u00''build es -t umd' │ │ 27 │ 'appbir run b-e-u01''build es -t umd -min' │ │ 28 │ 'appbir run b-e-u10''build es -t umd -b' │ │ 29 │ 'appbir run b-e-u11''build es -t umd -b -min' │ │ 30 │ 'appbir run b-e-u''b-e-u00 & b-e-u01 & b-e-u10 & b-e-u11' │ │ 31 │ 'appbir run b-e-c00''build es -t commonjs' │ │ 32 │ 'appbir run b-e-c01''build es -t commonjs -min' │ │ 33 │ 'appbir run b-e-c10''build es -t commonjs -b' │ │ 34 │ 'appbir run b-e-c11''build es -t commonjs -b -min' │ │ 35 │ 'appbir run b-e-c''b-e-c00 & b-e-c01 & b-e-c10 & b-e-c11' │ │ 36 │ 'appbir run b-e-w00''build es -t window' │ │ 37 │ 'appbir run b-e-w01''build es -t window -min' │ │ 38 │ 'appbir run b-e-w10''build es -t window -b' │ │ 39 │ 'appbir run b-e-w11''build es -t window -b -min' │ │ 40 │ 'appbir run b-e-w''b-e-w00 & b-e-w01 & b-e-w10 & b-e-w11' │ │ 41 │ 'appbir run b-e''b-e-u & b-e-c & b-e-w' │ │ 42 │ 'appbir run b-n-u00''build node -t umd' │ │ 43 │ 'appbir run b-n-u01''build node -t umd -min' │ │ 44 │ 'appbir run b-n-u10''build node -t umd -b' │ │ 45 │ 'appbir run b-n-u11''build node -t umd -b -min' │ │ 46 │ 'appbir run b-n-u''b-n-u00 & b-n-u01 & b-n-u10 & b-n-u11' │ │ 47 │ 'appbir run b-n-c00''build node -t commonjs' │ │ 48 │ 'appbir run b-n-c01''build node -t commonjs -min' │ │ 49 │ 'appbir run b-n-c10''build node -t commonjs -b' │ │ 50 │ 'appbir run b-n-c11''build node -t commonjs -b -min' │ │ 51 │ 'appbir run b-n-c''b-n-c00 & b-n-c01 & b-n-c10 & b-n-c11' │ │ 52 │ 'appbir run b-n''b-n-u & b-n-c' │ │ 53 │ 'appbir run b-b-u00''build bin -t umd' │ │ 54 │ 'appbir run b-b-u01''build bin -t umd -min' │ │ 55 │ 'appbir run b-b-u10''build bin -t umd -b' │ │ 56 │ 'appbir run b-b-u11''build bin -t umd -b -min' │ │ 57 │ 'appbir run b-b-u''b-b-u00 & b-b-u01 & b-b-u10 & b-b-u11' │ │ 58 │ 'appbir run b-b-c00''build bin -t commonjs' │ │ 59 │ 'appbir run b-b-c01''build bin -t commonjs -min' │ │ 60 │ 'appbir run b-b-c10''build bin -t commonjs -b' │ │ 61 │ 'appbir run b-b-c11''build bin -t commonjs -b -min' │ │ 62 │ 'appbir run b-b-c''b-b-c00 & b-b-c01 & b-b-c10 & b-b-c11' │ │ 63 │ 'appbir run b-b''b-b-u & b-b-c' │ │ 64 │ 'appbir run md-api''md appendApi' │ │ 65 │ 'appbir run md-pkg''md autoPackage' │ │ 66 │ 'appbir run md-log''md appendChangeLog' │ │ 67 │ 'appbir run git-submit''git submit' │ │ 68 │ 'appbir run git-submits''git submits' │ │ 69 │ 'appbir run git-deletes''git deletes' │ │ 70 │ 'appbir run init''init' │ │ 71 │ 'appbir run npm-pub''npm publish' │ │ 72 │ 'appbir run npm-unpub''`npm unpublish ${arg1} --force`' │ │ 73 │ 'appbir run npm-i''npm i' │ │ 74 │ 'appbir run test''echo test' │ └─────────┴───────────────────────────┴───────────────────────────────────────────────────────────────┘ info usage [appbir tool xxx] ,support tool commond > ┌─────────┬────────────┬─────────────────────────────────┬────────────────────────────┐ │ (index) │ toolName │ description │ arg help │ ├─────────┼────────────┼─────────────────────────────────┼────────────────────────────┤ │ 0 │ 'iphone''backup iphone image or video''appbir tool ls iphone ' │ │ 1 │ 'template''description // to description''appbir tool ls template ' │ └─────────┴────────────┴─────────────────────────────────┴────────────────────────────┘ ``` <!-------------------------------examples end flag-------------------------> <!-------------------------------todo start flag---------------------------> # 五、todo列表 1. 文档生成支持指定文件 > 支持指定文件和追加文档 1: git 命令支持切换git url地址 // 快速切换url * 目前记住vscode编辑器 直接替换 .git 目录下的所有url地址 * 例如 ``` git@git.zhlh6.cn git@github.com ``` 2: 支持扩展config或者exe命令 ``` 扩展格式: { name: "执行命令的名称", // appbir run xxx script: "./server-markdown-badge-node/src/server.js", // js脚本 或者 windows 二进制文件 或者bat脚本等文件 cwd: './server-markdown-badge-node/src', // 配置相对路径 执行的相对路径 aync:false, // 同步还是异步 }, ``` 3. 添加值初始化md和git的常常规工程 <!-------------------------------todo end flag-----------------------------> <!-------------------------------api start flag----------------------------> # 六、API <a name="test"></a> ## test(a) ⇒ 测试文档 **Kind**: global function **Returns**: asad | Param | Type | Description | | --- | --- | --- | | a | <code>string</code> | sass | <!-------------------------------api end flag------------------------------> <!-------------------------------change logs begin flag---------------------> # 七、发布日志 * [2023-12-28 11-23-03]-发布组件 * [2023-11-05 05-54-48]-发布组件 * 插件化版本 <!-------------------------------change logs end flag----------------------->