geek-project
Usage
Install
npm i @geekcojp/gp
# npm i @geekcojp/gp@next
Flow
1 Create project directory
mkdir <project-dirname> && cd <project-dirname>
yarn
2 Initialize by yarn init -y
gp
3 Initialize by gp init
# with webpack
gp init --webpack
4 Add template
gp add pug
gp add sass
gp add postcss
gp add typescript (--module) (--react) (--firebase)
gp add babel
for example,
Webpack + Sass + PostCSS + TypeScript + React
gp init --webpack && gp add sass && gp add postcss && gp add typescript --react
gp dev
Pug + Sass + PostCSS + Babel
gp init && gp add pug && gp add sass && gp add postcss && gp add babel
gp dev
5 develop
gp dev
6 build
gp build
Commands
Top level
$ gp --help
gp [command]
Commands:
gp init Initialize
gp add Add a template into the project
gp remove Remove a template from the project
gp dev Develop
gp build Build for production
Options:
--version Show version number [boolean]
--help Show help [boolean]
Add
$ gp add --help
gp add
Add the tool into this project
Commands:
gp add typescript Add typescript environment
gp add babel Add Babel into the project
gp add sass Add sass environment
gp add postcss Add postcss environment
gp add pug Add postcss environment
Options:
--version Show version number [boolean]
--help Show help [boolean]
Supports
- [x] pug
- [x] sass
- [x] postcss
- [x] sass + postcss
- [ ] less
- [ ] less + postcss
- [ ] stylus
- [ ] stylus + postcss
- [x] flow
- [x] typescript
- [x] jQuery (vanilla)
- [x] CircleCI
TODO
- [ ] test this project
- [ ] pug (with webpack)
- [x] pug (without webpack)
- [x] sass (with webpack)
- [x] sass (without webpack)
- [x] postcss (with webpack)
- [ ] postcss (without webpack)
- [x] flow (with webpack)
- [x] flow (without webpack)
- [x] typescript (with webpack)
- [x] typescript (with react)
- [ ] typescript (with react-router)
- [x] typescript (with jest)
- [x] typescript (with enzyme)
- [ ] typescript (with ssr)
- [ ] typescript (with e2e)
- [ ] typescript (without webpack)
- [x] circleci