mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

build: add Markdown lint check for unescaped angle brackets (#41779)

Browse source
This commit is contained in:
David Sanders 2024-04-05 10:53:42 -07:00 committed by GitHub
parent c9b2de9a36
commit e6417c7084
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 23 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
.markdownlint.json
View file

@ -1,3 +1,17 @@
{ {
"extends": "@electron/lint-roller/configs/markdownlint.json" "extends": "@electron/lint-roller/configs/markdownlint.json",
"no-angle-brackets": true,
"no-inline-html": {
"allowed_elements": [
"br",
"details",
"img",
"li",
"summary",
"ul",
"unknown",
"Tabs",
"TabItem",
]
}
} }

2
docs/api/base-window.md
View file

@ -656,7 +656,7 @@ Closes the currently open [Quick Look][quick-look] panel.
#### `win.setBounds(bounds[, animate])` #### `win.setBounds(bounds[, animate])`
* `bounds` Partial<[Rectangle](structures/rectangle.md)> * `bounds` Partial\<[Rectangle](structures/rectangle.md)\>
* `animate` boolean (optional) _macOS_ * `animate` boolean (optional) _macOS_
Resizes and moves the window to the supplied bounds. Any properties that are not supplied will default to their current values. Resizes and moves the window to the supplied bounds. Any properties that are not supplied will default to their current values.

2
docs/api/client-request.md
View file

@ -17,7 +17,7 @@ following properties:
method. method.
* `url` string (optional) - The request URL. Must be provided in the absolute * `url` string (optional) - The request URL. Must be provided in the absolute
form with the protocol scheme specified as http or https. form with the protocol scheme specified as http or https.
* `headers` Record<string, string | string[]> (optional) - Headers to be sent * `headers` Record\<string, string | string[]\> (optional) - Headers to be sent
with the request. with the request.
* `session` Session (optional) - The [`Session`](session.md) instance with * `session` Session (optional) - The [`Session`](session.md) instance with
which the request is associated. which the request is associated.

2
docs/tutorial/tutorial-2-first-app.md
View file

@ -234,7 +234,7 @@ Notification) whereas camelCase modules are not instantiable (e.g. app, ipcRende
<details><summary>Typed import aliases</summary> <details><summary>Typed import aliases</summary>
For better type checking when writing TypeScript code, you can choose to import For better type checking when writing TypeScript code, you can choose to import
main process modules from <code>electron/main</code>. main process modules from `electron/main`.
```js ```js
const { app, BrowserWindow } = require('electron/main') const { app, BrowserWindow } = require('electron/main')

2
package.json
View file

@ -9,7 +9,7 @@
"@electron/docs-parser": "^1.2.0", "@electron/docs-parser": "^1.2.0",
"@electron/fiddle-core": "^1.0.4", "@electron/fiddle-core": "^1.0.4",
"@electron/github-app-auth": "^2.0.0", "@electron/github-app-auth": "^2.0.0",
"@electron/lint-roller": "^1.9.0", "@electron/lint-roller": "^1.12.1",
"@electron/typescript-definitions": "^8.15.2", "@electron/typescript-definitions": "^8.15.2",
"@octokit/rest": "^19.0.7", "@octokit/rest": "^19.0.7",
"@primer/octicons": "^10.0.0", "@primer/octicons": "^10.0.0",

8
yarn.lock
View file

@ -199,10 +199,10 @@
"@octokit/auth-app" "^4.0.13" "@octokit/auth-app" "^4.0.13"
"@octokit/rest" "^19.0.11" "@octokit/rest" "^19.0.11"
"@electron/lint-roller@^1.9.0": "@electron/lint-roller@^1.12.1":
version "1.10.0" version "1.12.1"
resolved "https://registry.yarnpkg.com/@electron/lint-roller/-/lint-roller-1.10.0.tgz#278dfb285018869faabd5c3f616c64da7f2b26c1" resolved "https://registry.yarnpkg.com/@electron/lint-roller/-/lint-roller-1.12.1.tgz#3152b9a68815b2ab51cc5a4d462ae6769d5052ce"
integrity sha512-dDJDy5MANWNIxv7OqQ0NwPzqwMmgTFYtjR/KKeEEdCQj1k21TT61+Zjdsm+IKbA2LSPujpujsyGKUQtb4oLLCA== integrity sha512-TGgVcHUAooM9/dV3iJTxhmKl35x/gzStsClz2/LWtBQZ59cRK+0YwWF5HWhtydGFIpOLEQGzCvUrty5zZLyd4w==
dependencies: dependencies:
"@dsanders11/vscode-markdown-languageservice" "^0.3.0" "@dsanders11/vscode-markdown-languageservice" "^0.3.0"
balanced-match "^2.0.0" balanced-match "^2.0.0"