diff --git a/.circleci/config.yml b/.circleci/config.yml
deleted file mode 100644
index fc2eff3a7..000000000
--- a/.circleci/config.yml
+++ /dev/null
@@ -1,45 +0,0 @@
-workflows:
- version: 2
- node-multi-build:
- jobs:
- - node-v6
- - node-v8
- - node-v10
-
-version: 2
-jobs:
- node-base: &node-base
- docker:
- - image: node
- steps:
- - checkout
- - restore_cache:
- name: Restore Yarn Package Cache
- keys:
- - yarn-packages-{{ .Branch }}-{{ checksum "yarn.lock" }}
- - yarn-packages-{{ .Branch }}
- - yarn-packages-master
- - yarn-packages-
- - run:
- name: Install dependencies
- command: yarn --frozen-lockfile
- - run:
- name: Test
- command: yarn test-ci
- - save_cache:
- name: Save Yarn Package Cache
- key: yarn-packages-{{ .Branch }}-{{ checksum "yarn.lock" }}
- paths:
- - node_modules/
- node-v6:
- <<: *node-base
- docker:
- - image: node:6
- node-v8:
- <<: *node-base
- docker:
- - image: node:8
- node-v10:
- <<: *node-base
- docker:
- - image: node:10
diff --git a/.editorconfig b/.editorconfig
index 443b276cc..597e75449 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -1,4 +1,4 @@
-[**.js]
+[*.{js,css}]
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
diff --git a/.eslintrc b/.eslintrc
index 10e1dc860..2bf300124 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -1,8 +1,8 @@
{
"root": true,
- "parser": "babel-eslint",
"parserOptions": {
- "sourceType": "module"
+ "sourceType": "module",
+ "ecmaVersion": 2020
},
"rules": {
"no-var": 2,
@@ -26,10 +26,7 @@
"no-shadow": 0,
"no-undef": 2
},
- "extends": [
- "eslint:recommended",
- "prettier"
- ],
+ "extends": ["eslint:recommended", "prettier"],
"env": {
"node": true,
"es6": true
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 000000000..bb236c12d
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,15 @@
+# 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://docs.github.com/en/code-security/dependabot
+
+version: 2
+updates:
+ - package-ecosystem: github-actions
+ directory: /
+ schedule:
+ interval: weekly
+ - package-ecosystem: npm
+ directory: /
+ schedule:
+ interval: weekly
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
new file mode 100644
index 000000000..db650acb4
--- /dev/null
+++ b/.github/workflows/codeql.yml
@@ -0,0 +1,41 @@
+name: "CodeQL"
+
+on:
+ push:
+ branches: [ "master" ]
+ pull_request:
+ branches: [ "master" ]
+ schedule:
+ - cron: '0 0 1 * *'
+ workflow_dispatch:
+
+jobs:
+ analyze:
+ name: Analyze
+ runs-on: ubuntu-latest
+ permissions:
+ security-events: write
+
+ strategy:
+ fail-fast: false
+ matrix:
+ language: [ 'javascript-typescript' ]
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ # Initializes the CodeQL tools for scanning.
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v3
+ with:
+ languages: ${{ matrix.language }}
+ queries: +security-and-quality
+
+ - name: Autobuild
+ uses: github/codeql-action/autobuild@v3
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v3
+ with:
+ category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
new file mode 100644
index 000000000..2d8e7a62f
--- /dev/null
+++ b/.github/workflows/node.js.yml
@@ -0,0 +1,29 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+ push:
+ branches: [master]
+ pull_request:
+ branches: [master]
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ strategy:
+ matrix:
+ node-version: [18.x, 20.x]
+ # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+ steps:
+ - uses: actions/checkout@v4
+ - name: Use Node.js ${{ matrix.node-version }}
+ uses: actions/setup-node@v4
+ with:
+ node-version: ${{ matrix.node-version }}
+ cache: 'npm'
+ - run: npm ci
+ - run: npm run test-ci
diff --git a/.husky/pre-commit b/.husky/pre-commit
new file mode 100755
index 000000000..d4a43dd13
--- /dev/null
+++ b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run pre-commit
diff --git a/.npmignore b/.npmignore
index 7895e9330..7c3ebf56a 100644
--- a/.npmignore
+++ b/.npmignore
@@ -7,3 +7,9 @@
circle.yml
coverage
__tests__
+.circleci
+.github
+.prettierignore
+.prettierrc
+CODE_OF_CONDUCT.md
+ISSUE_TEMPLATE.md
diff --git a/.prettierignore b/.prettierignore
new file mode 100644
index 000000000..d826961de
--- /dev/null
+++ b/.prettierignore
@@ -0,0 +1 @@
+__tests__/fixture
diff --git a/.prettierrc b/.prettierrc
index 544138be4..b0a179d48 100644
--- a/.prettierrc
+++ b/.prettierrc
@@ -1,3 +1,5 @@
{
- "singleQuote": true
+ "singleQuote": true,
+ "trailingComma": "none",
+ "arrowParens": "avoid"
}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9e3bbc621..dd16f8756 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,7 +1,316 @@
-# Change Log
+# Changelog
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)
+
+
+### 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
+* 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)
+
+
+### Features
+
+* :sparkles: update Babel, copy list of plugins from Prettier ([3f187d7](https://github.com/documentationjs/documentation/commit/3f187d73132c6667a9140bd491c5f703c1f37c40))
+
+## [14.0.0-alpha.0](https://github.com/documentationjs/documentation/compare/v13.2.5...v14.0.0-alpha.0) (2022-08-05)
+
+
+### ⚠ BREAKING CHANGES
+
+* 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 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.
+
+### 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)
+
+
+### Bug Fixes
+
+* add gfm format for remark fixed [#1374](https://github.com/documentationjs/documentation/issues/1374) ([#1375](https://github.com/documentationjs/documentation/issues/1375)) ([6b5bc25](https://github.com/documentationjs/documentation/commit/6b5bc2548db23fdab3fd8d29ac1aeedea7ad3a47))
+* jsx should be included for tsx files but not for ts fixed [#1359](https://github.com/documentationjs/documentation/issues/1359) ([#1373](https://github.com/documentationjs/documentation/issues/1373)) ([00d434f](https://github.com/documentationjs/documentation/commit/00d434f8576969b00d53a20efebb52a880acf350))
+
+### [13.2.4](https://github.com/documentationjs/documentation/compare/v13.2.3...v13.2.4) (2021-04-21)
+
+
+### Bug Fixes
+
+* add support Vue 3 fixed [#1339](https://github.com/documentationjs/documentation/issues/1339) ([#1372](https://github.com/documentationjs/documentation/issues/1372)) ([cd7d123](https://github.com/documentationjs/documentation/commit/cd7d12366cc499ae8d40a64905354c3479f802f6))
+
+### [13.2.3](https://github.com/documentationjs/documentation/compare/v13.2.2...v13.2.3) (2021-04-20)
+
+### [13.2.2](https://github.com/documentationjs/documentation/compare/v13.2.1...v13.2.2) (2021-04-20)
+
+
+### Bug Fixes
+
+* [@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)
+
+## [13.2.0](https://github.com/documentationjs/documentation/compare/v13.1.1...v13.2.0) (2021-03-13)
+
+
+### Features
+
+* Support import.meta ([d449e7c](https://github.com/documentationjs/documentation/commit/d449e7c3ca0abb7379ea4159b0ef0281059077eb)), closes [#1345](https://github.com/documentationjs/documentation/issues/1345)
+
+### [13.1.1](https://github.com/documentationjs/documentation/compare/v13.1.0...v13.1.1) (2021-01-19)
+
+## [13.1.0](https://github.com/documentationjs/documentation/compare/v13.0.2...v13.1.0) (2020-10-24)
+
+
+### Features
+
+* Add event members to md output ([#1336](https://github.com/documentationjs/documentation/issues/1336)) ([bc3233f](https://github.com/documentationjs/documentation/commit/bc3233fe7e414e65756cf50450ebad069e37506a))
+
+### [13.0.2](https://github.com/documentationjs/documentation/compare/v13.0.1...v13.0.2) (2020-07-02)
+
+
+### Bug Fixes
+
+* Additional safety around detecting functions in HTML output ([a8b6ce1](https://github.com/documentationjs/documentation/commit/a8b6ce144ea380ad21ba99f03574f6258be10666))
+
+### [13.0.1](https://github.com/documentationjs/documentation/compare/v13.0.0...v13.0.1) (2020-06-04)
+
+
+### Bug Fixes
+
+* 🐛 Error with flow opaque type and readme command ([78db9a4](https://github.com/documentationjs/documentation/commit/78db9a443a65bbe8ff202083351655e0cfa60004)), closes [#1322](https://github.com/documentationjs/documentation/issues/1322)
+* 🐛 Fixes an issue when using object spread and $Exact ([106945c](https://github.com/documentationjs/documentation/commit/106945c6354f0b70335adf737c7b7fa296952cc3)), closes [#1324](https://github.com/documentationjs/documentation/issues/1324)
+
+documentation | Documentation
-
@@ -23,6 +23,9 @@ exports[`--config 1`] = `
placeholder='Filter'
id='filter-input'
class='col12 block input'
+ spellcheck='false'
+ autocapitalize='off'
+ autocorrect='off'
type='text' />
@@ -145,9 +148,9 @@ exports[`--config 1`] = `
- bar
+ bar2
@@ -155,9 +158,9 @@ exports[`--config 1`] = `
- bar
+ bar3
@@ -187,6 +190,34 @@ exports[`--config 1`] = `
+
+
+
+
+
+
+ Foobar
+ ▸
+
+
+
@@ -219,6 +250,16 @@ exports[`--config 1`] = `
+
+
+ tableObj
+
+
+
+
+
@@ -229,54 +270,16 @@ exports[`--config 1`] = `
-
-
-
-
- Highlighted section
-
-
-
- The public key is a base64 encoded string of a protobuf containing an RSA DER
-buffer. This uses a node buffer to pass the base64 encoded public key protobuf
-to the multihash for ID generation.
-var PeerId = require ('peer-id' )
-
-PeerId.create({ bits : 1024 }, (err, id) => {
- console .log(JSON .stringify(id.toJSON(), null , 2 )
-}){
- \\"id\\": \\"Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi\\",
- \\"privKey\\": \\"CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..\\",
- \\"pubKey\\": \\"CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY...\\"
-}
-
-
-
-
+
+ Highlighted section
+
-
-
-
- Highlighted section
-
-
-
-
-
-
- The public key is a base64 encoded string of a protobuf containing an RSA DER
+
The public key is a base64 encoded string of a protobuf containing an RSA DER
buffer. This uses a node buffer to pass the base64 encoded public key protobuf
to the multihash for ID generation.
-var PeerId = require ('peer-id' )
-
-PeerId.create({ bits : 1024 }, (err, id) => {
- console .log(JSON .stringify(id.toJSON(), null , 2 )
-}){
\\"id\\": \\"Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi\\",
\\"privKey\\": \\"CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..\\",
@@ -284,35 +287,9 @@ PeerId.create({ bits :
-
+
+
@@ -330,10 +307,7 @@ PeerId.create({ bits : Creates a new Klass
-
-
new Klass(foo: any)
-
@@ -375,6 +349,8 @@ PeerId.create({ bits : Static Members
@@ -394,10 +370,7 @@ PeerId.create({
bits :
Klass
This is a [link to something that does not exist]DoesNot
-
-
-
@@ -452,6 +425,10 @@ This is a [link to something that does not exist]DoesNot
@@ -472,10 +449,7 @@ This is a [link to something that does not exist]
DoesNotA function that triggers the case where the autolinker doesn't find
the referenced class type
-
-
-
@@ -522,6 +496,10 @@ the referenced class type
+
+
+
+
This method takes a Buffer object that will be linked to nodejs.org
-
-
-
@@ -601,6 +576,10 @@ the referenced class type
+
+
+
+
@@ -620,10 +599,7 @@ the referenced class type
This method takes an array of buffers and counts them
-
-
-
@@ -665,11 +641,13 @@ the referenced class type
+
+
Example
- var k = new Klass();
-k.isArrayOfBuffers();var k = new Klass ();
+k.isArrayOfBuffers ();A magic number that identifies this Klass.
-
-
MAGIC_NUMBER
-
@@ -721,6 +698,10 @@ k.isArrayOfBuffers();
+
+
+
+
@@ -753,10 +734,7 @@ k.isArrayOfBuffers();
Get this Klass's foo
-
-
-
@@ -784,11 +762,13 @@ k.isArrayOfBuffers();
+
+
Example
this shows you how to getFoo
- var x = foo.getFoo();var x = foo.getFoo ();A function with an options parameter
-
-
-
@@ -898,6 +877,10 @@ k.isArrayOfBuffers();
+
+
+
+
@@ -917,10 +900,7 @@ k.isArrayOfBuffers();
A function with a deep options parameter
-
-
withDeepOptions(options:
Object )
Events
@@ -1028,10 +1014,7 @@ k.isArrayOfBuffers();
Klass event
-
-
event
-
@@ -1052,6 +1035,10 @@ k.isArrayOfBuffers();
+
+
+
+
@@ -1067,6 +1054,7 @@ k.isArrayOfBuffers();
+
@@ -1084,10 +1072,7 @@ k.isArrayOfBuffers();
a typedef with nested properties
-
-
CustomError
-
@@ -1139,8 +1124,13 @@ k.isArrayOfBuffers();
+
+
+
+
+
+
@@ -1206,8 +1198,8 @@ like a klass
-
- bar
+
+ bar2
@@ -1216,10 +1208,7 @@ like a klass
Rest property function
-
-
-
-
+
@@ -1266,8 +1255,13 @@ like a
klass
+
+
+
+
+
@@ -1275,8 +1269,8 @@ like a klass
- I am the container of stream types
+ This is Foobar
+must have a distinct id from Foo.bar
-
-
- customStreams
-
+ new Foobar()
@@ -1470,14 +1467,18 @@ like a klass . This needs a Static Members Instance Members
-
+
▸
-
new passthrough()
+
bar
-
-
-
-
-
-
-"
-`;
+
+
-exports[`accepts config file 1`] = `
-Array [
- Object {
- "augments": Array [],
- "context": Object {
- "file": "[path]",
- "loc": Object {
- "end": Object {
- "column": 2,
- "line": 13,
- },
- "start": Object {
- "column": 0,
- "line": 11,
- },
- },
- },
- "description": Object {
- "children": Array [
- Object {
- "children": Array [
- Object {
- "position": Object {
- "end": Object {
- "column": 19,
- "line": 1,
- "offset": 18,
- },
- "indent": Array [],
- "start": Object {
- "column": 1,
- "line": 1,
- "offset": 0,
- },
- },
- "type": "text",
- "value": "Bananas are yellow",
- },
- ],
- "position": Object {
- "end": Object {
- "column": 19,
- "line": 1,
- "offset": 18,
- },
- "indent": Array [],
- "start": Object {
- "column": 1,
- "line": 1,
- "offset": 0,
- },
- },
- "type": "paragraph",
- },
- ],
- "position": Object {
- "end": Object {
- "column": 19,
- "line": 1,
- "offset": 18,
- },
- "start": Object {
- "column": 1,
- "line": 1,
- "offset": 0,
- },
- },
- "type": "root",
- },
- "examples": Array [],
- "kind": "function",
+
+
+
+
+ customStreams
+
+
+
+
+
+
+ I am the container of stream types
+
+ customStreams
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Static Members
+
+
+
+
+
+
▸
+
new passthrough()
+
+
+
+
+
+
+
+ I am a passthrough stream that belongs to customStreams
+
+ new passthrough()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ tableObj
+
+
+
+
+
+
+
+
+
+Col 1
+Col 2
+Col 3
+
+
+
+
+Dat 1
+Dat 2
+Dat 3
+
+
+Dat 4
+Dat 5
+Dat 6
+
+
+
+
+ tableObj
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+