electron-docs-linter
electron-docs-linter copied to clipboard
electron
Parse and validate Electron's API documentation
Bumps [semantic-release](https://github.com/semantic-release/semantic-release) from 17.2.3 to 19.0.3. Release notes Sourced from semantic-release's releases. v19.0.3 19.0.3 (2022-06-09) Bug Fixes log-repo: use the original form of the repo url to remove the need...
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot] avatar"){kind=avatar}
Bumps [pathval](https://github.com/chaijs/pathval) from 1.1.0 to 1.1.1. Release notes Sourced from pathval's releases. v1.1.1 Fixes a security issue around prototype pollution. Commits db6c3e3 chore: v1.1.1 7859e0e Merge pull request #60 from...
Bumps [node-fetch](https://github.com/node-fetch/node-fetch) from 2.6.1 to 2.6.7. Release notes Sourced from node-fetch's releases. v2.6.7 Security patch release Recommended to upgrade, to not leak sensitive cookie and authentication header information to 3th...
Link to https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/github-electron is broken
From electron/electron#17479. Neither "A `(NativeImage | String)` ..." nor "A `NativeImage | String` ..." produces the correct results. It only picks one of the types.
From electron/electron#17479. (optional) works in some parts, but not for instance properties. Neither "A `Integer` (optional) ..." nor "A `Integer (optional)` ..." works at the moment.
From electron/electron#17479. There's currently no syntax in place to mark certain instance properties as read only. The only documentation I've seen in this regard has been "This property can be...
We want the `WebContents` and the link here. Not just the raw text. https://github.com/zeke/electron-docs-linter/blob/b5a9608f4cbfbff9e32ec4c5771fe488d24d9c2b/lib/helpers.js#L19 
For example, https://github.com/electron/electron/blob/master/docs/api/app.md#apprelaunchoptions is composed of several paragraphs. ```js const apis = require('electron-api-docs/tree') console.log(apis.app.methods.relaunch.description) ``` currently produces ``` Relaunches the app when current instance exits. By default the new instance...