# hjm-cli

**Repository Path**: hjmeng/hjm-cli

## Basic Information

- **Project Name**: hjm-cli
- **Description**: npm 初始化仓库脚手架
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-25
- **Last Updated**: 2021-05-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# hjm-cli

## 介绍

1. 一个初始化项目的脚手架
1. 目前支持
    1. npm 包的初始化 [npm-init](https://gitee.com/hjmeng/npm-init)
    2. 机器人模板初始化 [robot-init](https://gitee.com/hjmeng/robot-init)
1. 以后可能作为初始化以及解放自己双手用

## 软件架构

```sh
.
├── bin               # 脚本运行入口
│   └── hjm           # 命令行
├── commands          # cmd命令脚本逻辑
│   ├── robot             # 机器人相关脚本文件
│   │   └── init.ts      # 命令 hjm robot:init 脚本
│   ├── npm             # npm相关脚本文件
│   │   └── init.ts      # 命令 hjm npm:init 脚本
│   └── basics.ts       # 脚本基础类
├── src                         # 源文件
│   └── index.ts
├── config                # 项目配置文件
├── doc                   # 技术文档
├── plan                  # 开发计划
├── tests                 # 测试文件
└── README.md             # 说明文件

```

### 安装教程

```shell

git clone https://gitee.com/hjmeng/hjm-cli.git   # 克隆项目到本地

cd hjm-cli                                       # 进入项目根目录

npm i                                                 # 安装包依赖

```

### 启动脚本

```shell

#------------- cmd --------------#
# 注意: 将仓库中的文件全部移动到根目录 中的路径改一下以免覆盖当前仓库文件内容
# shell.exec(`cp -R ./npm-init/ ./hjm`);    // step4: 将仓库中的文件全部移动到根目录

npm run npm:init     # 测试 hjm npm:init cmd

#------------- lint --------------#
npm run lint         # 启动lint检测

npm run lint:fix     # 启动lint修复

```

### 发布包

```shell
#------------发包前准备-------------#

# 因为项目是ts写的，所以需要将其转化成js版本在发布要不然命令不能运行

npm run build

#------------查看当前npm源的地址-------------#

npm config get registry

#------------登录npm(如果有则不用登陆)-------------#

npm set registry https://registry.npmjs.org

npm login

#------------发布包(注意package.json中的版本)-------------#

npm version patch # 更新package中的版本号 npm version 1.0.1

# npm publish
npm publish --access public  # 发布一个共有包

```

## 用法

```shell
#------------全局安装npm包-------------#

npm install @hjm/hjm-cli -g

#------------测试hjm脚本-------------#

cd 进入需要初始化的项目文件夹
# 初始化一个npm包基础项目
hjm npm:init
# 初始化一个机器人基础项目
hjm robot:init

# 初始化脚本成功

```

#### 分支说明

1. master 默认分支

1. develop 调试分支

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request