@workshops.de/slidev-toolkit 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -10
- package/package.json +11 -2
- package/prettier.mjs +17 -0
package/README.md
CHANGED
|
@@ -15,7 +15,10 @@ reaches every repository with one version bump.
|
|
|
15
15
|
- `workshop-slides install-browser`: installs the Chromium version that matches the bundled
|
|
16
16
|
Playwright (npm 11 does not run Playwright's own install script).
|
|
17
17
|
- **Pinned core dependencies:** `@slidev/cli`, `playwright-chromium`, `typescript` (6, required by
|
|
18
|
-
Slidev's Twoslash setup) and `
|
|
18
|
+
Slidev's Twoslash setup), `vue` and the addons `slidev-addon-tldraw` and
|
|
19
|
+
`slidev-addon-window-mockup` (decks still list the addons they use in their headmatter).
|
|
20
|
+
- **Shared Prettier config** with `prettier` and `prettier-plugin-slidev`: set
|
|
21
|
+
`"prettier": "@workshops.de/slidev-toolkit/prettier"` in `package.json` instead of a `.prettierrc`.
|
|
19
22
|
- **Reusable deploy workflow:** `.github/workflows/deploy.yml`, called from each slide repository.
|
|
20
23
|
|
|
21
24
|
Two repository layouts are detected automatically:
|
|
@@ -27,7 +30,7 @@ Two repository layouts are detected automatically:
|
|
|
27
30
|
|
|
28
31
|
## Using it in a slide repository
|
|
29
32
|
|
|
30
|
-
`package.json`: only the toolkit
|
|
33
|
+
`package.json`: only the toolkit and the theme:
|
|
31
34
|
|
|
32
35
|
```json
|
|
33
36
|
{
|
|
@@ -36,13 +39,12 @@ Two repository layouts are detected automatically:
|
|
|
36
39
|
"build": "workshop-slides build",
|
|
37
40
|
"export": "slidev export"
|
|
38
41
|
},
|
|
42
|
+
"prettier": "@workshops.de/slidev-toolkit/prettier",
|
|
39
43
|
"dependencies": {
|
|
40
|
-
"@workshops.de/slidev-theme": "2.1.0"
|
|
41
|
-
"slidev-addon-tldraw": "^0.5.1",
|
|
42
|
-
"slidev-addon-window-mockup": "0.3.1"
|
|
44
|
+
"@workshops.de/slidev-theme": "2.1.0"
|
|
43
45
|
},
|
|
44
46
|
"devDependencies": {
|
|
45
|
-
"@workshops.de/slidev-toolkit": "^1.
|
|
47
|
+
"@workshops.de/slidev-toolkit": "^1.1.0"
|
|
46
48
|
}
|
|
47
49
|
}
|
|
48
50
|
```
|
|
@@ -77,10 +79,11 @@ Then set **Settings → Pages → Source → GitHub Actions** once per repositor
|
|
|
77
79
|
|
|
78
80
|
## Releasing
|
|
79
81
|
|
|
80
|
-
1. Bump `version` in `package.json` and
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
82
|
+
1. Bump `version` in `package.json` (`npm version patch|minor|major --no-git-tag-version`) and push
|
|
83
|
+
to `main`.
|
|
84
|
+
2. The release workflow publishes to npm via trusted publishing (OIDC, no token; configured on
|
|
85
|
+
npmjs.com for `workshops-de/slidev-toolkit` and `release.yml`), creates the tag `vX.Y.Z` and moves
|
|
86
|
+
the major tag (`v1`) that slide repositories use for the reusable workflow.
|
|
84
87
|
3. Dependabot in the slide repositories picks up the new version.
|
|
85
88
|
|
|
86
89
|
Breaking changes (a new Slidev major that needs content changes, a changed CLI) get a new major version,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workshops.de/slidev-toolkit",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "Shared build, dev and deploy tooling for workshops.de Slidev slide repositories",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -11,8 +11,13 @@
|
|
|
11
11
|
"bin": {
|
|
12
12
|
"workshop-slides": "bin/workshop-slides.mjs"
|
|
13
13
|
},
|
|
14
|
+
"exports": {
|
|
15
|
+
"./prettier": "./prettier.mjs",
|
|
16
|
+
"./package.json": "./package.json"
|
|
17
|
+
},
|
|
14
18
|
"files": [
|
|
15
|
-
"bin"
|
|
19
|
+
"bin",
|
|
20
|
+
"prettier.mjs"
|
|
16
21
|
],
|
|
17
22
|
"engines": {
|
|
18
23
|
"node": ">=24",
|
|
@@ -21,6 +26,10 @@
|
|
|
21
26
|
"dependencies": {
|
|
22
27
|
"@slidev/cli": "^53.1.0",
|
|
23
28
|
"playwright-chromium": "^1.65.0",
|
|
29
|
+
"prettier": "^3.9.10",
|
|
30
|
+
"prettier-plugin-slidev": "^1.0.5",
|
|
31
|
+
"slidev-addon-tldraw": "^0.5.1",
|
|
32
|
+
"slidev-addon-window-mockup": "^0.3.1",
|
|
24
33
|
"typescript": "^6.0.3",
|
|
25
34
|
"vue": "^3.5.45"
|
|
26
35
|
}
|
package/prettier.mjs
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
// Shared Prettier config for workshops.de slide repositories.
|
|
2
|
+
// Use it with "prettier": "@workshops.de/slidev-toolkit/prettier" in package.json.
|
|
3
|
+
import { createRequire } from 'node:module';
|
|
4
|
+
|
|
5
|
+
const require = createRequire(import.meta.url);
|
|
6
|
+
|
|
7
|
+
export default {
|
|
8
|
+
semi: true,
|
|
9
|
+
singleQuote: true,
|
|
10
|
+
tabWidth: 2,
|
|
11
|
+
trailingComma: 'es5',
|
|
12
|
+
printWidth: 100,
|
|
13
|
+
// Resolved here so the plugin is found even though it is a dependency of this package,
|
|
14
|
+
// not of the slide repository.
|
|
15
|
+
plugins: [require.resolve('prettier-plugin-slidev')],
|
|
16
|
+
overrides: [{ files: '*.md', options: { parser: 'slidev' } }],
|
|
17
|
+
};
|