-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
63 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# jm-cli | ||
> a CLI tool for jumore FE team | ||
> A CLI tool for jumore FE team. | ||
## Install: | ||
|
||
|
@@ -11,7 +11,7 @@ $ npm i -g jm-cli | |
### from github(latest) | ||
|
||
```bash | ||
$ git clone https://github.com/jm-team/jm-cli.git | ||
$ git clone https://github.com/ICELI/jm-cli.git | ||
$ cd jm-cli | ||
$ npm link | ||
``` | ||
|
@@ -32,10 +32,7 @@ install package | |
|
||
```bash | ||
$ jm install | ||
``` | ||
or | ||
|
||
```bash | ||
# or | ||
$ jm i | ||
``` | ||
|
||
|
@@ -50,22 +47,47 @@ production build | |
```bash | ||
$ jm build | ||
``` | ||
open browser | ||
production server | ||
|
||
```bash | ||
$ jm server | ||
# or | ||
$ jm s | ||
# open browser http://localhost:8081 | ||
``` | ||
http://localhost:8081 | ||
|
||
release ng-seed or vue-seed | ||
|
||
```bash | ||
$ jm seed | ||
# same as | ||
$ jm d && jm l && jm a && jm site | ||
``` | ||
|
||
new page | ||
gen jsdoc | ||
```bash | ||
$ jm ng:page pageName | ||
$ jm jsdoc | ||
# or | ||
$ jm ng:page path/pageName | ||
$ jm d | ||
# need to configure file | ||
``` | ||
|
||
gen CHANGELOG.md | ||
```bash | ||
$ jm changelog | ||
# or | ||
$ jm l | ||
# CHANGELOG.md - default file name | ||
|
||
$ jm log log.md | ||
# log.md - program.args[0] as file name | ||
``` | ||
|
||
gen AUTHORS.md | ||
```bash | ||
$ jm author | ||
# or | ||
$ jm a | ||
# AUTHORS.md - default file name | ||
|
||
$ jm author author.md | ||
|
@@ -80,33 +102,48 @@ author.md | |
- xxxxx <[email protected]> | ||
- xxxx <[email protected]> | ||
|
||
#### Generated by build/authors.js. | ||
#### Generated by jm-cli.js. | ||
|
||
``` | ||
|
||
gen gh-pages | ||
```bash | ||
$ jm site | ||
# push dist/ to github pages | ||
``` | ||
|
||
gen new page for angular project | ||
```bash | ||
$ jm ng:page pageName | ||
# or | ||
$ jm ng:page path/pageName | ||
``` | ||
|
||
|
||
```bash | ||
|
||
Usage: jm <command> [options] | ||
|
||
|
||
Commands: | ||
|
||
init initialize project, you can choose the framework with AngularJS or Vue2 | ||
install|i Install Package | ||
dev dev build | ||
build production build | ||
seed publish seed | ||
jsdoc generator jsdoc | ||
changelog generator changelog.md | ||
author generator authors.md | ||
site push gh-pages | ||
ng:page generator new page | ||
init initialize project, you can choose the framework with AngularJS or Vue2 | ||
install|i Install Package | ||
dev dev build | ||
build production build | ||
server|s production service | ||
seed publish seed | ||
jsdoc|d generator jsdoc | ||
changelog|l generator CHANGELOG.md | ||
author|a generator AUTHORS.md | ||
site push gh-pages | ||
ng:page generator new page | ||
|
||
Options: | ||
|
||
-h, --help output usage information | ||
-V, --version output the version number | ||
-c, --config [path] config file path | ||
-h, --help output usage information | ||
-V, --version output the version number | ||
-c, --configure <path> config file path | ||
|
||
``` | ||
|
||
|
@@ -115,7 +152,7 @@ author.md | |
|
||
(The MIT License) | ||
|
||
Copyright (c) 2016 iceli <[email protected]> | ||
Copyright (c) 2016-present iceli <[email protected]> | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining | ||
a copy of this software and associated documentation files (the | ||
|