chore: Update npm script `gen-doc` to `doc`

release
GochoMugo 8 years ago
parent bbac07ad2c
commit dc897d95e5
No known key found for this signature in database
GPG Key ID: 7B6A01CB57AA39E4
  1. 2
      .github/PULL_REQUEST_TEMPLATE.md
  2. 4
      CONTRIBUTING.md
  3. 3
      package.json

@ -5,7 +5,7 @@ For example, if your PR passes all tests, you would mark the option as so:
Note the 'x' in between the square brackets '[]' Note the 'x' in between the square brackets '[]'
--> -->
- [ ] All tests pass - [ ] All tests pass
- [ ] I have run `npm run gen-doc` - [ ] I have run `npm run doc`
### Description ### Description

@ -24,13 +24,15 @@ Before proceeding any further, read the following documents:
Run: Run:
```bash ```bash
$ npm run gen-doc $ npm run doc
``` ```
### Running tests ### Running tests
Please read `test/README.md` for more information. Please read `test/README.md` for more information.
### Transpiling ES2015 for older Node.js versions ### Transpiling ES2015 for older Node.js versions
We use babel to transpile the code: We use babel to transpile the code:

@ -14,7 +14,8 @@
"bot" "bot"
], ],
"scripts": { "scripts": {
"gen-doc": "jsdoc2md --files src/telegram.js --template doc/api.hbs > doc/api.md", "gen-doc": "echo 'WARNING: `npm run gen-doc` is deprecated. Use `npm run doc` instead.' && npm run doc",
"doc": "jsdoc2md --files src/telegram.js --template doc/api.hbs > doc/api.md",
"build": "babel -d ./lib src", "build": "babel -d ./lib src",
"prepublish": "npm run build && npm run gen-doc", "prepublish": "npm run build && npm run gen-doc",
"eslint": "eslint ./src ./test ./examples", "eslint": "eslint ./src ./test ./examples",

Loading…
Cancel
Save