From 1e7840106bf876a9374da030bc154e101a645f30 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20T=C3=B6tterman?= Date: Fri, 27 Oct 2017 06:49:58 +0200 Subject: [PATCH 1/4] added esdoc --- .esdoc.json | 22 ++++++++++++++++++++++ .gitignore | 1 + CONTRIBUTING.md | 13 +++++++++++++ package.json | 4 +++- 4 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 .esdoc.json diff --git a/.esdoc.json b/.esdoc.json new file mode 100644 index 0000000..2f769a6 --- /dev/null +++ b/.esdoc.json @@ -0,0 +1,22 @@ +{ + "source": "./lib", + "destination": "./docs", + "plugins": [ + { + "name": "esdoc-coverage-plugin", + "option": { + "enable": true, + "kind": [ + "class", + "method", + "member", + "get", + "set", + "constructor", + "function", + "variable" + ] + } + } + ] +} \ No newline at end of file diff --git a/.gitignore b/.gitignore index e42f508..611accc 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ lib-cov # Coverage directory used by tools like istanbul coverage +docs # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) .grunt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d9e25f6..cd21887 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,6 +120,18 @@ Run the test: `mocha` + ### Documentation + + If you would like to auto-generate documentation of the packages, you can do so locally by running: + + `./node_modules/.bin/esdoc` + + Using the .esdoc.json file, esdoc will create documentation in the docs directory. + + ### Checking docs coverage + + You will find a coverage.json file in the **docs** directory. This will contain information about the documentation coverage for each of the different files in this repo. + ## Style Guidelines & Naming Conventions @@ -130,6 +142,7 @@ Generally, we follow the style guidelines as suggested by the official language. Please run your code through: - [ESLint](http://eslint.org/) with the standard style guide. +- [esdoc](https://github.com/sendgrid/sendgrid-nodejs/blob/master/.github/USAGE.md) to check the documentation coverage of your added code. ## Creating a Pull Request diff --git a/package.json b/package.json index 5b1eda0..6d40424 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,9 @@ }, "dependencies": {}, "devDependencies": { - "chai": "^3.5.0", + "chai": "^2.3.0", + "esdoc": "^1.0.3", + "esdoc-coverage-plugin": "^1.1.0", "eslint": "^2.7.0", "eslint-config-standard": "^5.1.0", "eslint-plugin-standard": "^1.3.2", From ce8ac6bfa622e788c79a60b0e28692303e6986ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20T=C3=B6tterman?= Date: Fri, 27 Oct 2017 06:57:20 +0200 Subject: [PATCH 2/4] changing back to original chai version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 6d40424..3fa39f4 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ }, "dependencies": {}, "devDependencies": { - "chai": "^2.3.0", + "chai": "^3.5.0", "esdoc": "^1.0.3", "esdoc-coverage-plugin": "^1.1.0", "eslint": "^2.7.0", From 8a8b78c5c8defda2578afaad5c50410d3f12599b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20T=C3=B6tterman?= Date: Fri, 27 Oct 2017 06:57:54 +0200 Subject: [PATCH 3/4] referring to correct repository in changelog --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd21887..4d471a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -142,7 +142,7 @@ Generally, we follow the style guidelines as suggested by the official language. Please run your code through: - [ESLint](http://eslint.org/) with the standard style guide. -- [esdoc](https://github.com/sendgrid/sendgrid-nodejs/blob/master/.github/USAGE.md) to check the documentation coverage of your added code. +- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#testing) to check the documentation coverage of your added code. ## Creating a Pull Request From bf54dda9647ea2dbb57a7eadb425259a8f8c1229 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20T=C3=B6tterman?= Date: Fri, 27 Oct 2017 08:13:47 +0200 Subject: [PATCH 4/4] changes after review --- CONTRIBUTING.md | 14 +------------- USAGE.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d471a1..0a7ffa9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,18 +120,6 @@ Run the test: `mocha` - ### Documentation - - If you would like to auto-generate documentation of the packages, you can do so locally by running: - - `./node_modules/.bin/esdoc` - - Using the .esdoc.json file, esdoc will create documentation in the docs directory. - - ### Checking docs coverage - - You will find a coverage.json file in the **docs** directory. This will contain information about the documentation coverage for each of the different files in this repo. - ## Style Guidelines & Naming Conventions @@ -142,7 +130,7 @@ Generally, we follow the style guidelines as suggested by the official language. Please run your code through: - [ESLint](http://eslint.org/) with the standard style guide. -- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#testing) to check the documentation coverage of your added code. +- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/USAGE.md) to check the documentation coverage of your added code. ## Creating a Pull Request diff --git a/USAGE.md b/USAGE.md index 2807aa9..51aaa9d 100644 --- a/USAGE.md +++ b/USAGE.md @@ -15,3 +15,15 @@ To run the example: ```bash node examples/example ``` + + # Documentation + + If you would like to auto-generate documentation of the packages, you can do so locally by running: + + `./node_modules/.bin/esdoc` + + Using the .esdoc.json file, esdoc will create documentation in the docs directory. + + ## Checking docs coverage + + You will find a coverage.json file in the **docs** directory. This will contain information about the documentation coverage for each of the different files in this repo. \ No newline at end of file