Skip to content

Commit

Permalink
build: lint JS in Markdown (#3251)
Browse files Browse the repository at this point in the history
* docs: improve local-electron plugin forge.config.js example

* build(deps): upgrade @electron/lint-roller

* build: lint JS in Markdown
  • Loading branch information
dsanders11 committed Jun 15, 2023
1 parent 6939f09 commit 7a9edbc
Show file tree
Hide file tree
Showing 15 changed files with 45 additions and 39 deletions.
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@
"lerna:publish": "lerna publish --force-publish --conventional-commits --no-changelog --exact",
"lint:js": "prettier --check . && eslint .",
"lint:markdown": "electron-markdownlint \"**/*.md\"",
"lint:markdown-js": "electron-lint-markdown-standard --root . --ignore-path .markdownlintignore --semi \"**/*.md\"",
"lint:markdown-links": "electron-lint-markdown-links --root . --ignore-path .markdownlintignore \"**/*.md\"",
"lint": "npm run lint:js && npm run lint:markdown && npm run lint:markdown-links",
"lint": "npm run lint:js && npm run lint:markdown && npm run lint:markdown-js && npm run lint:markdown-links",
"lint:fix": "prettier --write .",
"link:prepare": "lerna exec -- node ../../../tools/silent.js yarn link --silent --no-bin-links --link-folder ../../../.links",
"link:remove": "lerna exec -- node ../../../tools/silent.js yarn unlink --silent --no-bin-links --link-folder ../../../.links",
Expand Down Expand Up @@ -84,7 +85,7 @@
},
"devDependencies": {
"@electron/fuses": ">=1.0.0",
"@electron/lint-roller": "^1.5.0",
"@electron/lint-roller": "^1.6.0",
"@knodes/typedoc-plugin-monorepo-readmes": "0.22.5",
"@malept/eslint-config": "^2.0.0",
"@types/chai": "^4.2.12",
Expand Down
2 changes: 1 addition & 1 deletion packages/maker/snap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can only build the Snapcraft target on Linux systems with the `snapcraft` pa
{
name: '@electron-forge/maker-snap',
config: {
version: "1.1.0",
version: '1.1.0',
features: {
audio: true,
mpris: 'com.example.mpris',
Expand Down
8 changes: 4 additions & 4 deletions packages/plugin/auto-unpack-natives/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ This plugin will automatically add all native Node modules in your node_modules

module.exports = {
plugins: [
{
name: '@electron-forge/plugin-auto-unpack-natives'
}
{
name: '@electron-forge/plugin-auto-unpack-natives'
}
]
}
};
```
2 changes: 1 addition & 1 deletion packages/plugin/electronegativity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ module.exports = {
}
]
]
}
};
```
6 changes: 3 additions & 3 deletions packages/plugin/fuses/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ const forgeConfig = {
plugins: [
new FusesPlugin({
version: FuseVersion.V1,
[FuseV1Options.RunAsNode]: false,
[FuseV1Options.RunAsNode]: false
// ...any other options supported by @electron/fuses
}),
],
})
]
};

module.exports = forgeConfig;
Expand Down
16 changes: 10 additions & 6 deletions packages/plugin/local-electron/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,14 @@ _Note: This plugin should only be used by people who are building Electron local
```javascript
// forge.config.js

{
name: '@electron-forge/plugin-local-electron',
config: {
electronPath: '/Users/me/projects/electron/out/Testing',
},
},
module.exports = {
plugins: [
{
name: '@electron-forge/plugin-local-electron',
config: {
electronPath: '/Users/me/projects/electron/out/Testing'
}
}
]
};
```
18 changes: 9 additions & 9 deletions packages/plugin/vite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ module.exports = {
{
// `entry` is just an alias for `build.lib.entry` in the corresponding file of `config`.
entry: 'src/main.js',
config: 'vite.main.config.mjs',
config: 'vite.main.config.mjs'
},
{
entry: 'src/preload.js',
config: 'vite.preload.config.mjs',
},
config: 'vite.preload.config.mjs'
}
],
renderer: [
{
name: 'main_window',
config: 'vite.renderer.config.mjs',
},
],
},
},
],
config: 'vite.renderer.config.mjs'
}
]
}
}
]
};
```
4 changes: 2 additions & 2 deletions packages/plugin/webpack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ module.exports = {
preload: {
js: './src/preload.js'
}
}],
}]
}
}
}
]
}
};
```
3 changes: 2 additions & 1 deletion packages/publisher/bitbucket/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,10 @@ module.exports = {
username: 'myusername',
appPassword: 'mysecretapppassword'
}
}
}
]
}
};
```

Alternatively you can (and should) use environment variables for the authentication
Expand Down
2 changes: 1 addition & 1 deletion packages/publisher/electron-release-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ module.exports = {
}
}
]
}
};
```
2 changes: 1 addition & 1 deletion packages/publisher/github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ module.exports = {
}
}
]
}
};
```
2 changes: 1 addition & 1 deletion packages/publisher/nucleus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ module.exports = {
}
}
]
}
};
```

We recommend you set the `token`option using an environment variable, don't hard code into in your config.
2 changes: 1 addition & 1 deletion packages/publisher/s3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ module.exports = {
}
}
]
}
};
```

If you run publish twice with the same version on the same platform, it is possible for your old artifacts to get overwritten in S3. It is your responsibility to ensure that you don't overwrite your own releases.
Expand Down
4 changes: 2 additions & 2 deletions packages/publisher/snapcraft/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ module.exports = {
{
name: '@electron-forge/publisher-snapcraft',
config: {
release: "latest/edge, insider/stable"
release: 'latest/edge, insider/stable'
}
}
]
}
};
```
8 changes: 4 additions & 4 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1173,10 +1173,10 @@
global-agent "^3.0.0"
global-tunnel-ng "^2.7.1"

"@electron/lint-roller@^1.5.0":
version "1.5.0"
resolved "https://registry.yarnpkg.com/@electron/lint-roller/-/lint-roller-1.5.0.tgz#9b743979e1b03327e475fa696bb781eb2ea05ef2"
integrity sha512-205UxwJEx8zv5wLwPq4wMA0OYrJ7d1GuqOhPav0Uy2HWe4K+DZbSP50safCvZCSpI6Op3DMo79tp5i8VppuPWA==
"@electron/lint-roller@^1.6.0":
version "1.6.0"
resolved "https://registry.yarnpkg.com/@electron/lint-roller/-/lint-roller-1.6.0.tgz#ff92da35379b25bce5cf99310ac541ce6a1500d5"
integrity sha512-R3x25b6OK/PQTONfs24FZaYyArS53e/fFB8IDpHFObVMXjkwU+1ePRwysk2jF23ifiQ1bY27llxzLOD+3UugBQ==
dependencies:
"@dsanders11/vscode-markdown-languageservice" "^0.3.0"
glob "^8.1.0"
Expand Down

0 comments on commit 7a9edbc

Please sign in to comment.