From 97e9361c8d349159f65699e8765d2fbf5e406d8b Mon Sep 17 00:00:00 2001 From: Lance Ball Date: Mon, 24 Oct 2022 08:12:58 -0400 Subject: [PATCH 01/36] chore: upgrade git-url-parse to 13.1.0 (#1565) Fixes: https://github.com/documentationjs/documentation/issues/1558 Signed-off-by: Lance Ball Signed-off-by: Lance Ball --- package-lock.json | 84 +++++++++++++++++------------------------------ package.json | 2 +- 2 files changed, 32 insertions(+), 54 deletions(-) diff --git a/package-lock.json b/package-lock.json index 19f7956ff..31fdfe762 100644 --- a/package-lock.json +++ b/package-lock.json @@ -18,7 +18,7 @@ "chokidar": "^3.5.3", "diff": "^5.1.0", "doctrine-temporary-fork": "2.1.0", - "git-url-parse": "^12.0.0", + "git-url-parse": "^13.1.0", "github-slugger": "1.4.0", "glob": "^8.0.3", "globals-docs": "^2.4.1", @@ -4486,20 +4486,20 @@ } }, "node_modules/git-up": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/git-up/-/git-up-6.0.0.tgz", - "integrity": "sha512-6RUFSNd1c/D0xtGnyWN2sxza2bZtZ/EmI9448n6rCZruFwV/ezeEn2fJP7XnUQGwf0RAtd/mmUCbtH6JPYA2SA==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/git-up/-/git-up-7.0.0.tgz", + "integrity": "sha512-ONdIrbBCFusq1Oy0sC71F5azx8bVkvtZtMJAsv+a6lz5YAmbNnLD6HAB4gptHZVLPR8S2/kVN6Gab7lryq5+lQ==", "dependencies": { "is-ssh": "^1.4.0", - "parse-url": "^7.0.2" + "parse-url": "^8.1.0" } }, "node_modules/git-url-parse": { - "version": "12.0.0", - "resolved": "https://registry.npmjs.org/git-url-parse/-/git-url-parse-12.0.0.tgz", - "integrity": "sha512-I6LMWsxV87vysX1WfsoglXsXg6GjQRKq7+Dgiseo+h0skmp5Hp2rzmcEIRQot9CPA+uzU7x1x7jZdqvTFGnB+Q==", + "version": "13.1.0", + "resolved": "https://registry.npmjs.org/git-url-parse/-/git-url-parse-13.1.0.tgz", + "integrity": "sha512-5FvPJP/70WkIprlUZ33bm4UAaFdjcLkJLpWft1BeZKqwR0uhhNGoKwlUaPtVb4LxCSQ++erHapRak9kWGj+FCA==", "dependencies": { - "git-up": "^6.0.0" + "git-up": "^7.0.0" } }, "node_modules/gitconfiglocal": { @@ -9026,17 +9026,6 @@ "node": ">=0.10.0" } }, - "node_modules/normalize-url": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-6.1.0.tgz", - "integrity": "sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A==", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/npm-run-path": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", @@ -9320,22 +9309,19 @@ } }, "node_modules/parse-path": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/parse-path/-/parse-path-5.0.0.tgz", - "integrity": "sha512-qOpH55/+ZJ4jUu/oLO+ifUKjFPNZGfnPJtzvGzKN/4oLMil5m9OH4VpOj6++9/ytJcfks4kzH2hhi87GL/OU9A==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/parse-path/-/parse-path-7.0.0.tgz", + "integrity": "sha512-Euf9GG8WT9CdqwuWJGdf3RkUcTBArppHABkO7Lm8IzRQp0e2r/kkFnmhu4TSK30Wcu5rVAZLmfPKSBBi9tWFog==", "dependencies": { "protocols": "^2.0.0" } }, "node_modules/parse-url": { - "version": "7.0.2", - "resolved": "https://registry.npmjs.org/parse-url/-/parse-url-7.0.2.tgz", - "integrity": "sha512-PqO4Z0eCiQ08Wj6QQmrmp5YTTxpYfONdOEamrtvK63AmzXpcavIVQubGHxOEwiIoDZFb8uDOoQFS0NCcjqIYQg==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/parse-url/-/parse-url-8.1.0.tgz", + "integrity": "sha512-xDvOoLU5XRrcOZvnI6b8zA6n9O9ejNk/GExuz1yBuWUGn9KA97GI6HTs6u02wKara1CeVmZhH+0TZFdWScR89w==", "dependencies": { - "is-ssh": "^1.4.0", - "normalize-url": "^6.1.0", - "parse-path": "^5.0.0", - "protocols": "^2.0.1" + "parse-path": "^7.0.0" } }, "node_modules/path-exists": { @@ -14809,20 +14795,20 @@ } }, "git-up": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/git-up/-/git-up-6.0.0.tgz", - "integrity": "sha512-6RUFSNd1c/D0xtGnyWN2sxza2bZtZ/EmI9448n6rCZruFwV/ezeEn2fJP7XnUQGwf0RAtd/mmUCbtH6JPYA2SA==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/git-up/-/git-up-7.0.0.tgz", + "integrity": "sha512-ONdIrbBCFusq1Oy0sC71F5azx8bVkvtZtMJAsv+a6lz5YAmbNnLD6HAB4gptHZVLPR8S2/kVN6Gab7lryq5+lQ==", "requires": { "is-ssh": "^1.4.0", - "parse-url": "^7.0.2" + "parse-url": "^8.1.0" } }, "git-url-parse": { - "version": "12.0.0", - "resolved": "https://registry.npmjs.org/git-url-parse/-/git-url-parse-12.0.0.tgz", - "integrity": "sha512-I6LMWsxV87vysX1WfsoglXsXg6GjQRKq7+Dgiseo+h0skmp5Hp2rzmcEIRQot9CPA+uzU7x1x7jZdqvTFGnB+Q==", + "version": "13.1.0", + "resolved": "https://registry.npmjs.org/git-url-parse/-/git-url-parse-13.1.0.tgz", + "integrity": "sha512-5FvPJP/70WkIprlUZ33bm4UAaFdjcLkJLpWft1BeZKqwR0uhhNGoKwlUaPtVb4LxCSQ++erHapRak9kWGj+FCA==", "requires": { - "git-up": "^6.0.0" + "git-up": "^7.0.0" } }, "gitconfiglocal": { @@ -18052,11 +18038,6 @@ "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==" }, - "normalize-url": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-6.1.0.tgz", - "integrity": "sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A==" - }, "npm-run-path": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", @@ -18260,22 +18241,19 @@ "dev": true }, "parse-path": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/parse-path/-/parse-path-5.0.0.tgz", - "integrity": "sha512-qOpH55/+ZJ4jUu/oLO+ifUKjFPNZGfnPJtzvGzKN/4oLMil5m9OH4VpOj6++9/ytJcfks4kzH2hhi87GL/OU9A==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/parse-path/-/parse-path-7.0.0.tgz", + "integrity": "sha512-Euf9GG8WT9CdqwuWJGdf3RkUcTBArppHABkO7Lm8IzRQp0e2r/kkFnmhu4TSK30Wcu5rVAZLmfPKSBBi9tWFog==", "requires": { "protocols": "^2.0.0" } }, "parse-url": { - "version": "7.0.2", - "resolved": "https://registry.npmjs.org/parse-url/-/parse-url-7.0.2.tgz", - "integrity": "sha512-PqO4Z0eCiQ08Wj6QQmrmp5YTTxpYfONdOEamrtvK63AmzXpcavIVQubGHxOEwiIoDZFb8uDOoQFS0NCcjqIYQg==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/parse-url/-/parse-url-8.1.0.tgz", + "integrity": "sha512-xDvOoLU5XRrcOZvnI6b8zA6n9O9ejNk/GExuz1yBuWUGn9KA97GI6HTs6u02wKara1CeVmZhH+0TZFdWScR89w==", "requires": { - "is-ssh": "^1.4.0", - "normalize-url": "^6.1.0", - "parse-path": "^5.0.0", - "protocols": "^2.0.1" + "parse-path": "^7.0.0" } }, "path-exists": { diff --git a/package.json b/package.json index 87f86d3c1..531ccd147 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "chokidar": "^3.5.3", "diff": "^5.1.0", "doctrine-temporary-fork": "2.1.0", - "git-url-parse": "^12.0.0", + "git-url-parse": "^13.1.0", "github-slugger": "1.4.0", "glob": "^8.0.3", "globals-docs": "^2.4.1", From 73609e5b746a62c9855070d28bc84ed420f76574 Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Wed, 14 Dec 2022 09:57:30 +0100 Subject: [PATCH 02/36] chore(release): 14.0.1 --- CHANGELOG.md | 5 +++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 180e2136c..59f9450ce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [14.0.1](https://github.com/documentationjs/documentation/compare/v14.0.0-0...v14.0.1) (2022-12-14) + +### Improvements +* chore: upgrade git-url-parse to 13.1.0 to fix vulnerabilities [#1565](https://github.com/documentationjs/documentation/pull/1565) + ## [14.0.0](https://github.com/documentationjs/documentation/compare/v14.0.0-alpha.1...v14.0.0) (2022-08-19) ## [14.0.0-alpha.1](https://github.com/documentationjs/documentation/compare/v14.0.0-alpha.0...v14.0.0-alpha.1) (2022-08-07) diff --git a/package-lock.json b/package-lock.json index 31fdfe762..a1c7de78f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "documentation", - "version": "14.0.0", + "version": "14.0.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "documentation", - "version": "14.0.0", + "version": "14.0.1", "license": "ISC", "dependencies": { "@babel/core": "^7.18.10", diff --git a/package.json b/package.json index 531ccd147..e6d944b8b 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "documentation", "description": "a documentation generator", - "version": "14.0.0", + "version": "14.0.1", "author": "Tom MacWright", "homepage": "https://documentation.js.org", "type": "module", From 5b7e6cd6459177e42c4c10dd4b65a9a604e0a190 Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Wed, 14 Dec 2022 09:59:59 +0100 Subject: [PATCH 03/36] fix changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 59f9450ce..c1cbe2621 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. -## [14.0.1](https://github.com/documentationjs/documentation/compare/v14.0.0-0...v14.0.1) (2022-12-14) +## [14.0.1](https://github.com/documentationjs/documentation/compare/v14.0.0...v14.0.1) (2022-12-14) ### Improvements * chore: upgrade git-url-parse to 13.1.0 to fix vulnerabilities [#1565](https://github.com/documentationjs/documentation/pull/1565) From 990e0a23ce3368238294a4f6986552896ed5e7d9 Mon Sep 17 00:00:00 2001 From: Christian Oliff Date: Wed, 14 Dec 2022 18:01:40 +0900 Subject: [PATCH 04/36] update Dependabot docs link (#1562) The previous link was broken --- .github/dependabot.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index e0ad046de..bb236c12d 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,7 +1,7 @@ # To get started with Dependabot version updates, you'll need to specify which # package ecosystems to update and where the package manifests are located. # Please see the documentation for all configuration options: -# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +# https://docs.github.com/en/code-security/dependabot version: 2 updates: From 1ba25bf8249aaf1f97061ed76af4b27b9e1a5c72 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 14 Dec 2022 10:08:40 +0100 Subject: [PATCH 05/36] build(deps): bump @babel/types from 7.18.10 to 7.20.5 (#1578) Bumps [@babel/types](https://github.com/babel/babel/tree/HEAD/packages/babel-types) from 7.18.10 to 7.20.5. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.20.5/packages/babel-types) --- updated-dependencies: - dependency-name: "@babel/types" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/package-lock.json b/package-lock.json index a1c7de78f..693343c6d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -255,17 +255,17 @@ } }, "node_modules/@babel/helper-string-parser": { - "version": "7.18.10", - "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.18.10.tgz", - "integrity": "sha512-XtIfWmeNY3i4t7t4D2t02q50HvqHybPqW2ki1kosnvWCwuCMeo81Jf0gwr85jy/neUdg5XDdeFE/80DXiO+njw==", + "version": "7.19.4", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.19.4.tgz", + "integrity": "sha512-nHtDoQcuqFmwYNYPz3Rah5ph2p8PFeFCsZk9A/48dPc/rGocJ5J3hAAZ7pb76VWX3fZKu+uEr/FhH5jLx7umrw==", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-validator-identifier": { - "version": "7.18.6", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.18.6.tgz", - "integrity": "sha512-MmetCkz9ej86nJQV+sFCxoGGrUbU3q02kgLciwkrt9QqEB7cP39oKEY0PakknEO0Gu20SskMRi+AYZ3b1TpN9g==", + "version": "7.19.1", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.19.1.tgz", + "integrity": "sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w==", "engines": { "node": ">=6.9.0" } @@ -524,12 +524,12 @@ } }, "node_modules/@babel/types": { - "version": "7.18.10", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.18.10.tgz", - "integrity": "sha512-MJvnbEiiNkpjo+LknnmRrqbY1GPUUggjv+wQVjetM/AONoupqRALB7I6jGqNUAZsKcRIEu2J6FRFvsczljjsaQ==", + "version": "7.20.5", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.20.5.tgz", + "integrity": "sha512-c9fst/h2/dcF7H+MJKZ2T0KjEQ8hY/BNnDk/H3XY8C4Aw/eWQXWn/lWntHF9ooUBnGmEvbfGrTgLWc+um0YDUg==", "dependencies": { - "@babel/helper-string-parser": "^7.18.10", - "@babel/helper-validator-identifier": "^7.18.6", + "@babel/helper-string-parser": "^7.19.4", + "@babel/helper-validator-identifier": "^7.19.1", "to-fast-properties": "^2.0.0" }, "engines": { @@ -11586,14 +11586,14 @@ } }, "@babel/helper-string-parser": { - "version": "7.18.10", - "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.18.10.tgz", - "integrity": "sha512-XtIfWmeNY3i4t7t4D2t02q50HvqHybPqW2ki1kosnvWCwuCMeo81Jf0gwr85jy/neUdg5XDdeFE/80DXiO+njw==" + "version": "7.19.4", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.19.4.tgz", + "integrity": "sha512-nHtDoQcuqFmwYNYPz3Rah5ph2p8PFeFCsZk9A/48dPc/rGocJ5J3hAAZ7pb76VWX3fZKu+uEr/FhH5jLx7umrw==" }, "@babel/helper-validator-identifier": { - "version": "7.18.6", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.18.6.tgz", - "integrity": "sha512-MmetCkz9ej86nJQV+sFCxoGGrUbU3q02kgLciwkrt9QqEB7cP39oKEY0PakknEO0Gu20SskMRi+AYZ3b1TpN9g==" + "version": "7.19.1", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.19.1.tgz", + "integrity": "sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w==" }, "@babel/helper-validator-option": { "version": "7.18.6", @@ -11782,12 +11782,12 @@ } }, "@babel/types": { - "version": "7.18.10", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.18.10.tgz", - "integrity": "sha512-MJvnbEiiNkpjo+LknnmRrqbY1GPUUggjv+wQVjetM/AONoupqRALB7I6jGqNUAZsKcRIEu2J6FRFvsczljjsaQ==", + "version": "7.20.5", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.20.5.tgz", + "integrity": "sha512-c9fst/h2/dcF7H+MJKZ2T0KjEQ8hY/BNnDk/H3XY8C4Aw/eWQXWn/lWntHF9ooUBnGmEvbfGrTgLWc+um0YDUg==", "requires": { - "@babel/helper-string-parser": "^7.18.10", - "@babel/helper-validator-identifier": "^7.18.6", + "@babel/helper-string-parser": "^7.19.4", + "@babel/helper-validator-identifier": "^7.19.1", "to-fast-properties": "^2.0.0" } }, From 3f5164d0df307dadd303c2813c7e8088cf2e8d95 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 14 Dec 2022 10:08:51 +0100 Subject: [PATCH 06/36] build(deps): bump @babel/generator from 7.18.12 to 7.20.5 (#1577) Bumps [@babel/generator](https://github.com/babel/babel/tree/HEAD/packages/babel-generator) from 7.18.12 to 7.20.5. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.20.5/packages/babel-generator) --- updated-dependencies: - dependency-name: "@babel/generator" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/package-lock.json b/package-lock.json index 693343c6d..9b0d3029f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -134,11 +134,11 @@ } }, "node_modules/@babel/generator": { - "version": "7.18.12", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.18.12.tgz", - "integrity": "sha512-dfQ8ebCN98SvyL7IxNMCUtZQSq5R7kxgN+r8qYTGDmmSion1hX2C0zq2yo1bsCDhXixokv1SAWTZUMYbO/V5zg==", + "version": "7.20.5", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.20.5.tgz", + "integrity": "sha512-jl7JY2Ykn9S0yj4DQP82sYvPU+T3g0HFcWTqDLqiuA9tGRNIj9VfbtXGAYTTkyNEnQk1jkMGOdYka8aG/lulCA==", "dependencies": { - "@babel/types": "^7.18.10", + "@babel/types": "^7.20.5", "@jridgewell/gen-mapping": "^0.3.2", "jsesc": "^2.5.1" }, @@ -11498,11 +11498,11 @@ } }, "@babel/generator": { - "version": "7.18.12", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.18.12.tgz", - "integrity": "sha512-dfQ8ebCN98SvyL7IxNMCUtZQSq5R7kxgN+r8qYTGDmmSion1hX2C0zq2yo1bsCDhXixokv1SAWTZUMYbO/V5zg==", + "version": "7.20.5", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.20.5.tgz", + "integrity": "sha512-jl7JY2Ykn9S0yj4DQP82sYvPU+T3g0HFcWTqDLqiuA9tGRNIj9VfbtXGAYTTkyNEnQk1jkMGOdYka8aG/lulCA==", "requires": { - "@babel/types": "^7.18.10", + "@babel/types": "^7.20.5", "@jridgewell/gen-mapping": "^0.3.2", "jsesc": "^2.5.1" } From 608611c603f24dd048b436410b333e5233d2de5b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 14 Dec 2022 10:09:03 +0100 Subject: [PATCH 07/36] build(deps): bump vue-template-compiler from 2.7.8 to 2.7.14 (#1576) Bumps [vue-template-compiler](https://github.com/vuejs/vue) from 2.7.8 to 2.7.14. - [Release notes](https://github.com/vuejs/vue/releases) - [Changelog](https://github.com/vuejs/vue/blob/main/CHANGELOG.md) - [Commits](https://github.com/vuejs/vue/compare/v2.7.8...v2.7.14) --- updated-dependencies: - dependency-name: vue-template-compiler dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index 9b0d3029f..d328f7d16 100644 --- a/package-lock.json +++ b/package-lock.json @@ -45,6 +45,7 @@ "vfile": "^5.3.4", "vfile-reporter": "^7.0.4", "vfile-sort": "^3.0.0", + "vue-template-compiler": "^2.7.8", "yargs": "^17.5.1" }, "bin": { @@ -11237,9 +11238,9 @@ } }, "node_modules/vue-template-compiler": { - "version": "2.7.8", - "resolved": "https://registry.npmjs.org/vue-template-compiler/-/vue-template-compiler-2.7.8.tgz", - "integrity": "sha512-eQqdcUpJKJpBRPDdxCNsqUoT0edNvdt1jFjtVnVS/LPPmr0BU2jWzXlrf6BVMeODtdLewB3j8j3WjNiB+V+giw==", + "version": "2.7.14", + "resolved": "https://registry.npmjs.org/vue-template-compiler/-/vue-template-compiler-2.7.14.tgz", + "integrity": "sha512-zyA5Y3ArvVG0NacJDkkzJuPQDF8RFeRlzV2vLeSnhSpieO6LK2OVbdLPi5MPPs09Ii+gMO8nY4S3iKQxBxDmWQ==", "optional": true, "dependencies": { "de-indent": "^1.0.2", @@ -19600,9 +19601,9 @@ } }, "vue-template-compiler": { - "version": "2.7.8", - "resolved": "https://registry.npmjs.org/vue-template-compiler/-/vue-template-compiler-2.7.8.tgz", - "integrity": "sha512-eQqdcUpJKJpBRPDdxCNsqUoT0edNvdt1jFjtVnVS/LPPmr0BU2jWzXlrf6BVMeODtdLewB3j8j3WjNiB+V+giw==", + "version": "2.7.14", + "resolved": "https://registry.npmjs.org/vue-template-compiler/-/vue-template-compiler-2.7.14.tgz", + "integrity": "sha512-zyA5Y3ArvVG0NacJDkkzJuPQDF8RFeRlzV2vLeSnhSpieO6LK2OVbdLPi5MPPs09Ii+gMO8nY4S3iKQxBxDmWQ==", "optional": true, "requires": { "de-indent": "^1.0.2", From ba29602d4409b0b0e73b6119f802732690c1c19c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 14 Dec 2022 10:09:15 +0100 Subject: [PATCH 08/36] build(deps): bump actions/setup-node from 3.4.1 to 3.5.1 (#1566) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3.4.1 to 3.5.1. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v3.4.1...v3.5.1) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/node.js.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml index 936d5100a..5de87ed1f 100644 --- a/.github/workflows/node.js.yml +++ b/.github/workflows/node.js.yml @@ -22,7 +22,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3.4.1 + uses: actions/setup-node@v3.5.1 with: node-version: ${{ matrix.node-version }} cache: 'npm' From 73913f1ecb337c033d3359a30ddd9003fd355349 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 14 Dec 2022 10:09:29 +0100 Subject: [PATCH 09/36] build(deps): bump unist-util-visit from 4.1.0 to 4.1.1 (#1550) Bumps [unist-util-visit](https://github.com/syntax-tree/unist-util-visit) from 4.1.0 to 4.1.1. - [Release notes](https://github.com/syntax-tree/unist-util-visit/releases) - [Commits](https://github.com/syntax-tree/unist-util-visit/compare/4.1.0...4.1.1) --- updated-dependencies: - dependency-name: unist-util-visit dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/package-lock.json b/package-lock.json index d328f7d16..7fb566ab7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10981,13 +10981,13 @@ } }, "node_modules/unist-util-visit": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-4.1.0.tgz", - "integrity": "sha512-n7lyhFKJfVZ9MnKtqbsqkQEk5P1KShj0+//V7mAcoI6bpbUjh3C/OG8HVD+pBihfh6Ovl01m8dkcv9HNqYajmQ==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-4.1.1.tgz", + "integrity": "sha512-n9KN3WV9k4h1DxYR1LoajgN93wpEi/7ZplVe02IoB4gH5ctI1AaF2670BLHQYbwj+pY83gFtyeySFiyMHJklrg==", "dependencies": { "@types/unist": "^2.0.0", "unist-util-is": "^5.0.0", - "unist-util-visit-parents": "^5.0.0" + "unist-util-visit-parents": "^5.1.1" }, "funding": { "type": "opencollective", @@ -10995,9 +10995,9 @@ } }, "node_modules/unist-util-visit-parents": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-5.1.0.tgz", - "integrity": "sha512-y+QVLcY5eR/YVpqDsLf/xh9R3Q2Y4HxkZTp7ViLDU6WtJCEcPmRzW1gpdWDCDIqIlhuPDXOgttqPlykrHYDekg==", + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-5.1.1.tgz", + "integrity": "sha512-gks4baapT/kNRaWxuGkl5BIhoanZo7sC/cUT/JToSRNL1dYoXRFl75d++NkjYk4TAu2uv2Px+l8guMajogeuiw==", "dependencies": { "@types/unist": "^2.0.0", "unist-util-is": "^5.0.0" @@ -19423,19 +19423,19 @@ } }, "unist-util-visit": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-4.1.0.tgz", - "integrity": "sha512-n7lyhFKJfVZ9MnKtqbsqkQEk5P1KShj0+//V7mAcoI6bpbUjh3C/OG8HVD+pBihfh6Ovl01m8dkcv9HNqYajmQ==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-4.1.1.tgz", + "integrity": "sha512-n9KN3WV9k4h1DxYR1LoajgN93wpEi/7ZplVe02IoB4gH5ctI1AaF2670BLHQYbwj+pY83gFtyeySFiyMHJklrg==", "requires": { "@types/unist": "^2.0.0", "unist-util-is": "^5.0.0", - "unist-util-visit-parents": "^5.0.0" + "unist-util-visit-parents": "^5.1.1" } }, "unist-util-visit-parents": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-5.1.0.tgz", - "integrity": "sha512-y+QVLcY5eR/YVpqDsLf/xh9R3Q2Y4HxkZTp7ViLDU6WtJCEcPmRzW1gpdWDCDIqIlhuPDXOgttqPlykrHYDekg==", + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-5.1.1.tgz", + "integrity": "sha512-gks4baapT/kNRaWxuGkl5BIhoanZo7sC/cUT/JToSRNL1dYoXRFl75d++NkjYk4TAu2uv2Px+l8guMajogeuiw==", "requires": { "@types/unist": "^2.0.0", "unist-util-is": "^5.0.0" From 8f005760b51a66447f3846bf5de0c3f629896e2b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 14 Dec 2022 10:09:39 +0100 Subject: [PATCH 10/36] build(deps): bump ini from 3.0.0 to 3.0.1 (#1551) Bumps [ini](https://github.com/npm/ini) from 3.0.0 to 3.0.1. - [Release notes](https://github.com/npm/ini/releases) - [Changelog](https://github.com/npm/ini/blob/main/CHANGELOG.md) - [Commits](https://github.com/npm/ini/compare/v3.0.0...v3.0.1) --- updated-dependencies: - dependency-name: ini dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7fb566ab7..9ad473f75 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4973,9 +4973,9 @@ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" }, "node_modules/ini": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ini/-/ini-3.0.0.tgz", - "integrity": "sha512-TxYQaeNW/N8ymDvwAxPyRbhMBtnEwuvaTYpOQkFx1nSeusgezHniEc/l35Vo4iCq/mMiTJbpD7oYxN98hFlfmw==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ini/-/ini-3.0.1.tgz", + "integrity": "sha512-it4HyVAUTKBc6m8e1iXWvXSTdndF7HbdN713+kvLrymxTaU4AUBWrJ4vEooP+V7fexnVD3LKcBshjGGPefSMUQ==", "engines": { "node": "^12.13.0 || ^14.15.0 || >=16.0.0" } @@ -15157,9 +15157,9 @@ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" }, "ini": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ini/-/ini-3.0.0.tgz", - "integrity": "sha512-TxYQaeNW/N8ymDvwAxPyRbhMBtnEwuvaTYpOQkFx1nSeusgezHniEc/l35Vo4iCq/mMiTJbpD7oYxN98hFlfmw==" + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ini/-/ini-3.0.1.tgz", + "integrity": "sha512-it4HyVAUTKBc6m8e1iXWvXSTdndF7HbdN713+kvLrymxTaU4AUBWrJ4vEooP+V7fexnVD3LKcBshjGGPefSMUQ==" }, "inquirer": { "version": "8.2.4", From 4fec3f4580552b4e8bc9de0bdc5e1f9422b0ead6 Mon Sep 17 00:00:00 2001 From: Saad Hasan Date: Wed, 14 Dec 2022 17:10:07 +0800 Subject: [PATCH 11/36] Added Another Use full example with Screenshot (#1557) --- docs/GETTING_STARTED.md | 11 +++++++++++ screenshorts/show options.jpg | Bin 0 -> 24291 bytes 2 files changed, 11 insertions(+) create mode 100644 screenshorts/show options.jpg diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index 1fc98ffe8..c1b062c29 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -83,6 +83,17 @@ This is the syntax that describes an optional parameter: If an input is omitted, the default value of `5` will be passed to the function. +
+ +### **Show Options passing Value** + +```js + * @param {{status : "active" | "inactive" | "inprocess"}} +``` + +
+
+ ## What `documentation` does, so you don't have to `documentation` does some minor magic to auto-generate documentation. Unless diff --git a/screenshorts/show options.jpg b/screenshorts/show options.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cca24e34b9bcf7d3e12a30ea1aa3ffb3b2fd2fec GIT binary patch literal 24291 zcmeIa2_Tg3-Y`72>`V4+Q`t#UmdY|zNRpH#gd#ghw!tvSlD!BaMwSpmma#8cvV`np zH)G#t2!k>6-ktN`&UwzWecw6n`@P@uA1>~hxvuNJe%EhbuAB6oGz((6rJ|&&&%()a zl8v2%gM)#Yi<^_3o0Xk|{pTcP6u=ltDq1QkT6RWyM)v>qi}V?Ek_Oa70iqx~3nD*B zMsbpi)CvNFKx9Hmlqj1u*MVAG_-W|KnD~Hh@6aqf}E1#=c<9;e!%x2%9B*A zXJph)u<1RfKI_VUG4SadL5=;t>`R6%&_`m6KPveC6u( z8|oUGH??lv*EcXUdSGl~^~Bo7*3RC+&E3P(3+nCjA~+;8>}7aFT>P7a#H6>$DVbT> zIUjQK@;{cAm7^*utEy|7TUx)gwRd!W9T*%M9vS^UHjc*3%`Yr2Ew8NNws(H)?(O3b z4u8T$2Eh62>#u z_a#lVf|u@LIV_*|({T#PqJ?okLHi42|24pZ{vSd18(_b~H4b8+AOny`aS{Xp5e~*B zd>6n^t4N@tXhP5R`!n$N-S%U5mqo{AX1?Nb{mra(8ThCsQTy)D76~Nq*K1Xdy@&~{ zPwa+03A7IOBZ0ExMx>na5aP8#66m|i5ecLvoMG28E;cT1mvPOR-I=}oF8QDT{_9&n z_B$RN=+cjfkRr%h7W|Sbi~jFOxci4|RTjgU7bMWU6y*5DR^yL2lU8ISH3`&V0zaaj zfv*UaGd{J{Q)j0U%Zvd1-_#_0xA4SYXjAR?J+ULFOCy2i+N2McNuW-LKfVFJn!v&d zA-N>bC%=7Soc4o+%2^WVfL@mbdUUjPER-0C?7k(I8A!#hr}}?Y(*^hpJPO|JZ%odU zd_SCi*+cOSCzeG>`R?6I>G?B6B};&ZV+o1H$L}Fa<1@tLp`K?5%gAFM=G|Bl=-hE) zKuMUXKQjsRs+JH0d_NODSXj;|_$m|C z(1+OBa3O*GmyfQ&dr^(YM;V3}?T{|NjZ^up1N|vk!^&|sq92k3+L{8}=^pG=l0c2_ zR8c9CrW>>*kje-Nw7*$oSE?>wV#PadS|f`qkkp_#{i!44oLjlkd%us;ht&2ncq%Xn z#HKl(Ndjef0(cJ4BY|+T%x`waCHoqNxsEByw+Q3_Na0xkeV5VnA za)ZLH;>3gbcMK`>`7ia??q`maHO>|}^4z)mW((EG_Iddq?b%vkTbm9Caxa(!LO8;Y z_BDUoJ~Atjh>>5nJnQ$}3n+$wNx#X=ZZKudi6MN9ng zjh$F%1x%C#I-^Abtu^lh_KJ0(!x$Dp2mwAUrk^<$P7E-8JEW%$@^xw18UwfaU%(z0 zhwo0LiK4e&JSDI5A%P;LIlqa&nmfS`Q3`&M@R@G%adlDcEOW5`DQE%4V>CdzPR@Rg z*Vm>VTK6Dnv?AJ<&os*Ev@vYGs?DWWQFnCL^AL|!V5=i zP*Dt))6bMTI`}9O=|G=z@Dw=3CL;53hP0Bd2Ox`S!a^1!ewZ4&r0lOpo_)=y*qj7= z!r1EBS&%tic!2D(b*a^!DSqD)8=1&t{*ACYA&)Ra)@;Eg`G$+belSOwi@5hCwSei? zH;`QJCL?9f9;fRpoh!X5;{L`EL`CG`0Ad*Ri`AZa`fDB z`s$@qGF^Nx4I<_Rs+OTeUV9!m=9YSDE!<6<)rx%jndHYj23s#>?d43x-pK5zg^($B zv~goE?^91E&4o2jSVa3%;b7*nsG}3f=%v0*KuBy-R>Z+0=PP*CCpP$Di zlHg)Jm&U^@$j4*d9+t!9TG1_$y`DkNjN^ppJ>&{d(n0%a&u&)ErujZ}VS3o}Q6z_I zKJod(8?$HguL)AV*iO%?DvnQZa=uwR_5ADAyn2J(QhNpKn$bmAWUGxq{`6DrMAzCV zVOuWWvCH|2_8zvY-)x&nAbL1jVn~kua-A_cl~(Ghe-G~}R}bsdyH`BmSDW`^XeshA zwamc?O3NV?8ErJ2tIL{t4;Gcg<2YHPChCk=`0j{_gFlgZiH=v}8p0eE6->J~Dc9Z;Uz2LFUpa zLa)y`MOoFRBU%TeTwYYDqT)orY#`?~D zPna_JmgE**!|ql@2wk7Gpl#?ou~?1}og^M1Jr{-@hI6G0bGs2X@q;-7aG#^zY;;Xu z>tOydvOC4o@Q(OOflf=p&CD>PPnAZ2eZ9YZo=&$*$p}uo;yS^b~-nI z1w4MO%d#YKn$}pA(c`7+%P3nm`?ep(0%KM57$D|b+2CV zKbqw{^{tx(;&=`@33n_$g&%D3Qep3RE=Pc%63;q-)gV*GuS>9XB(#5GEI zjlko1iif*q4RuvV9_?H6B+!GIHa{K8_~Ueo1K{0$XMW1GMTz{E{Uq??$o*}2A$(3HQgu^z&l|oJ4>(04fRW%LHZ0l=C|v=r#%B1^h{>YL z?*pBo8rz=3x!nU`e9{d36kx;~+fjan+a?jcA;;TxM@o%5oq#VCukZi+7_bxI&!%s~ zXKVtheb={1pkBb_XwU)wGRPrz;yh%j4zWL$wUGqgnbtj8@8gp8`xT6=-$&>jS+^7R ztm6s28xj*nT#^xYThA-!23WOrX`tRC8KOZDq#-&BC*<)qSGJ|)*=%Cu@JZm2uENHBXe*d|ZDaCEcH-r1H!7QQyDs2SIZT!k6C7;5noL*{1Q{D(E+6 z`ztB_W&9TWZ@Os`&epgPc7Xel=a4{{yrFZ?EdC9znr;1EufIbBPspFx`V(9KfRX>? ztv`9|7lHY|QxaAKqVZ`0AVO_^iqOWNB2>WnH+lQJw3ZGZTJb+!kE)1!FdOw@_+pur zSoXG-vQ}Yl#Y1?nH)N~qcGCNQr9tw$y7>tC%?677_2#M%>;J)`HGj2O`uDnG54J>) z_w49j4eih1jsfG%jQ1cVC>Mxh$F9X5F3)uLX;A@gK5mZd*d0EP`oncO8P(qe($AaT#rB9S%z};`H67#sk)4oGp>hAW8J-T=` zcils=1|9%+e)oaU{6{c5K{>U>A3W&MA?K&?aKL3TZdwru>AhR3L1t~8A~uo5q$)UF zAEq;cs^wQ1pE!bBScu5QI#+%ID;zWrVp)102d-Gd-3*?Kv zeT6J0E;y7GKF#CENoO^9`^snboqOIrFWJ(PZm7bnZj8!lJNP&e+z%;tQn*NMT6MD1 zqK^DhC?ue8iy9`1bBRUKA4xH*r)*+cAdajTRX?%ZJTtCgaQ_ulREcMQE6_)w#f(}V zYw^;52E9L;=$U%2c0}&rT+z7)@}P*Ro2(4BiL*y9+S04@p>F0S__EpWFzXEaq?)}P z0p#PnG&PlWCF6(9gW}`JZN7X+d*9C8RmE~6iIRmzW)jGHhTUO?wGgI^iN5G3(DX*f z&6R(+0nH}4VHblDI(S3Q=6Y(LZmG@{%iB85io3Xi8Q?+PH~d?ZsCMD zBS9t{6m{rc6p1EuVTlFWRksYf4^Wn+pSB_(lw6-{ECM#1 zH+DI2B6T66p_{Ay8&OTKUD?{^$*SAW`<(1ptcI%4;s@rwq!fq7-*DMTJ5S-}P4Vzr z0mCDTst$|C=r9e)`(iWvRF;W3OcL)akUGaqKV<>EeKi|LT`sI zcTo$5`HKsq7B*4cJ#Ao~Bk0A{vdrXbgy>>xl59UK`}~YVM+?=>*&s!p zBS9_PXc%gX33hd~T)X&0dlBCMi!+0O(8!0uh0@phl1}Q+;>4Ferce1W$JLqTX%*lL zOd8&(3fI)9cyS_Y&Xq^CKi;gv`pFp4UQu}dB<}my%m~SQ|1Pindp!8x{k&XKrN}Q6 zvgIEdpp@D+vn}rc+0rC|GUG}l9owRKznFycMfa0H%jJb8H?*H+Mu^A#(Wm85-Y38x z!bdfTHW~R_jdO={#2SSiS+YNfmVdsOsoe^LZ&L&AeKFvHW(Yr%^U}sq5fk`IOnMhI z2A)cm=qjpiDuq2<%67iZYHjBt6WkrNTwprmJWZga< z|IzfSZUSlQ-mwG`lXe0TJ}*Q9(LvA`M<7c(Ku}#2f0ysiyZ^cKe^T9li{mbRA%V6p zS&%?=h(jsIv)MIusdsDBF=#?(TIk~EQ_X=B-}T+YeM8vwZmX%Y-zEFC{azRGPpuW% zXAVP@f}@olqt`6h9Y?R~wlq>rQpG`7pcObLOfoMe_g%s^E0YmO(lvCkmU(Qyi3DO$ zGR9q7L+|c~IxE>aJB=1IN8UT!>o2y7bd3(C7t^OC+lp9FqBt^#X0@dAmtcz{Wuv(; z7D4O%k6&oulvBD#N&=%yzfmWjqzHK4q{>a6cBDeMi}iW|x6|%rpE3o+6&P)tS$d7wj)@R37a!>io%t@)M2@zKs#l!!tDrsA|9kR@RcYLB~f4d|y zlc1~{OFZ3(Xi5k76Tx;V$^nRbRYP*d)89^3H~MUM)i*s3U}u0O@8x|sYsexjv8yejg}CmjDf zEzTUb59f2J>iRET^sZ73b4T-pnG-8Kx+}J>-gw zd_NQuZP^O^d;HI0i&C@9@VSP4gwx|l!XAssnh|Te#DQ>d{DlW^X-caYYKX~-Y-}>A0nf3Ya#~Di6*tI!>hBVBPEYnE95VL`G;%Zs z9JF${o@^G@OZjR$OZ(}j77P&tj}+G$B(Qt&g_DlvVC-;FiAb40rY$)^myjx@sS)1 zfB<|_bA?yUbl3+AbAE>j{j^H0lLiL#d_fnp!2K$iju0uAyb0!^q5-j=4v_6?&& z56fBjSmaO8&B%OHZC7>dYXCvJS|CjRLeNlUQ=`WjGb>3cH%#h0OE0vPuD@+1dq#76 zqfG;yzKg{65zb*X$}rq61kD_LkhjwrV%LbA8Tq2Gn8^8Q2e}g7w;Qymj?bO@)V&@O z=v4#HH^tnj?39MeQZMZfh`@zg6@s+)Pg-9wQ)~Nr&tyf?e8sr7YBRCxdhAf6?G^`+ z>tgv~LEU!FgMP|ExN30AY13bK=#*VjQ_&u;D(TjG;&f=$yxBMm$=P+yExMWA=a7vb#D#H)<0 z;?CP;wD&-%uu_BjkAyIHG{`<$u=@+)CBK-n4_MaVU@P1KXr~grs^~0lR4c}(eb%GTt%@{NuKduhN!~nd?K~nx%P|knM)^%P!Hq!r%h_x zM(jnO4ArIeFHXzj={;uY{Zt(qWUz?6oT$f({j-g)H@984skSRNmw-?%m;Uiv0;`e- zw!ZL()3QmNas|qEuln0cPpU54=1jHP_>6ntc3=#u9lC=leu3HwRXP0$rx01b^^$ld zPB`{vT_tusQ6X{LHq1NuFNw38l>B2w6U~j~`++}tBO--2OMB7DN)RjXcn_+H#o{yn z&6Dd>ad8*Uow&?*=v@^tmT>FV-Fu4Ko!^gBl zJ=jwQq_r!7B(oy;GE5oI>x;YiRbhajhxT>8WiN19)^tNHv;Ix7wN9|x#9|>c6-;JC z$#%}Mk)dtm(E2#9%C}nXgmui=qiX|6-wWG$Z#L&&*)ZS5hGDpxW9jj3O=VpkS@tHV zs71d=tLFT1#6x?^fGoAk_eww~G_LTurYtGZV|1CMH)Q6NuZ^~HK40PKzWTmw=xKOa zNOpB#vR;aF?S*gm-DX)Y^+oJ|!l&%Yumxj=3^qKR(<;Yi+}58HY(yI5Q4*ixg2r)< z_Hqrq+Hwnc?_PprEHk|SJ~oL+z6K@)8W60p4RBh#?JXQ*Lv;=`^2ShZ;)rCA^adU0 zgXTmHV{~}Ug?Vv--OZXijTn9f?Q)=eEjYC`fBr_vMmc^dtA*w>1x+f`mmd$`F4ZF$`AigXBq zmN{y}MUMX#eM^pTT`_x#U(csk9cjt@mCghR&mut-+uNFcxvaXTUv{QqVxlU>SP7p+ zbF)|RyXV$GJ=Y$5P)e3}t;g{$j_HN1i*HV^BOlwUp61osi*wIqD4E|769hu{%vtg3 zb3IIRrUSV{B8hCQV>3cQt|8yL!KwT>%}cfPl7c|}X2^X^0!|IPX0M@a^>v5XD})o1 z0kRfXoU{EH4MrOTps_7ihl}F#RxVx7GqdUl@$6ijpLLeFsdUJ*uX_^S%sdBSv+w!1 zT4TLGrUc=x3^Kc^<{~uvE<0ZQfMzagDLuhgAIBByE{O;;iEuFCM)fVm@ur$GYHsL| zcjRdFwAOxn$LiPc#;s&K>q~LN3Fw?oh;>!pR}C|(bLZbXN41hQGH=IdN(D$};r7>$ z^PpZj1DiiGp0il)z;-+KKzjE?Xma5 z(LO&c-LE%cie}Zw%m1z10PGrSut5lVzu9Qq<>e1Wqe1t^vzWoV4G(OYGM=$)`-a3A2eRN zJtQK(H<+C_F;5v?d;N(3^WCdPg#?*CDR(#s-!`z-I?We4XI2ub_+Y~D<;73aH(#-B zzpnB}xy-iZzb}f-hZ?nxx1~~EHOytoaQpm`!ObFpncU~FQdX!S};)pI2C#aN)M zG;$tCd3e@tef$jzvb8@PGr^;9t+&=;sqfv0bc7PP5Gs9_^XhQq_sLRP4&#Iu;+vPVRydK9V_|McYkalux7%P{5)ke#2Kdc z(O%QI1RFAv*T2RkKcRi%0j$3IG%J~F-xBxbRiL(Hi;EzB{J!uKy~c48@3aqoXth{wtUk->Z!yfx;RD@T0l|f~7T; zBT6U6k?Z$`oU)sIUMHTcz>p`-%B;jmhS$6buBmNEg&FRyRCEoED3!WySnnUzs7&dm z5Gang@cWpsFqmKw-f~HE*u9shU-tsBBT?4Y6~=J=E3ZL}5md=)>%1Sup2u-K zL3l2ffnb6#$Aty&YS*)A*Xmrw%-pYuQRICYPQLf>Ms-E6#+gzwMaRtJWTFa89IuE? zcVWQ4X!VK7^25<#pak9X?<${t2y}Y-duE-o5L?IEv3;2ACGk zwprjb?!G$Of@9gpgd;Zs>3*=FK6x|7rgB`k>E4~mCnsaxjl_HKqyN}fCZb|92>F&RcK2IS%0Mq-kTpyeEub> zz{aUGfh;)|M7cb6;M*H4Acxn%rq8uEGNN2~wK2tH&^3)9-dOgPaphLDQG2Pp;Zz$#HBE-z{_Ebq- z>?L7#+l5t!%KR;h#IF-bkNS$Qb2nvzmn zMGcV?pNyvGf3T8*EDrPVPCHw5*Ud%oqXv!-m$3XyF>2ZWJAw(uF1~W08HcUj!r5wzI$g3*--xAq`C@JN8sg0Mo_P%-bF7aa4!6Ct78b}SvJLiEt-`YY zu{UWR*r9g6kpKl;R5S2_)E}=wKZU~IRFyljA{e$!OQ6|yZwt;mv1A&ddf-PR1iq^S zy7-?3@ZKVPboU!GatGPAw21pZ*h5t!#6FzPj1U9;A82IZ``ILr?;)MvFVaspTON?D zGJkVy;E!ebe>|=L`r{t`@f!Hz`}fJ!q>(*C!|kc*haI0VYlfmQ#^%d0oY8n@|k3xX?XuD&q&wX->0fo{n(rHV^C5BetdF2Fsq3Lqrgz z`x-b+Q@v6q0M*CkgX*V{EFBP;3c5pkj&9$i4^NF&rvD5nTWWQQoR;i&Kep7;hq^TH z`Jl4BPAdNhkd1#ie=obO>NG%kr*p7?E_a_{Mce@{+G0;E!&%qU2F8^gRz`0RI~%+O z`A-O(__BIEfJw!s&3>k$J+@A)a+)1)gvAhfNgxpPeD6s!lgXS`FRysSMPt~|!IRT0 z3S|3HK~=dMa={HFDNad7(;N2Vn`<`iEpe+BT?LIs{hp}ZttXqB*w8^VB2tANKVve~ zz%{O$hu6G~O8!6`Z?LHBSl3Gq`butV?G5JZGWjq*xfHG9yD)<6#93Y%U}=j`$uX& zjtsF*7ap1y++Ny{=|MOpxzdc9|kH`=Xh^sk-6{ z8k){aiK=WAMGDNPWdZqu}jPkxz+0#f{B*?Yf%^ z(QVgbt};D?7L*eE;0!R{IqA@==?NGug4zdr9tymLUbyVaY*pyl4Eopg*V6T2AGMm4 zeGIO;7o~Wac+AYzA33~VPTQ-mZm5o3DEn}LBoxgsm=o*9EplRc2H`eIeRW!BdgS%i zbatFqm`k0yW0tvQhC`2Js5h6ptwi+Kr8h!ROEIWi+|iyXqUkU<1~tPlvuq^5-&fS9 zllgt7Q+Y3qA)BWAB2d8i%_8aQVEWhf~(_`z~M+|xg+D;O5&H=ia2_M zSBkf~*Fq)B89&lq>G)B!^#DISTbp&H;qCJchZ(KBDlcUNcBB_fTt$eGf#J^L8cebF z=WQF`oU7YHHh8YOUwxZne24L?%GQ{p_t^5Dy(2umJ;lDU>}eT>nQ{^uc@3u!0#lPK zN|#eiqt_Wq(YZzQjD9mXgZCBq?FpqQhIbSz3W(CZ1Rx9mnCWzK&J_2t`ysnMPsQhI zJ|O%0F8#-PCxhff{-Tm#R7PgOTE9Rllij3=Ki_xyMaw z=%)===*g%T&#utFi&LgmvLJ{+Xi&Oz1fj}d|1+fu0XbE1j*2=w8#zM||5$E~Cv<_q zs)Y7{@3RpTV*`NmGVZaHu(4gXLtvtgY#WM;i%KZovv{zaGU2Dx$cDg!v5hS}iO4ww z8Fb?FYlR3U#T*B&;sUt+!-8#$f~Z)-vkscEv^gwv;>J~ zYk^>2tR1SLtRIb(I=D@>xKT}ZG3cI&cRRx{CaiG*+0@G~A9-}cPK6pDf|jktJx#(i zp7>&&XTQ&a_ib^`{(#``j4GpvIDg#3Q!;+J#X~d&sA(n`V7Jie;nXjb&R~+2>O+Jm7wxfFY%6|(i^J59x_6{LE=IhmXaR!Opp2Va%nH;YlR3{*x z3^^71B8#6MPLK2fi4$)BcH%i~XcEQ|v9ZPAsL;S0{BSkpPC}kiQX)1T)}|4yYSySA zdU+#VlK0wist1AtFK_0hhJ%E7bXB?U zrZ^0!>Q*@ea~+1DB~tI>j9!*^y4w-1rocL!vlHcvyxzu2y?Jz@=^HJ-qb6WPv=s+V zGYp+OFPmni)+gJNbsUWxZLVbe*siDY)g_5W|Q`lU0g@?jmlh8$DYdX zIBub=rJX+#B~k!&>) z$x*5(F}H`?-7RfnFTL2ypwl0A=H`B}$AAYAc3Y`2%gH4OO$+Ou6^?bzZC4iH)&Oze z`0gp4IX~+f|In+g$B+sS6sn(}GXi9ysUMKaznci&IP!BqpY@26)Nvz|=)S3ZEj}ip zJA2ayDan`A+#4L$=2@8%lS73bh?_Qw&{0|Ze)Gwl?wE-RA~@R3pABz|(d9FqoU%)C znQ-2i)I66C(+d`|O@9t8Ch|;Z9p|YL}arY?ymu@L9=IAqlTrzhJ%E*r1_v*L66) zc`sPSytlLw|=iV^WalD#SX3U{!~!F57Jp*|P6%N|yFT1q}a zyuQ#k@v#@M+)Dwj?^15vhUM)*^x z#l)Zm&6jqN69j9F^Lc*FJN-f_-(YXE-j zD;W37Nr%cGGWINn$(LoXKEGo%A}22O_-&G+d(L2*w)mY#d~9pqG0Czi3L(U^##2zP z``8hLtH|4#@w?`$ygxAAU2o&A52aUeqkY{)FEQzRi$*l?uMz1hL;WnjDcUW%@o;ax zPhF%CVu|@qa7-;W#`io%bGz%DUAtu_FwuJd=8O}n&xNrkFN%p*nSF_m`TppsVv&N# znll9#G9x5{{}r*1U+4VQ3-};99e=#FEdC?3`R~1x-^&E#sQ%y?WY9=>0d-2;jcZvX zkZ_*lhrYd{(5T0u8ValoU3ArGD7z|Y(TEQT>j;Yltf0x53?Dkl z2&^a}+7PlgNCK&&I1UszvrGE454ea4f=6MWH=u4TGeD_G5-~MfK#>G`{qcx622{$R z3V}NM*i-PeOt=UV4oJC0Y~dhMy|ozqZ)VnA@N2lS8R`>nX#JNn%lZuz!80| zWccV|T_%U7v(qka!KR;l+b zO#Mg%zt&Py8TKRes`_+o!E$F&nz#pLW%}2tF@qb6b6x7sO*bWF4s>%K<9C2Vk3e=% zS-|;zYl>V&nk}s=e%NX8mCI@A&AEhkFJ5;D>{`t2e~E02p5dy~p5smH6nOvKzl$E; z#cO@=IF|oYpj*s=^4b{OUWdH*iv?;wRMt#2;nNV8W_i__3WQX%q}xQ0V`i|KotnwO zo46Ur9l60wEq@iw^ajZ9IKp- z?nJI*dl%Ynd`$H$Sn}#V;WHAK(?uow!ydJqB@W*}@@dP3Oj@5v0ZdhD5=bQW#aiYI z^w!JsFlx8C%Ri2%c`EC8V3iH-R!$4oDaUHPXJf9-O*e!MOaA}|z)$$IJB*ltUXaPn?4>Y zDn((R;mj!DNdePmW3OR{!}byjgj^&h4*I_&=p`yN8Zxl1z=2f>UU8$4Z_r7kQ` z%hkngF!KpBxdr{ExG7^b{YRRQ`vkJ%Su)EPeWzdpN$Ab8^a@w*!NqKpYt2!7*}s_Bg`hJiDn+7AW^Hxf-Aj&lT!At!HV)ZL~& zY|bc|^gd9j{&rjlnb*ai_Jud|I}<`|FF$WdMPeH6MJ6qK4z}INfi_8scBiaC52i;B zz*k4J0Gr(tABMYh-ORS7fj4gdw)gFmliF@nHQjR`+ZSt+X_}6z=T8n9ja(fKCUOxJ z>aa5*KqO#RQJTga>Z4FoH*_x7*~dFug9N%6fj%Q~V)g<>6l}V=u4V4@(BNlq*o-fE*m;Ztg5srRq9Nen)K|O z>~Ac>nm*clr3mDB>vCRVf zIDtwljFigsmEAOXMO2tyLPq?RQ-bGa&bwBZMU9@s^oD$x!F)l4*GZu*D3`~bh)m@p zr~(M*1Vy&}!0q+A8)W0{Uq90|PVW|Sa1L*wig)f}VehTY@!L+DF47Qq>^(?-(LihErB$b&K>3_}^r#YaEdd}9M z1yLaAMV7hEq*~1oGAbUzmR`sj>Xs&R@2UZKVsI zYifQgv@-|Vl3_#Ul|QNImOi{{!G$gd98aT*YUkv=M)XR`<5rCm^Ov1guT?W(89-~V}nG8l#(sQ>o8+${tpK(nIj8F`Z|@u zDJ-h9JLTlM8Chw}2?*tW^CL7otbu!&z?S`R*@P-A$|EsAE6-FHspag(mo{v9?*z3H z;?6GGB-r2Z{qxYtap#1vvF~w~O%QR>^s8gLLDs$Bxn$O45a(}oz(>>f7&4J#Bum?MP{QQW@~>L9_arZ zQbk}Sf#RMv9>f2YmP&z%zJ}kuZ*re)li6)^&q)rd+ywHm>gX#ruLZS_u5Dh+J6;k3 zYWO9Y0_c9ko`At{3ITxA-GU~*N_@3qE^gOzJV&e3r`~226)rFFiBh3Mi!$m*dusnJ zEv?J-ZwJfnnPwElwn0w9)aSNXMH-77bi4{RUTY-jwY@4Wd_?&tm4SGjQp2gZno&Zy#;!xtL|vY*&L;_SO&BOcvgl_{x0L%k^airHZt zu<@M0k>h4aWSzi;_^ygz)7;d@j*{G;KO5P;Oqx4t9gXfc+7K#`S2*{^RnUb6SJ&YCPNB-{3WD8s8u5yf;u$tS{pz)@Yq2K&IMUhKGQa9h#hrNt?N zE$$w#7)-ZFE6-$XX??Gxg`@6d{G>YTN86cGNSa1FmzON~lQ7=n#zm-yvw5epOy%1wMcl_A%UKllqny;|fOz-2g* z4Uv&cjCEX|oTDN_g1iO`(a9Q@KPxdMPzS>88ebw9-G%z=lrdW8$~)%mGbv@pYarlA%L)zuBwbIGM>*)OrVb|HlfOMJAnbu-(tBz5t zxPPO4`H@yt_-o3d#hc@TalD~RG1Rwqx-7;`F$TqvC|x$u2pc~u{XplZ^C{!BmWjeg z`SYdRpZR8~xVwDb9VD<<&!+)&5tvhc;P3Q}n@`ERnDQWPYGAiw!c$qXwXwXtwV3OC z{Bb_UTR2{;hAZ*Xb$b`eitT{U9C4S2gU~N0(yHe8=yGxNd%?J^){T?pjjU^TSLI!l z+^Tpy3eSJ5lRPCD{_qv;s$;MHFD(BiS6n1jK9n=q`jkeBj&tT<-;XEw*7F2~_sfS% zFX|we2R|P0jDK4^-pWikYb*T;c;1Nc<#XPW2%j?aRy3yy+eqPVG%va_cwJ8WiqeE* zPO8DH*10Sy-^Kf}*J$>NFJ+c3Xj)v7E1x;398))r?1@fCO4fD?ap5>a#>(OhZtY*0 z9knQiIW^!I6GF;~{C#JLy)+eZ*ImSXJq#H*Xy44jGTc|pJ=7J?n5Bm)v@?48Ikxg- znbo2cHte79nOo^kMouA}9Q0G{@6GLX-`jch&0I;`)-LeYo~*W?UfZx|I7R3;X;#VcFK+yeW1RhG z0L{z-oYhrM{&uPNA#Nmp)q?$eQE{QP`!U-M?D1||`?z5BfU}9HO}j={h0%D`SFr^( zPfwyaK3^d+Gj+qC7yCmY{${DRpR-M;V#4X|iH;?1rRR(mVRIftgbTFBC`{=}=0h{p zkuC4s@1?g`c0oy}{SB66^}dF6_p1F&5o#kCgi}|DT-Zs4k=HbsA(d7V$nL1tD{<$- zgP2_Ywcv)jRK2?NP2kK;_`LlSn3bDMCnPz~F84`@=fBCP{*xce#_(68jQ#Kl!W~`* zd7C@1suHNqe*cfr6tenR-2YEg9tioZ5gLC? z30izfXB+l_u$VoZFgbXo(t}(){q3aMEJDw?Yu3-nqyu4j5SdTWb0HKQFTqh!2;{bTU^1SxC(^Ah@g$23b0W z6X<}zp2Ss2IK%YVDrYZBINFRqU4HgCE#K_CksxqjPy`sD0y*G;5G5kSNg(9+t@*Gi zY2r69e`9+(q&yaE0r1Wh>#S!xF?58#;4 z7d>_Gny2EynSBWHCglG&Fgm4Ej2dg4^L;_Afmi@U6uVo?Pk40%kc3Gk-cL1Lcy~t*6dCA2x@q_N+J@)!n!9Nn`&DN$t!B literal 0 HcmV?d00001 From 798fa10595d7523032ac187ae9c8aa943c15e8da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Buscht=C3=B6ns?= Date: Fri, 19 May 2023 12:27:11 +0200 Subject: [PATCH 12/36] fix(exported): respect `parse-extension` & `require-extension` (#1484) Fixes #1272. Fixes #1258. --- src/extractors/exported.js | 48 +++++++++++++++++++++++++++++++------- src/parsers/javascript.js | 6 ++++- 2 files changed, 44 insertions(+), 10 deletions(-) diff --git a/src/extractors/exported.js b/src/extractors/exported.js index 4470cb452..da6f8955b 100644 --- a/src/extractors/exported.js +++ b/src/extractors/exported.js @@ -15,6 +15,8 @@ const traverse = babelTraverse.default || babelTraverse; * and inserting blank comments into documentation.js's processing stream. * Through inference steps, these comments gain more information and are automatically * documented as well as we can. + * @param {Object} config + * @param {Object} [config.extensions] extensions to try when resolving * @param {Object} ast the babel-parsed syntax tree * @param {Object} data the name of the file * @param {Function} addComment a method that creates a new comment if necessary @@ -22,6 +24,7 @@ const traverse = babelTraverse.default || babelTraverse; * @private */ export default function walkExported( + config /* { extensions?: string[] } */, ast, data /*: { file: string @@ -120,7 +123,8 @@ export default function walkExported( local, exportKind, filename, - source.value + source.value, + config.extensions ); bindingPath = tmp.ast; specData = tmp.data; @@ -181,16 +185,40 @@ function traverseExportedSubtree(path, data, addComments, overrideName) { } } -function getCachedData(dataCache, filePath) { - let path = filePath; - if (!nodePath.extname(path)) { - path = require.resolve(path); +function resolveFile(filePath, extensions = []) { + try { + // First try resolving the file with the default extensions. + return require.resolve(filePath); + } catch { + // If that fails, try resolving the file with the extensions passed in. } + // Then try all other extensions in order. + for (const extension of extensions) { + try { + return require.resolve( + `${filePath}${extension.startsWith('.') ? extension : `.${extension}`}` + ); + } catch { + continue; + } + } + + throw new Error( + `Could not resolve \`${filePath}\` with any of the extensions: ${[ + ...require.extensions, + ...extensions + ].join(', ')}` + ); +} + +function getCachedData(dataCache, filePath, extensions) { + const path = resolveFile(filePath, extensions); + let value = dataCache.get(path); if (!value) { const input = fs.readFileSync(path, 'utf-8'); - const ast = parseToAst(input, filePath); + const ast = parseToAst(input, path); value = { data: { file: path, @@ -209,10 +237,11 @@ function findExportDeclaration( name, exportKind, referrer, - filename + filename, + extensions ) { const depPath = nodePath.resolve(nodePath.dirname(referrer), filename); - const tmp = getCachedData(dataCache, depPath); + const tmp = getCachedData(dataCache, depPath, extensions); const ast = tmp.ast; let data = tmp.data; @@ -273,7 +302,8 @@ function findExportDeclaration( local, exportKind, depPath, - source.value + source.value, + extensions ); rv = tmp.ast; data = tmp.data; diff --git a/src/parsers/javascript.js b/src/parsers/javascript.js index d4a72399d..880af6547 100644 --- a/src/parsers/javascript.js +++ b/src/parsers/javascript.js @@ -24,9 +24,13 @@ export default function parseJavaScript(data, config) { const ast = parseToAst(data.source, data.file); const addComment = _addComment.bind(null, visited, commentsByNode); + const extensions = [] + .concat(config.parseExtension, config.requireExtension) + .filter(Boolean); + return _.flatMap( config.documentExported - ? [walkExported] + ? [walkExported.bind(null, { extensions })] : [ walkComments.bind(null, 'leadingComments', true), walkComments.bind(null, 'innerComments', false), From 3bc4024c7fbdb4e2914c16e643b109a84a3bc898 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 19 May 2023 13:51:17 +0200 Subject: [PATCH 13/36] build(deps-dev): bump prettier from 2.7.1 to 2.8.8 (#1598) Bumps [prettier](https://github.com/prettier/prettier) from 2.7.1 to 2.8.8. - [Release notes](https://github.com/prettier/prettier/releases) - [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md) - [Commits](https://github.com/prettier/prettier/compare/2.7.1...2.8.8) --- updated-dependencies: - dependency-name: prettier dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/package-lock.json b/package-lock.json index 9ad473f75..f91faf7c6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -45,7 +45,6 @@ "vfile": "^5.3.4", "vfile-reporter": "^7.0.4", "vfile-sort": "^3.0.0", - "vue-template-compiler": "^2.7.8", "yargs": "^17.5.1" }, "bin": { @@ -9504,9 +9503,9 @@ } }, "node_modules/prettier": { - "version": "2.7.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz", - "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==", + "version": "2.8.8", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.8.tgz", + "integrity": "sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q==", "dev": true, "bin": { "prettier": "bin-prettier.js" @@ -18376,9 +18375,9 @@ "dev": true }, "prettier": { - "version": "2.7.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz", - "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==", + "version": "2.8.8", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.8.tgz", + "integrity": "sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q==", "dev": true }, "pretty-format": { From def97138007f22aab267c22737db26dd8ea9cd0f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 19 May 2023 13:53:56 +0200 Subject: [PATCH 14/36] build(deps): bump vfile from 5.3.4 to 5.3.7 (#1592) Bumps [vfile](https://github.com/vfile/vfile) from 5.3.4 to 5.3.7. - [Release notes](https://github.com/vfile/vfile/releases) - [Changelog](https://github.com/vfile/vfile/blob/main/changelog.md) - [Commits](https://github.com/vfile/vfile/compare/5.3.4...5.3.7) --- updated-dependencies: - dependency-name: vfile dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index f91faf7c6..f2e06d668 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11111,9 +11111,9 @@ } }, "node_modules/vfile": { - "version": "5.3.4", - "resolved": "https://registry.npmjs.org/vfile/-/vfile-5.3.4.tgz", - "integrity": "sha512-KI+7cnst03KbEyN1+JE504zF5bJBZa+J+CrevLeyIMq0aPU681I2rQ5p4PlnQ6exFtWiUrg26QUdFMnAKR6PIw==", + "version": "5.3.7", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-5.3.7.tgz", + "integrity": "sha512-r7qlzkgErKjobAmyNIkkSpizsFPYiUPuJb5pNW1RB4JcYVZhs4lIbVqk8XPk033CV/1z8ss5pkax8SuhGpcG8g==", "dependencies": { "@types/unist": "^2.0.0", "is-buffer": "^2.0.0", @@ -19516,9 +19516,9 @@ } }, "vfile": { - "version": "5.3.4", - "resolved": "https://registry.npmjs.org/vfile/-/vfile-5.3.4.tgz", - "integrity": "sha512-KI+7cnst03KbEyN1+JE504zF5bJBZa+J+CrevLeyIMq0aPU681I2rQ5p4PlnQ6exFtWiUrg26QUdFMnAKR6PIw==", + "version": "5.3.7", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-5.3.7.tgz", + "integrity": "sha512-r7qlzkgErKjobAmyNIkkSpizsFPYiUPuJb5pNW1RB4JcYVZhs4lIbVqk8XPk033CV/1z8ss5pkax8SuhGpcG8g==", "requires": { "@types/unist": "^2.0.0", "is-buffer": "^2.0.0", From 3ddeedda2410c6aa5e10bc93eb35db55f305f59f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 19 May 2023 13:54:18 +0200 Subject: [PATCH 15/36] build(deps): bump actions/setup-node from 3.5.1 to 3.6.0 (#1585) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3.5.1 to 3.6.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v3.5.1...v3.6.0) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/node.js.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml index 5de87ed1f..2125124f6 100644 --- a/.github/workflows/node.js.yml +++ b/.github/workflows/node.js.yml @@ -22,7 +22,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3.5.1 + uses: actions/setup-node@v3.6.0 with: node-version: ${{ matrix.node-version }} cache: 'npm' From 16adbd9f09f6c12b349846388f19fb352f5dc5fa Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 19 May 2023 13:56:59 +0200 Subject: [PATCH 16/36] build(deps): bump pify from 6.0.0 to 6.1.0 (#1579) Bumps [pify](https://github.com/sindresorhus/pify) from 6.0.0 to 6.1.0. - [Release notes](https://github.com/sindresorhus/pify/releases) - [Commits](https://github.com/sindresorhus/pify/compare/v6.0.0...v6.1.0) --- updated-dependencies: - dependency-name: pify dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index f2e06d668..60997d5b2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9425,9 +9425,9 @@ } }, "node_modules/pify": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-6.0.0.tgz", - "integrity": "sha512-eDlMwqmYtd+rZMU6rCL05NT47Desr/jjfPkBPyqCg8PAyqbt+wxFLz1EQ5XvsfLFNlUEFmBj2FkNUvGF9BJLkQ==", + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/pify/-/pify-6.1.0.tgz", + "integrity": "sha512-KocF8ve28eFjjuBKKGvzOBGzG8ew2OqOOSxTTZhirkzH7h3BI1vyzqlR0qbfcDBve1Yzo3FVlWUAtCRrbVN8Fw==", "engines": { "node": ">=14.16" }, @@ -18326,9 +18326,9 @@ "dev": true }, "pify": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-6.0.0.tgz", - "integrity": "sha512-eDlMwqmYtd+rZMU6rCL05NT47Desr/jjfPkBPyqCg8PAyqbt+wxFLz1EQ5XvsfLFNlUEFmBj2FkNUvGF9BJLkQ==" + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/pify/-/pify-6.1.0.tgz", + "integrity": "sha512-KocF8ve28eFjjuBKKGvzOBGzG8ew2OqOOSxTTZhirkzH7h3BI1vyzqlR0qbfcDBve1Yzo3FVlWUAtCRrbVN8Fw==" }, "pirates": { "version": "4.0.5", From 49ce1e038b16e2b0e2fd0b203dcd029a3aa4409f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 19 May 2023 14:02:18 +0200 Subject: [PATCH 17/36] build(deps-dev): bump husky from 8.0.1 to 8.0.3 (#1587) Bumps [husky](https://github.com/typicode/husky) from 8.0.1 to 8.0.3. - [Release notes](https://github.com/typicode/husky/releases) - [Commits](https://github.com/typicode/husky/compare/v8.0.1...v8.0.3) --- updated-dependencies: - dependency-name: husky dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index 60997d5b2..016c899a9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4840,9 +4840,9 @@ } }, "node_modules/husky": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.1.tgz", - "integrity": "sha512-xs7/chUH/CKdOCs7Zy0Aev9e/dKOMZf3K1Az1nar3tzlv0jfqnYtu235bstsWTmXOR0EfINrPa97yy4Lz6RiKw==", + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.3.tgz", + "integrity": "sha512-+dQSyqPh4x1hlO1swXBiNb2HzTDN1I2IGLQx1GrBuiqFJfoMrnZWwVmatvSiO+Iz8fBUnf+lekwNo4c2LlXItg==", "dev": true, "bin": { "husky": "lib/bin.js" @@ -15075,9 +15075,9 @@ "dev": true }, "husky": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.1.tgz", - "integrity": "sha512-xs7/chUH/CKdOCs7Zy0Aev9e/dKOMZf3K1Az1nar3tzlv0jfqnYtu235bstsWTmXOR0EfINrPa97yy4Lz6RiKw==", + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.3.tgz", + "integrity": "sha512-+dQSyqPh4x1hlO1swXBiNb2HzTDN1I2IGLQx1GrBuiqFJfoMrnZWwVmatvSiO+Iz8fBUnf+lekwNo4c2LlXItg==", "dev": true }, "iconv-lite": { From 9b3d82aebae4590977a20e77c72ef27955a48f89 Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Fri, 19 May 2023 14:11:27 +0200 Subject: [PATCH 18/36] Add node 20 to ci --- .github/workflows/node.js.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml index 2125124f6..52df14c84 100644 --- a/.github/workflows/node.js.yml +++ b/.github/workflows/node.js.yml @@ -16,7 +16,7 @@ jobs: strategy: matrix: - node-version: [14.x, 16.x, 18.x] + node-version: [14.x, 16.x, 18.x, 20.x] # See supported Node.js release schedule at https://nodejs.org/en/about/releases/ steps: From f8fd216c1319d86f052e4b4b8f30894e5a9d9578 Mon Sep 17 00:00:00 2001 From: Birk Skyum Date: Fri, 19 May 2023 15:36:58 +0200 Subject: [PATCH 19/36] chore(release): 14.0.2 --- CHANGELOG.md | 7 +++++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c1cbe2621..1a3f949cc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### [14.0.2](https://github.com/documentationjs/documentation/compare/v14.0.1...v14.0.2) (2023-05-19) + + +### Bug Fixes + +* **exported:** respect `parse-extension` & `require-extension` ([#1484](https://github.com/documentationjs/documentation/issues/1484)) ([798fa10](https://github.com/documentationjs/documentation/commit/798fa10595d7523032ac187ae9c8aa943c15e8da)), closes [#1272](https://github.com/documentationjs/documentation/issues/1272) [#1258](https://github.com/documentationjs/documentation/issues/1258) + ## [14.0.1](https://github.com/documentationjs/documentation/compare/v14.0.0...v14.0.1) (2022-12-14) ### Improvements diff --git a/package-lock.json b/package-lock.json index 016c899a9..aaa1197f3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "documentation", - "version": "14.0.1", + "version": "14.0.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "documentation", - "version": "14.0.1", + "version": "14.0.2", "license": "ISC", "dependencies": { "@babel/core": "^7.18.10", diff --git a/package.json b/package.json index e6d944b8b..aa215e6f8 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "documentation", "description": "a documentation generator", - "version": "14.0.1", + "version": "14.0.2", "author": "Tom MacWright", "homepage": "https://documentation.js.org", "type": "module", From 8fcbeae3f6920f187de42ac0a7a2c9ade5c66708 Mon Sep 17 00:00:00 2001 From: Christian Oliff Date: Tue, 11 Jul 2023 23:02:23 +0900 Subject: [PATCH 20/36] Fix a few typos on CHANGELOG (#1610) Fix typos on CHANGELOG --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1a3f949cc..7f0f1bf84 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,13 +28,13 @@ All notable changes to this project will be documented in this file. See [standa ### âš  BREAKING CHANGES -* all Extensions whould contains '.' so that mean if you have just 'ts' then need to convert to '.ts' +* all Extensions should contains '.' so that mean if you have just 'ts' then need to convert to '.ts' * external parameter was removed Migration plan propose to move all external resources to input usages Motivation: packages has many inputs which describe in package.json -so that mean need each time to parse all package.json of exsternal resources to understand which etry point need to pick. -But it is base on guesses because entry point may could not contains a documentation and the best way to handle it manualy. -* The serve parametr was remove, you can use any other tools which could be refresh and store your html site +so that mean need each time to parse all package.json of external resources to understand which entry point need to pick. +But it is base on guesses because entry point may could not contains a documentation and the best way to handle it manually. +* The serve parameter was removed, you can use any other tools which could be refresh and store your html site The private parameter has removed, use a access * documentation.js will now require node 14 or later. From de30e896b74ec01013c527104cf0abcf10dd4f49 Mon Sep 17 00:00:00 2001 From: franklygeorgy <127429065+franklygeorgy@users.noreply.github.com> Date: Tue, 30 Jan 2024 13:37:58 -0500 Subject: [PATCH 21/36] Update membership.js (#1620) Stops this error from happening: TypeError: Cannot read properties of null (reading 'name') at ThisExpression (file:///C:/Users/dev/Documents/Projects/fc-pregmod/node_modules/documentation/src/infer/membership.js:98:54) at NodePath._call (C:\Users\dev\Documents\Projects\fc-pregmod\node_modules\@babel\traverse\lib\path\context.js:46:20) at NodePath.call (C:\Users\dev\Documents\Projects\fc-pregmod\node_modules\@babel\traverse\lib\path\context.js:36:17) at NodePath.visit (C:\Users\dev\Documents\Projects\fc-pregmod\node_modules\@babel\traverse\lib\path\context.js:82:31) at TraversalContext.visitQueue (C:\Users\dev\Documents\Projects\fc-pregmod\node_modules\@babel\traverse\lib\context.js:86:16) at TraversalContext.visitSingle (C:\Users\dev\Documents\Projects\fc-pregmod\node_modules\@babel\traverse\lib\context.js:65:19) at TraversalContext.visit (C:\Users\dev\Documents\Projects\fc-pregmod\node_modules\@babel\traverse\lib\context.js:109:19) at traverseNode (C:\Users\dev\Documents\Projects\fc-pregmod\node_modules\@babel\traverse\lib\traverse-node.js:22:17) at traverse (C:\Users\dev\Documents\Projects\fc-pregmod\node_modules\@babel\traverse\lib\index.js:52:34) at NodePath.traverse (C:\Users\dev\Documents\Projects\fc-pregmod\node_modules\@babel\traverse\lib\path\index.js:101:24) --- src/infer/membership.js | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/infer/membership.js b/src/infer/membership.js index 1ac350a28..756d43e3b 100644 --- a/src/infer/membership.js +++ b/src/infer/membership.js @@ -91,7 +91,10 @@ function extractThis(path, comment) { scope = scope.parent; } - if (n.isClassMethod(scope.block)) { + if ( + n.isClassMethod(scope.block) && + scope.path.parentPath.parentPath.node.id !== null + ) { identifiers.push( scope.path.parentPath.parentPath.node.id.name, 'prototype' From 12cfa02ee386177cba1729c869d14a15ee691114 Mon Sep 17 00:00:00 2001 From: Christian Fritz Date: Tue, 30 Jan 2024 10:38:19 -0800 Subject: [PATCH 22/36] Update NODE_API.md (#1616) - fix order -> sortOrder - added example --- docs/NODE_API.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/NODE_API.md b/docs/NODE_API.md index c5716e70b..f0f9d3dcc 100644 --- a/docs/NODE_API.md +++ b/docs/NODE_API.md @@ -72,7 +72,7 @@ comments, given a root file as a path. generated documentation. * `args.shallow` **[boolean][20]** whether to avoid dependency parsing even in JavaScript code. (optional, default `false`) - * `args.order` **[Array][17]<([string][18] | [Object][19])>** optional array that + * `args.sortOrder` **[Array][17]<([string][18] | [Object][19])>** optional array that defines sorting order of documentation (optional, default `[]`) * `args.access` **[Array][17]<[string][18]>** an array of access levels to output in documentation (optional, default `[]`) @@ -94,7 +94,8 @@ var documentation = require('documentation'); documentation.build(['index.js'], { // only output comments with an explicit @public tag - access: ['public'] + access: ['public'], + sortOrder: ['kind', 'alpha'] }).then(res => { // res is an array of parsed comments with inferred properties // and more: everything you need to build documentation or From 4600c97731a001d47285f8bb60c1759048a02e15 Mon Sep 17 00:00:00 2001 From: Christian Oliff Date: Wed, 31 Jan 2024 03:38:33 +0900 Subject: [PATCH 23/36] Remove broken David badge on README (#1611) This domain has been offline for a few years. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 9eb477b54..90f636934 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,6 @@ [![Circle CI](https://circleci.com/gh/documentationjs/documentation/tree/master.svg?style=shield)](https://circleci.com/gh/documentationjs/documentation/tree/master) [![npm version](https://badge.fury.io/js/documentation.svg)](http://badge.fury.io/js/documentation) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/documentationjs/documentation?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -[![David](https://david-dm.org/documentationjs/documentation.svg)](https://david-dm.org/documentationjs/documentation) [![Inline docs](http://inch-ci.org/github/documentationjs/documentation.svg?branch=master&style=flat-square)](http://inch-ci.org/github/documentationjs/documentation) [:date: Current maintenance status](https://github.com/documentationjs/documentation/wiki/Current-maintenance-status) From 1cc2f984315fc5aaf898c64d8e1eb2b4e70cd482 Mon Sep 17 00:00:00 2001 From: Alois Klink Date: Tue, 30 Jan 2024 18:39:01 +0000 Subject: [PATCH 24/36] fix: fix GFM markdown output (#1553) GFM output is currently broken (since v13.2.2), which prevents tables from being written to markdown. This is because as of [remark v13.0.0][1], GFM support was added to the remark-gfm pacakge. https://github.com/documentationjs/documentation/commit/6b5bc2548db23fdab3fd8d29ac1aeedea7ad3a47 fixed parsing GFM, however, it didn't add GFM support for markdown output. [1]: https://github.com/remarkjs/remark/releases/tag/13.0.0 Fixes: f4a46b134f58639f352b3024801c3d98f901d66a --- __tests__/__snapshots__/bin.js.snap | 298 ++++++++++++++++++++++++++++ __tests__/bin.js | 15 ++ src/output/markdown.js | 5 +- 3 files changed, 317 insertions(+), 1 deletion(-) diff --git a/__tests__/__snapshots__/bin.js.snap b/__tests__/__snapshots__/bin.js.snap index c060e2a3c..ca6d4bbb8 100644 --- a/__tests__/__snapshots__/bin.js.snap +++ b/__tests__/__snapshots__/bin.js.snap @@ -2168,6 +2168,304 @@ f5 comment " `; +exports[`build GFM (e.g. markdown tables) for -f md 1`] = ` +" + +### Table of Contents + +* [Klass][1] + * [Parameters][2] + * [getFoo][3] + * [Examples][4] + * [withOptions][5] + * [Parameters][6] + * [withDeepOptions][7] + * [Parameters][8] + * [isClass][9] + * [Parameters][10] + * [isWeird][11] + * [Parameters][12] + * [isBuffer][13] + * [Parameters][14] + * [isArrayOfBuffers][15] + * [Parameters][16] + * [Examples][17] + * [MAGIC\\\\_NUMBER][18] + * [event][19] +* [CustomError][20] + * [Properties][21] +* [bar][22] +* [bar2][23] + * [Parameters][24] +* [bar3][25] +* [Foo][26] + * [bar][27] +* [Foobar][28] + * [bar][29] +* [customStreams][30] + * [passthrough][31] +* [tableObj][32] + +## Klass + +**Extends Stream.Writable** + +Creates a new Klass + +### Parameters + +* \`foo\` + +### getFoo + +Get this Klass's foo + +#### Examples + +this shows you how to getFoo + +\`\`\`javascript +var x = foo.getFoo(); +\`\`\` + +Returns **[Number][33]** foo + +### withOptions + +A function with an options parameter + +#### Parameters + +* \`options\` **[Object][34]** + + * \`options.foo\` **[string][35]** + * \`options.bar\` **[number][33]** +* \`otherOptions\` **[number][33]?** + +### withDeepOptions + +A function with a deep options parameter + +#### Parameters + +* \`options\` **[Object][34]** + + * \`options.foo\` **[string][35]** + * \`options.bar\` **[Object][34]** + + * \`options.bar.buz\` **[string][35]** + +### isClass + +Decide whether an object is a Klass instance +This is a \\\\[klasssic][Klass][1] +This is a \\\\[link to something that does not exist][DoesNot][36] + +#### Parameters + +* \`other\` **[Object][34]** +* \`also\` **any** + +Returns **[boolean][37]** whether the other thing is a Klass + +### isWeird + +A function that triggers the case where the autolinker doesn't find +the referenced class type + +#### Parameters + +* \`other\` **Weird** + +Returns **[boolean][37]** whether the other thing is a Klass + +### isBuffer + +This method takes a Buffer object that will be linked to nodejs.org + +#### Parameters + +* \`buf\` **([Buffer][38] | [string][35])** +* \`size\` **[number][33]** size (optional, default \`0\`) + +Returns **[boolean][37]** whether the other thing is a Klass + +### isArrayOfBuffers + +This method takes an array of buffers and counts them + +#### Parameters + +* \`buffers\` **[Array][39]<[Buffer][38]>** some buffers + +#### Examples + +\`\`\`javascript +var k = new Klass(); +k.isArrayOfBuffers(); +\`\`\` + +Returns **[number][33]** how many + +### MAGIC\\\\_NUMBER + +A magic number that identifies this Klass. + +### event + +Klass event + +## CustomError + +a typedef with nested properties + +### Properties + +* \`error\` **[object][34]** An error + + * \`error.code\` **[string][35]** The error's code + * \`error.description\` **[string][35]** The error's description + +## bar + +Get an instance of [Klass][1]. Will make +a [klass instance multiword][1], +like a [klass][1] + +Returns **[Klass][1]** that class + +## bar2 + +Rest property function + +### Parameters + +* \`toys\` **...[Number][33]** + +Returns **[undefined][40]** nothing + +## bar3 + +Get an instance of [Klass][1]. Will make +a [klass instance multiword][1], +like a [klass][1]. This needs a [number][33] input. + +Returns **[undefined][40]** nothing + +## Foo + +This is Foo + +### bar + +This is bar + +## Foobar + +This is Foobar +must have a distinct id from Foo.bar + +### bar + +This is bar + +## customStreams + +I am the container of stream types + +### passthrough + +I am a passthrough stream that belongs to customStreams + +## tableObj + +| Col 1 | Col 2 | Col 3 | +| ----- | ----- | ----- | +| Dat 1 | Dat 2 | Dat 3 | +| Dat 4 | Dat 5 | Dat 6 | + +[1]: #klass + +[2]: #parameters + +[3]: #getfoo + +[4]: #examples + +[5]: #withoptions + +[6]: #parameters-1 + +[7]: #withdeepoptions + +[8]: #parameters-2 + +[9]: #isclass + +[10]: #parameters-3 + +[11]: #isweird + +[12]: #parameters-4 + +[13]: #isbuffer + +[14]: #parameters-5 + +[15]: #isarrayofbuffers + +[16]: #parameters-6 + +[17]: #examples-1 + +[18]: #magic_number + +[19]: #event + +[20]: #customerror + +[21]: #properties + +[22]: #bar + +[23]: #bar2 + +[24]: #parameters-7 + +[25]: #bar3 + +[26]: #foo + +[27]: #bar-1 + +[28]: #foobar + +[29]: #bar-2 + +[30]: #customstreams + +[31]: #passthrough + +[32]: #tableobj + +[33]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number + +[34]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object + +[35]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String + +[36]: DoesNot + +[37]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean + +[38]: https://nodejs.org/api/buffer.html + +[39]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array + +[40]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined +" +`; + exports[`lint command generates lint output 1`] = `""`; exports[`should use browser resolve 1`] = ` diff --git a/__tests__/bin.js b/__tests__/bin.js index 7f46bca1e..088d8755e 100644 --- a/__tests__/bin.js +++ b/__tests__/bin.js @@ -368,6 +368,21 @@ test.skip('fatal error', async function () { } }); +test('build GFM (e.g. markdown tables) for -f md', async function () { + const data = await documentation( + ['build', 'fixture/html/nested.input.js', '--shallow', '-f', 'md'], + {}, + false + ); + expect(data).toMatchSnapshot(); + expect(data).toMatch( + `| Col 1 | Col 2 | Col 3 | +| ----- | ----- | ----- | +| Dat 1 | Dat 2 | Dat 3 | +| Dat 4 | Dat 5 | Dat 6 |` + ); +}); + test.skip('build --document-exported', async function () { const data = await documentation( ['build fixture/document-exported.input.js --document-exported -f md'], diff --git a/src/output/markdown.js b/src/output/markdown.js index 1f774d9d9..b7a76566c 100644 --- a/src/output/markdown.js +++ b/src/output/markdown.js @@ -1,4 +1,5 @@ import { remark } from 'remark'; +import remarkGfm from 'remark-gfm'; import markdownAST from './markdown_ast.js'; /** @@ -25,5 +26,7 @@ export default function markdown(comments, args) { if (!args) { args = {}; } - return markdownAST(comments, args).then(ast => remark().stringify(ast)); + return markdownAST(comments, args).then(ast => + remark().use(remarkGfm).stringify(ast) + ); } From 930edd2ba3004af17325702969a7e9184737d625 Mon Sep 17 00:00:00 2001 From: Oliver Schmidt <47846931+Timbuktu1982@users.noreply.github.com> Date: Tue, 30 Jan 2024 19:39:32 +0100 Subject: [PATCH 25/36] Update USAGE.md (#1463) --- docs/USAGE.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/USAGE.md b/docs/USAGE.md index 5fdc6bf03..91e4c00c0 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -31,6 +31,8 @@ Options: [boolean] [default: true] --markdown-toc-max-depth specifies the max depth of the table of contents in markdown output [number] [default: 6] + --babel path to babelrc or babel.options.js to override + default babel config [string] [Standard: null] --shallow shallow mode turns off dependency resolution, only processing the specified files (or the main script specified in package.json) @@ -40,6 +42,9 @@ Options: --no-package, --np dont find and use package.json for project- configuration option defaults [boolean] [default: false] + --external a string / glob match pattern that defines which + external modules will be whitelisted and included + in the generated documentation. [Standard: null] --require-extension, --re additional extensions to include in require() and import's search algorithm.For instance, adding .es5 would allow require("adder") to find "adder.es5" @@ -58,8 +63,10 @@ Options: [boolean] [default: false] --sort-order The order to sort the documentation, may be specified multiple times - [choices: "source", "alpha", "kind"] + [choices: "source", "alpha"] [default: "source"] + --resolve Dependency resolution algorithm. + [choices: "browser", "node"] [Standard: "browser"] --output, -o output location. omit for stdout, otherwise is a filename for single-file outputs and a directory name for multi-file outputs like html From e030a3f776861ff4450ed3620ef5c0180ae3142f Mon Sep 17 00:00:00 2001 From: Momtchil Momtchev Date: Tue, 30 Jan 2024 19:40:11 +0100 Subject: [PATCH 26/36] Sort memberof (#1452) * correctly sort undefined values * the new sort order is the correct one * support sorting by memberof * support sorting by memberof --------- Co-authored-by: Tom MacWright --- __tests__/lib/__snapshots__/sort.js.snap | 32 ++++++++++++++++++++++-- __tests__/lib/sort.js | 8 +++++- docs/USAGE.md | 3 ++- src/commands/shared_options.js | 2 +- src/sort.js | 3 ++- 5 files changed, 42 insertions(+), 6 deletions(-) diff --git a/__tests__/lib/__snapshots__/sort.js.snap b/__tests__/lib/__snapshots__/sort.js.snap index 13fa12e9b..f35e6bf19 100644 --- a/__tests__/lib/__snapshots__/sort.js.snap +++ b/__tests__/lib/__snapshots__/sort.js.snap @@ -139,7 +139,7 @@ Array [ "sortKey": "c", }, "kind": "function", - "memberof": "classB", + "memberof": "classA", "name": "bananas", }, Object { @@ -174,8 +174,36 @@ Array [ "sortKey": "c", }, "kind": "function", - "memberof": "classB", + "memberof": "classA", + "name": "bananas", + }, +] +`; + +exports[`sort toc with files absolute path 4`] = ` +Array [ + Object { + "context": Object { + "sortKey": "c", + }, + "kind": "function", + "memberof": "classA", "name": "bananas", }, + Object { + "context": Object { + "sortKey": "b", + }, + "memberof": "classB", + "name": "carrot", + }, + Object { + "context": Object { + "sortKey": "a", + }, + "kind": "function", + "memberof": "classB", + "name": "apples", + }, ] `; diff --git a/__tests__/lib/sort.js b/__tests__/lib/sort.js index 76ce57f3c..941b163b1 100644 --- a/__tests__/lib/sort.js +++ b/__tests__/lib/sort.js @@ -141,7 +141,7 @@ test('sort toc with files absolute path', function () { context: { sortKey: 'c' }, name: 'bananas', kind: 'function', - memberof: 'classB' + memberof: 'classA' }; const snowflake = { @@ -159,4 +159,10 @@ test('sort toc with files absolute path', function () { sortOrder: ['kind', 'alpha'] }) ).toMatchSnapshot(); + + expect( + sort([carrot, apples, bananas], { + sortOrder: ['memberof', 'kind', 'alpha'] + }) + ).toMatchSnapshot(); }); diff --git a/docs/USAGE.md b/docs/USAGE.md index 91e4c00c0..4b0634187 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -63,7 +63,8 @@ Options: [boolean] [default: false] --sort-order The order to sort the documentation, may be specified multiple times - [choices: "source", "alpha"] + [choices: "source", "alpha", "kind", "memberof"] + [default: "source"] --resolve Dependency resolution algorithm. [choices: "browser", "node"] [Standard: "browser"] diff --git a/src/commands/shared_options.js b/src/commands/shared_options.js index 0379debb8..0e8464dfd 100644 --- a/src/commands/shared_options.js +++ b/src/commands/shared_options.js @@ -75,7 +75,7 @@ export const sharedInputOptions = { 'sort-order': { describe: 'The order to sort the documentation', array: true, - choices: ['source', 'alpha', 'kind', 'access'], + choices: ['source', 'alpha', 'kind', 'access', 'memberof'], default: ['source'] }, resolve: { diff --git a/src/sort.js b/src/sort.js index 17736017b..db27b02d5 100644 --- a/src/sort.js +++ b/src/sort.js @@ -123,7 +123,8 @@ const sortFns = { alpha: compareCommentsByField.bind(null, 'name'), source: compareCommentsBySourceLocation, kind: compareCommentsByField.bind(null, 'kind'), - access: compareCommentsByField.bind(null, 'access') + access: compareCommentsByField.bind(null, 'access'), + memberof: compareCommentsByField.bind(null, 'memberof') }; function sortComments(comments, sortOrder) { From d4559bed20a979b699dd0a941f2e54d4e20cc099 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 30 Jan 2024 13:42:05 -0500 Subject: [PATCH 27/36] build(deps-dev): bump mock-fs from 5.1.4 to 5.2.0 (#1601) Bumps [mock-fs](https://github.com/tschaub/mock-fs) from 5.1.4 to 5.2.0. - [Release notes](https://github.com/tschaub/mock-fs/releases) - [Changelog](https://github.com/tschaub/mock-fs/blob/main/changelog.md) - [Commits](https://github.com/tschaub/mock-fs/compare/v5.1.4...v5.2.0) --- updated-dependencies: - dependency-name: mock-fs dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index aaa1197f3..1599d9599 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8919,9 +8919,9 @@ } }, "node_modules/mock-fs": { - "version": "5.1.4", - "resolved": "https://registry.npmjs.org/mock-fs/-/mock-fs-5.1.4.tgz", - "integrity": "sha512-sudhLjCjX37qWIcAlIv1OnAxB2wI4EmXByVuUjILh1rKGNGpGU8GNnzw+EAbrhdpBe0TL/KONbK1y3RXZk8SxQ==", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/mock-fs/-/mock-fs-5.2.0.tgz", + "integrity": "sha512-2dF2R6YMSZbpip1V1WHKGLNjr/k48uQClqMVb5H3MOvwc9qhYis3/IWbj02qIg/Y8MDXKFF4c5v0rxx2o6xTZw==", "dev": true, "engines": { "node": ">=12.0.0" @@ -17956,9 +17956,9 @@ } }, "mock-fs": { - "version": "5.1.4", - "resolved": "https://registry.npmjs.org/mock-fs/-/mock-fs-5.1.4.tgz", - "integrity": "sha512-sudhLjCjX37qWIcAlIv1OnAxB2wI4EmXByVuUjILh1rKGNGpGU8GNnzw+EAbrhdpBe0TL/KONbK1y3RXZk8SxQ==", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/mock-fs/-/mock-fs-5.2.0.tgz", + "integrity": "sha512-2dF2R6YMSZbpip1V1WHKGLNjr/k48uQClqMVb5H3MOvwc9qhYis3/IWbj02qIg/Y8MDXKFF4c5v0rxx2o6xTZw==", "dev": true }, "modify-values": { From 9c42abb56138e90be84e0a462ae3101f7667f278 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 30 Jan 2024 13:42:26 -0500 Subject: [PATCH 28/36] build(deps): bump actions/setup-node from 3.6.0 to 3.8.0 (#1614) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3.6.0 to 3.8.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v3.6.0...v3.8.0) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/node.js.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml index 52df14c84..0fd72d611 100644 --- a/.github/workflows/node.js.yml +++ b/.github/workflows/node.js.yml @@ -22,7 +22,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3.6.0 + uses: actions/setup-node@v3.8.0 with: node-version: ${{ matrix.node-version }} cache: 'npm' From 8aae14bef7b1602ed441f8bd8351441d77d48665 Mon Sep 17 00:00:00 2001 From: Tom MacWright Date: Tue, 30 Jan 2024 13:48:22 -0500 Subject: [PATCH 29/36] chore(release): 14.0.3 --- CHANGELOG.md | 8 ++++++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f0f1bf84..760c370d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### [14.0.3](https://github.com/documentationjs/documentation/compare/v14.0.1...v14.0.3) (2024-01-30) + + +### Bug Fixes + +* **exported:** respect `parse-extension` & `require-extension` ([#1484](https://github.com/documentationjs/documentation/issues/1484)) ([798fa10](https://github.com/documentationjs/documentation/commit/798fa10595d7523032ac187ae9c8aa943c15e8da)), closes [#1272](https://github.com/documentationjs/documentation/issues/1272) [#1258](https://github.com/documentationjs/documentation/issues/1258) +* fix GFM markdown output ([#1553](https://github.com/documentationjs/documentation/issues/1553)) ([1cc2f98](https://github.com/documentationjs/documentation/commit/1cc2f984315fc5aaf898c64d8e1eb2b4e70cd482)) + ### [14.0.2](https://github.com/documentationjs/documentation/compare/v14.0.1...v14.0.2) (2023-05-19) diff --git a/package-lock.json b/package-lock.json index 1599d9599..909b009c3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "documentation", - "version": "14.0.2", + "version": "14.0.3", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "documentation", - "version": "14.0.2", + "version": "14.0.3", "license": "ISC", "dependencies": { "@babel/core": "^7.18.10", diff --git a/package.json b/package.json index aa215e6f8..4d254ac02 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "documentation", "description": "a documentation generator", - "version": "14.0.2", + "version": "14.0.3", "author": "Tom MacWright", "homepage": "https://documentation.js.org", "type": "module", From 58ae594cc818c12989b3bec82ae319b0185e234d Mon Sep 17 00:00:00 2001 From: Christian Oliff Date: Thu, 1 Feb 2024 02:20:00 +0900 Subject: [PATCH 30/36] Fix typos found with cSpell (#1621) Fix typos found wtih cSpell --- CHANGELOG.md | 2 +- CONTRIBUTING.md | 2 +- docs/THEMING.md | 3 ++- src/output/markdown_ast.js | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 760c370d1..dd16f8756 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -82,7 +82,7 @@ The private parameter has removed, use a access ### Bug Fixes -* [@see](https://github.com/see) tags incorrectly formatted in markdown ouput fixed [#1337](https://github.com/documentationjs/documentation/issues/1337) ([5d8d450](https://github.com/documentationjs/documentation/commit/5d8d4504d52a5bb0a0432bf399bbd82d9e5ea7fc)) +* [@see](https://github.com/see) tags incorrectly formatted in markdown output fixed [#1337](https://github.com/documentationjs/documentation/issues/1337) ([5d8d450](https://github.com/documentationjs/documentation/commit/5d8d4504d52a5bb0a0432bf399bbd82d9e5ea7fc)) ### [13.2.1](https://github.com/documentationjs/documentation/compare/v13.2.0...v13.2.1) (2021-04-06) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1938ba710..2169a477e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,6 +39,6 @@ Release process: * Confirm that `master` passes CI tests * Run `npm run release` or in case it's a prerelease you'd run i.e. `npm run release -- --prerelease alpha` - * It will automatically update teh version in package.json and make a git tag. + * It will automatically update the version in package.json and make a git tag. * Push commits * npm publish diff --git a/docs/THEMING.md b/docs/THEMING.md index cd9761c9f..a2d4a4b00 100644 --- a/docs/THEMING.md +++ b/docs/THEMING.md @@ -34,6 +34,7 @@ for some ideas. - You can now make changes that will show up when you generate your docs using your theme. Example `package.json` `scripts` entry: `"documentation build index.js -f html -o docs --theme node_modules/docjs-theme"` #### Changes to Default Theme Via documentation.yml + If a documentation.yml file is used to establish a table of contents for your documentation, small changes to the default style can be made via a