From 9bc1098ec54686fbabf60dc5b100cf1419762961 Mon Sep 17 00:00:00 2001
From: Birk Skyum <birk.skyum@pm.me>
Date: Thu, 4 Aug 2022 02:05:16 +0200
Subject: [PATCH 1/2] Execute npm run build
---
docs/NODE_API.md | 113 +++++++++++++++++------------------------------
1 file changed, 41 insertions(+), 72 deletions(-)
diff --git a/docs/NODE_API.md b/docs/NODE_API.md
index c5716e70b..079023ee0 100644
--- a/docs/NODE_API.md
+++ b/docs/NODE_API.md
@@ -9,15 +9,12 @@
* [Parameters][5]
* [Examples][6]
* [formats][7]
-* [formats.html][8]
+* [formats.markdown][8]
* [Parameters][9]
* [Examples][10]
-* [formats.markdown][11]
+* [formats.json][11]
* [Parameters][12]
* [Examples][13]
-* [formats.json][14]
- * [Parameters][15]
- * [Examples][16]
## lint
@@ -27,19 +24,19 @@ of lint information intended for human-readable output.
### Parameters
-* `indexes` **([Array][17]<[string][18]> | [string][18])** files to process
-* `args` **[Object][19]** args
+* `indexes` **([Array][14]<[string][15]> | [string][15])** files to process
+* `args` **[Object][16]** args
- * `args.external` **[Array][17]<[string][18]>** a string regex / glob match pattern
+ * `args.external` **[Array][14]<[string][15]>** a string regex / glob match pattern
that defines what external modules will be whitelisted and included in the
generated documentation.
- * `args.shallow` **[boolean][20]** whether to avoid dependency parsing
- even in JavaScript code. (optional, default `false`)
- * `args.inferPrivate` **[string][18]?** a valid regular expression string
+ * `args.shallow` **[boolean][17]** whether to avoid dependency parsing
+ even in JavaScript code. (optional, default `false`)
+ * `args.inferPrivate` **[string][15]?** a valid regular expression string
to infer whether a code element should be private, given its naming structure.
For instance, you can specify `inferPrivate: '^_'` to automatically treat
methods named like `_myMethod` as private.
- * `args.extension` **([string][18] | [Array][17]<[string][18]>)?** treat additional file extensions
+ * `args.extension` **([string][15] | [Array][14]<[string][15]>)?** treat additional file extensions
as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
### Examples
@@ -55,7 +52,7 @@ documentation.lint('file.js').then(lintOutput => {
});
```
-Returns **[Promise][21]** promise with lint results
+Returns **[Promise][18]** promise with lint results
## build
@@ -64,27 +61,27 @@ comments, given a root file as a path.
### Parameters
-* `indexes` **([Array][17]<[string][18]> | [string][18])** files to process
-* `args` **[Object][19]** args
+* `indexes` **([Array][14]<[string][15]> | [string][15])** files to process
+* `args` **[Object][16]** args
- * `args.external` **[Array][17]<[string][18]>** a string regex / glob match pattern
+ * `args.external` **[Array][14]<[string][15]>** a string regex / glob match pattern
that defines what external modules will be whitelisted and included in the
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
- defines sorting order of documentation (optional, default `[]`)
- * `args.access` **[Array][17]<[string][18]>** an array of access levels
- to output in documentation (optional, default `[]`)
- * `args.hljs` **[Object][19]?** hljs optional args
-
- * `args.hljs.highlightAuto` **[boolean][20]** hljs automatically detect language (optional, default `false`)
- * `args.hljs.languages` **[Array][17]?** languages for hljs to choose from
- * `args.inferPrivate` **[string][18]?** a valid regular expression string
+ * `args.shallow` **[boolean][17]** whether to avoid dependency parsing
+ even in JavaScript code. (optional, default `false`)
+ * `args.order` **[Array][14]<([string][15] | [Object][16])>** optional array that
+ defines sorting order of documentation (optional, default `[]`)
+ * `args.access` **[Array][14]<[string][15]>** an array of access levels
+ to output in documentation (optional, default `[]`)
+ * `args.hljs` **[Object][16]?** hljs optional args
+
+ * `args.hljs.highlightAuto` **[boolean][17]** hljs automatically detect language (optional, default `false`)
+ * `args.hljs.languages` **[Array][14]?** languages for hljs to choose from
+ * `args.inferPrivate` **[string][15]?** a valid regular expression string
to infer whether a code element should be private, given its naming structure.
For instance, you can specify `inferPrivate: '^_'` to automatically treat
methods named like `_myMethod` as private.
- * `args.extension` **([string][18] | [Array][17]<[string][18]>)?** treat additional file extensions
+ * `args.extension` **([string][15] | [Array][14]<[string][15]>)?** treat additional file extensions
as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
### Examples
@@ -102,7 +99,7 @@ documentation.build(['index.js'], {
});
```
-Returns **[Promise][21]** results
+Returns **[Promise][18]** results
## formats
@@ -111,37 +108,15 @@ and config as input and return Promises with results,
like stringified JSON, markdown strings, or Vinyl objects for HTML
output.
-## formats.html
-
-Formats documentation as HTML.
-
-### Parameters
-
-* `comments` **[Array][17]<[Comment][22]>** parsed comments
-* `config` **[Object][19]** Options that can customize the output
-
- * `config.theme` **[string][18]** Name of a module used for an HTML theme. (optional, default `'default_theme'`)
-
-### Examples
-
-```javascript
-var documentation = require('documentation');
-
-documentation.build(['index.js'])
- .then(documentation.formats.html);
-```
-
-Returns **[Promise][21]<[Array][17]<[Object][19]>>** Promise with results
-
## formats.markdown
Formats documentation as
-[Markdown][23].
+[Markdown][19].
### Parameters
-* `comments` **[Array][17]<[Object][19]>** parsed comments
-* `args` **[Object][19]** Options that can customize the output
+* `comments` **[Array][14]<[Object][16]>** parsed comments
+* `args` **[Object][16]** Options that can customize the output
### Examples
@@ -157,7 +132,7 @@ documentation.build(['index.js'])
});
```
-Returns **[Promise][21]<[string][18]>** a promise of the eventual value
+Returns **[Promise][18]<[string][15]>** a promise of the eventual value
## formats.json
@@ -165,7 +140,7 @@ Formats documentation as a JSON string.
### Parameters
-* `comments` **[Array][17]<[Comment][22]>** parsed comments
+* `comments` **[Array][14]<[Comment][20]>** parsed comments
### Examples
@@ -181,7 +156,7 @@ documentation.build(['index.js'])
});
```
-Returns **[Promise][21]<[string][18]>**
+Returns **[Promise][18]<[string][15]>** 
[1]: #lint
@@ -197,34 +172,28 @@ Returns **[Promise][21]<[string][18]>**
[7]: #formats
-[8]: #formatshtml
+[8]: #formatsmarkdown
[9]: #parameters-2
[10]: #examples-2
-[11]: #formatsmarkdown
+[11]: #formatsjson
[12]: #parameters-3
[13]: #examples-3
-[14]: #formatsjson
-
-[15]: #parameters-4
-
-[16]: #examples-4
-
-[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
-[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
-[22]: https://developer.mozilla.org/docs/Web/API/Comment/Comment
+[19]: https://daringfireball.net/projects/markdown/
-[23]: https://daringfireball.net/projects/markdown/
+[20]: https://developer.mozilla.org/docs/Web/API/Comment/Comment
From cb3c983d8fe54b4b290074de8ce96c0a650e7e4b Mon Sep 17 00:00:00 2001
From: Birk Skyum <birk.skyum@pm.me>
Date: Thu, 4 Aug 2022 02:15:03 +0200
Subject: [PATCH 2/2] chore(release): 14.0.0-alpha.0
---
CHANGELOG.md | 29 +++++++++++++++++++++++++++++
package-lock.json | 4 ++--
package.json | 2 +-
3 files changed, 32 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index db5de4589..46896e270 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,35 @@
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.0-alpha.0](https://github.com/documentationjs/documentation/compare/v13.2.5...v14.0.0-alpha.0) (2022-08-04)
+
+
+### ⚠ BREAKING CHANGES
+
+* all Extensions whould 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
+The private parameter has removed, use a access
+* documentation.js will now require node 14 or later.
+
+### Bug Fixes
+
+* add micromark dependencies fixed [#1381](https://github.com/documentationjs/documentation/issues/1381) ([3ba8165](https://github.com/documentationjs/documentation/commit/3ba81659d7db5d9393fa083287d91db93d6aab5e))
+* add TS and TSX as default extensions fixed [#1377](https://github.com/documentationjs/documentation/issues/1377) ([f0cb1c0](https://github.com/documentationjs/documentation/commit/f0cb1c0bb1d97228c7baab453e50e5dbe283ea46))
+* external was removed as prefer of input usages ([e3c59d7](https://github.com/documentationjs/documentation/commit/e3c59d77e4e3cf6e5fabab7c0d853a06a77f6288))
+* html report, it is return html if output is not defined ([0975871](https://github.com/documentationjs/documentation/commit/0975871b34b8cc0af74e0aebb43f2727e0ab9960))
+* remove private parameter, use access (BREAKING CHANGES) ([874069c](https://github.com/documentationjs/documentation/commit/874069c0b3647dad413667f61d05f6d39992995d))
+* The server parameter deprecated and will be remove in next Major version fixed [#1413](https://github.com/documentationjs/documentation/issues/1413) ([810e08b](https://github.com/documentationjs/documentation/commit/810e08b6fdb1076a1758bff831a9f42890f0f25f))
+* use process.cwd vs `.` which can fail ([4cc70a5](https://github.com/documentationjs/documentation/commit/4cc70a5aed0c233cdcc72077733f9da8450be386))
+
+
+* replace module-deps-sortable on own implementation to control how parse files ([abb781a](https://github.com/documentationjs/documentation/commit/abb781a69ac69423da11346f62d7064382bb7b74))
+* Update Node minimum version to 14 ([fc0bb3c](https://github.com/documentationjs/documentation/commit/fc0bb3cd885b9577e6f1f6935e15d4ec24f89114))
+
### [13.2.5](https://github.com/documentationjs/documentation/compare/v13.2.4...v13.2.5) (2021-04-24)
diff --git a/package-lock.json b/package-lock.json
index 8c34afc6a..e7b3447a5 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "documentation",
- "version": "13.2.5",
+ "version": "14.0.0-alpha.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "documentation",
- "version": "13.2.5",
+ "version": "14.0.0-alpha.0",
"license": "ISC",
"dependencies": {
"@babel/core": "^7.18.10",
diff --git a/package.json b/package.json
index 36f66461f..807cfb21b 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "documentation",
"description": "a documentation generator",
- "version": "13.2.5",
+ "version": "14.0.0-alpha.0",
"author": "Tom MacWright",
"homepage": "https://documentation.js.org",
"type": "module",