Skip to content

Commit

Permalink
deps: udpate remark and remove babel-eslint parser
Browse files Browse the repository at this point in the history
  • Loading branch information
anthony-redFox committed Apr 15, 2021
1 parent 5d8d450 commit 3babb4a
Show file tree
Hide file tree
Showing 5 changed files with 539 additions and 414 deletions.
9 changes: 3 additions & 6 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"root": true,
"parser": "babel-eslint",
"parserOptions": {
"sourceType": "module"
"sourceType": "module",
"ecmaVersion": 2020
},
"rules": {
"no-var": 2,
Expand All @@ -26,10 +26,7 @@
"no-shadow": 0,
"no-undef": 2
},
"extends": [
"eslint:recommended",
"prettier"
],
"extends": ["eslint:recommended", "prettier"],
"env": {
"node": true,
"es6": true
Expand Down
10 changes: 10 additions & 0 deletions __tests__/__snapshots__/test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -11704,6 +11704,7 @@ have any parameter descriptions.
### Parameters

- \`$0\` **[Object][35]** (optional, default \`{}\`)

- \`$0.phoneNumbers\` (optional, default \`[]\`)
- \`$0.emailAddresses\` (optional, default \`[]\`)
- \`$0.params\` **...any**
Expand All @@ -11715,6 +11716,7 @@ Similar, but with an array
### Parameters

- \`$0\` **[Array][36]**

- \`$0.0\`
- \`$0.1\`
- \`$0.2\`
Expand Down Expand Up @@ -29143,6 +29145,7 @@ Attempt to establish a cookie-based session in exchange for credentials.
### Parameters

- \`credentials\` **[object][3]**

- \`credentials.name\` **[string][4]** Login username. Also accepted as \`username\` or \`email\`.
- \`credentials.password\` **[string][4]** Login password
- \`callback\` **[function][5]?** Gets passed \`(err, { success:Boolean })\`.
Expand Down Expand Up @@ -30914,6 +30917,7 @@ exports[`outputs nest_params.input.js markdown 1`] = `
### Parameters

- \`employees\` **[Array][6]<[Object][7]>** The employees who are responsible for the project.

- \`employees[].name\` **[string][8]** The name of an employee.
- \`employees[].department\` **[string][8]** The employee's department.
- \`type\` **[string][8]** The employee's type. (optional, default \`minion\`)
Expand All @@ -30923,12 +30927,14 @@ exports[`outputs nest_params.input.js markdown 1`] = `
### Parameters

- \`options\` **[Object][7]** some options

- \`options.much\` **[number][9]** how much
- \`bar\` **[number][9]** something else

### Properties

- \`theTime\` **[Object][7]** the current time

- \`theTime.hours\` **[number][9]**
- \`theTime.minutes\` **[number][9]**
- \`theTime.seconds\` **[number][9]**
Expand Down Expand Up @@ -35646,6 +35652,7 @@ This function returns the number one.
- \`b\` **[number][24]** the second param
- \`c\`
- \`$3\` **[Object][25]**

- \`$3.d\`
- \`$3.e\`
- \`$3.f\`
Expand All @@ -35657,6 +35664,7 @@ This method has partially inferred params
### Parameters

- \`options\` **[Object][25]**

- \`options.fishes\` **[String][26]** number of kinds of fish
- \`options.foxes\`

Expand Down Expand Up @@ -35720,6 +35728,7 @@ This tests our support of nested parameters
### Parameters

- \`options\` **[Object][25]?** optional options

- \`options.data\` **([Object][25] \\\\| [string][26])** A GeoJSON data object or URL to it.
The latter is preferable in case of large GeoJSON files.
- \`options.maxzoom\` **[number][24]** Maximum zoom to preserve detail at. (optional, default \`14\`)
Expand Down Expand Up @@ -35754,6 +35763,7 @@ iterator destructure (RestElement)
### Parameters

- \`input\` **[Array][27]**

- \`input.0\` **any** head of iterator
- \`input.xs\` **...any** body of iterator

Expand Down
4 changes: 4 additions & 0 deletions docs/NODE_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ of lint information intended for human-readable output.

- `indexes` **([Array][17]<[string][18]> | [string][18])** files to process
- `args` **[Object][19]** args

- `args.external` **[Array][17]<[string][18]>** a string regex / glob match pattern
that defines what external modules will be whitelisted and included in the
generated documentation.
Expand Down Expand Up @@ -65,6 +66,7 @@ comments, given a root file as a path.

- `indexes` **([Array][17]<[string][18]> | [string][18])** files to process
- `args` **[Object][19]** args

- `args.external` **[Array][17]<[string][18]>** a string regex / glob match pattern
that defines what external modules will be whitelisted and included in the
generated documentation.
Expand All @@ -75,6 +77,7 @@ comments, given a root file as a path.
- `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
Expand Down Expand Up @@ -116,6 +119,7 @@ Formats documentation as HTML.

- `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
Expand Down
17 changes: 8 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@
"parse-filepath": "^1.0.2",
"pify": "^5.0.0",
"read-pkg-up": "^4.0.0",
"remark": "^9.0.0",
"remark-html": "^8.0.0",
"remark-reference-links": "^4.0.1",
"remark-toc": "^5.0.0",
"remark": "^12.0.0",
"remark-html": "^12.0.0",
"remark-reference-links": "^5.0.0",
"remark-toc": "^7.2.0",
"resolve": "^1.8.1",
"stream-array": "^1.1.2",
"strip-json-comments": "^2.0.1",
Expand All @@ -73,21 +73,20 @@
},
"devDependencies": {
"babel-core": "^7.0.0-bridge.0",
"babel-eslint": "^10.1.0",
"chdir": "0.0.0",
"cz-conventional-changelog": "2.1.0",
"documentation-schema": "0.0.1",
"eslint": "^7.1.0",
"eslint-config-prettier": "^6.11.0",
"eslint": "^7.23.0",
"eslint-config-prettier": "^8.1.0",
"fs-extra": "^9.0.0",
"husky": "^1.3.1",
"jest": "^26.0.0",
"json-schema": "^0.2.3",
"lint-staged": "^7.2.0",
"mock-fs": "^4.4.2",
"p-event": "^4.1.0",
"prettier": "^2.0.5",
"standard-version": "^8.0.0",
"prettier": "^2.2.1",
"standard-version": "^9.2.0",
"tmp": "^0.2.1"
},
"keywords": [
Expand Down

0 comments on commit 3babb4a

Please sign in to comment.