Merge branch 'master' into add-more-type-checks-to-valid-types

* master:
  chore: change the process for generatng readme
  fix: Fix wrong alignment
  docs: generate docs
  fix: Exclude line slicing by zero.
  chore: update comment-parser and gitdown deps.
  fix: Fix trim bug in trimCode
  docs: generate docs
  fix: Remove unformatted space

Author: brettz9

.travis.yml

@@ -15,6 +15,7 @@ sudo: false
 script:
   - npm run test
   - 'if [ -n "${LINT-}" ]; then npm run lint; fi'
+  - 'if [ -n "${CHECK_README-}" ]; then npm run check-readme; fi'
   - npm run build
 env:
   matrix:
@@ -25,6 +26,8 @@ matrix:
   include:
     - node_js: 'lts/*'
       env: LINT=true
+    - node_js: 'lts/*'
+      env: CHECK_README=true
   exclude:
     - node_js: 6
       env: ESLINT=6

README.md

@@ -388,15 +388,15 @@ function quux (foo) {
 }
 // Message: Expected JSDoc block to be aligned.
 
-/**
+ /**
  * @param {Number} foo
  */
 function quux (foo) {
 
 }
 // Message: Expected JSDoc block to be aligned.
 
-/**
+ /**
   * @param {Number} foo
  */
 function quux (foo) {
@@ -405,16 +405,16 @@ function quux (foo) {
 // Message: Expected JSDoc block to be aligned.
 
 /**
- * @param {Number} foo
- */
-function quux (foo) {
+  * @param {Number} foo
+  */
+ function quux (foo) {
 
-}
+ }
 // Message: Expected JSDoc block to be aligned.
 
 /**
-  * A jsdoc not attached to any node.
-*/
+   * A jsdoc not attached to any node.
+ */
 // Message: Expected JSDoc block to be aligned.
 
 class Foo {
@@ -775,10 +775,10 @@ function f () {
 // Message: `settings.jsdoc.captionRequired` has been removed, use options in the rule `check-examples` instead.
 
 /**
-* @typedef {string} Foo
-* @example <caption></caption>
-* 'foo'
-*/
+ * @typedef {string} Foo
+ * @example <caption></caption>
+ * 'foo'
+ */
 // Options: [{"captionRequired":true,"eslintrcForExamples":false}]
 // Message: Caption is expected for examples.
 ````
@@ -3260,19 +3260,19 @@ function quux () {
 // Message: There must be no newline after the description of the JSDoc block.
 
 /**
-* A.
-*
-* @typedef {Object} A
-* @prop {boolean} a A.
-*/
+ * A.
+ *
+ * @typedef {Object} A
+ * @prop {boolean} a A.
+ */
 // Options: ["never"]
 // Message: There must be no newline after the description of the JSDoc block.
 
 /**
-* A.
-* @typedef {Object} A
-* @prop {boolean} a A.
-*/
+ * A.
+ * @typedef {Object} A
+ * @prop {boolean} a A.
+ */
 // Options: ["always"]
 // Message: There must be a newline after the description of the JSDoc block.
 ````
@@ -3411,17 +3411,17 @@ The following patterns are considered problems:
 
 ````js
 /**
-  * @param {HerType} baz - Foo.
-  */
+ * @param {HerType} baz - Foo.
+ */
 function quux(foo, bar, baz) {
 
 }
 // Settings: {"jsdoc":{"preferredTypes":{"HerType":1000}}}
 // Message: Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.
 
 /**
-  * @param {HerType} baz - Foo.
-  */
+ * @param {HerType} baz - Foo.
+ */
 function quux(foo, bar, baz) {
 
 }
@@ -3437,28 +3437,28 @@ function quux(foo) {
 // Message: The type 'strnig' is undefined.
 
 /**
-* @param {MyType} foo - Bar.
-* @param {HisType} bar - Foo.
-*/
+ * @param {MyType} foo - Bar.
+ * @param {HisType} bar - Foo.
+ */
 function quux(foo, bar) {
 
 }
 // Options: [{"definedTypes":["MyType"]}]
 // Message: The type 'HisType' is undefined.
 
 /**
-  * @param {MyType} foo - Bar.
-  * @param {HisType} bar - Foo.
-  * @param {HerType} baz - Foo.
-  */
+ * @param {MyType} foo - Bar.
+ * @param {HisType} bar - Foo.
+ * @param {HerType} baz - Foo.
+ */
 function quux(foo, bar, baz) {
 
 }
 // Settings: {"jsdoc":{"preferredTypes":{"hertype":{"replacement":"HerType"}}}}
 // Options: [{"definedTypes":["MyType"]}]
 // Message: The type 'HisType' is undefined.
 
-/**
+ /**
   * @param {MyType} foo - Bar.
   * @param {HisType} bar - Foo.
   * @param {HerType} baz - Foo.
@@ -3634,30 +3634,30 @@ function foo () {
 }
 
 /**
-* @param {MyType} foo - Bar.
-* @param {HisType} bar - Foo.
-*/
+ * @param {MyType} foo - Bar.
+ * @param {HisType} bar - Foo.
+ */
 function quux(foo, bar) {
 
 }
 // Options: [{"definedTypes":["MyType","HisType"]}]
 
 /**
-  * @param {MyType} foo - Bar.
-  * @param {HisType} bar - Foo.
-  * @param {HerType} baz - Foo.
-  */
+ * @param {MyType} foo - Bar.
+ * @param {HisType} bar - Foo.
+ * @param {HerType} baz - Foo.
+ */
 function quux(foo, bar, baz) {
 
 }
 // Settings: {"jsdoc":{"preferredTypes":{"hertype":{"replacement":"HerType"},"histype":"HisType"}}}
 // Options: [{"definedTypes":["MyType"]}]
 
 /**
-  * @param {MyType} foo - Bar.
-  * @param {HisType} bar - Foo.
-  * @param {HerType} baz - Foo.
-  */
+ * @param {MyType} foo - Bar.
+ * @param {HisType} bar - Foo.
+ * @param {HerType} baz - Foo.
+ */
 function quux(foo, bar, baz) {
 
 }
@@ -5351,14 +5351,14 @@ module.exports = {
 // Options: [{"publicOnly":true,"require":{"FunctionExpression":true}}]
 
 /**
-*
-*/
+ *
+ */
 function test() {
 
 }
 
 module.exports = {
-prop: { prop2: test }
+  prop: { prop2: test }
 }
 // Options: [{"publicOnly":true,"require":{"FunctionExpression":true}}]
 
@@ -6816,8 +6816,8 @@ const quux = async () => {}
 // Message: Missing JSDoc @returns declaration.
 
 /**
-*
-*/
+ *
+ */
 async function quux () {}
 // Options: [{"forceRequireReturn":true}]
 // Message: Missing JSDoc @returns declaration.

package.json

@@ -5,7 +5,7 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "comment-parser": "^0.5.5",
+    "comment-parser": "^0.6.0",
     "debug": "^4.1.1",
     "flat-map-polyfill": "^0.3.8",
     "jsdoctypeparser": "5.0.1",
@@ -27,7 +27,7 @@
     "chai": "^4.2.0",
     "eslint": "^6.0.1",
     "eslint-config-canonical": "^17.1.4",
-    "gitdown": "^2.6.2",
+    "gitdown": "^3.1.1",
     "glob": "^7.1.4",
     "husky": "^3.0.0",
     "mocha": "^6.1.4",
@@ -40,8 +40,7 @@
   },
   "husky": {
     "hooks": {
-      "post-commit": "npm run create-readme && git add README.md && git commit -m 'docs: generate docs' --no-verify",
-      "pre-commit": "npm run lint && npm run test && npm run build"
+      "pre-push": "npm run lint && npm run test && npm run build && npm run check-readme"
     }
   },
   "keywords": [
@@ -60,9 +59,9 @@
     "url": "https://github.com/gajus/eslint-plugin-jsdoc"
   },
   "scripts": {
-    "add-assertions": "babel-node ./src/bin/readme-assertions",
     "build": "rm -fr ./dist && NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps",
-    "create-readme": "gitdown ./.README/README.md --output-file ./README.md && npm run add-assertions",
+    "check-readme": "babel-node ./src/bin/generateReadme.js --check",
+    "create-readme": "babel-node ./src/bin/generateReadme.js",
     "lint-fix": "eslint --fix ./src ./test",
     "lint": "eslint ./src ./test",
     "test-cov": "BABEL_ENV=test nyc mocha --recursive --require @babel/register --reporter progress --timeout 9000",