@md-plugins/quasar-app-extension-q-press 0.1.0-beta.14 → 0.1.0-beta.15

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.
Files changed (8) hide show
  1. package/README.md +2 -2
  2. package/dist/index.js +1 -5
  3. package/dist/install.js +1 -5
  4. package/dist/templates/init/src/markdown/guides/upgrade-guide.md +75 -3
  5. package/package.json +15 -15
  6. package/src/index.ts +1 -6
  7. package/src/install.ts +1 -6
  8. package/src/templates/init/src/markdown/guides/upgrade-guide.md +75 -3
package/README.md CHANGED
@@ -4,9 +4,9 @@ The Ultimate Markdown Solution for the Quasar Framework.
4
4
 
5
5
  See the [documentation](https://md-plugins.netlify.app/quasar-app-extensions/qpress/overview) for more information.
6
6
 
7
- > Current beta release: `0.1.0-beta.13`.
7
+ > Current beta release: `0.1.0-beta.14`.
8
8
  >
9
- > Q-Press currently targets Quasar Vite projects using `@quasar/app-vite` `>=3.0.0-beta.30`. TypeScript processing is required.
9
+ > Q-Press currently targets Quasar Vite projects using `@quasar/app-vite` `>=3.0.0-beta.31`. TypeScript processing is required.
10
10
 
11
11
  ## Features
12
12
 
package/dist/index.js CHANGED
@@ -41,12 +41,8 @@ function extendTypeScriptConfig(typescriptConfig) {
41
41
  };
42
42
  }
43
43
  export default defineIndexScript((api) => {
44
- // verify this is a Vite project
45
- if (!api.hasVite) {
46
- throw new Error('This extension requires Vite');
47
- }
48
44
  api.compatibleWith('quasar', '^2.0.0');
49
- api.compatibleWith('@quasar/app-vite', '>=3.0.0-beta.29');
45
+ api.compatibleWith('@quasar/app-vite', '>=3.0.0-beta.32');
50
46
  // here we extend /quasar.config, so we can add some Vite/Vue stuff
51
47
  api.extendQuasarConf(async (config) => {
52
48
  config.build ??= {};
package/dist/install.js CHANGED
@@ -6,12 +6,8 @@
6
6
  import { defineInstallScript } from '@quasar/app-vite';
7
7
  import { existsSync } from 'node:fs';
8
8
  export default defineInstallScript(async (api) => {
9
- // verify this is a Vite project
10
- if (!api.hasVite) {
11
- throw new Error('This extension requires Vite');
12
- }
13
9
  api.compatibleWith('quasar', '^2.0.0');
14
- api.compatibleWith('@quasar/app-vite', '>=3.0.0-beta.29');
10
+ api.compatibleWith('@quasar/app-vite', '>=3.0.0-beta.32');
15
11
  // project must have pinia installed
16
12
  if ((await api.getStorePackageName()) !== 'pinia') {
17
13
  console.error('-----------------------------');
package/dist/templates/init/src/markdown/guides/upgrade-guide.md CHANGED
@@ -7,16 +7,16 @@ related:
7
7
  - vite-plugins/vite-md-plugin/overview
8
8
  ---
9
9
 
10
- The `0.1.0` beta line moves MD-Plugins and Q-Press to the Quasar CLI Vite 3 beta toolchain. It is the right version to use when your Quasar application is being upgraded to `@quasar/app-vite` `>=3.0.0-beta.30`.
10
+ The `0.1.0` beta line moves MD-Plugins and Q-Press to the Quasar CLI Vite 3 beta toolchain. It is the right version to use when your Quasar application is being upgraded to `@quasar/app-vite` `>=3.0.0-beta.31`.
11
11
 
12
12
  ::: warning
13
- Q-Press and the Quasar app extensions now target Quasar Vite projects using `@quasar/app-vite` `>=3.0.0-beta.30`. They are not intended for Webpack projects or JavaScript-only Quasar projects.
13
+ Q-Press and the Quasar app extensions now target Quasar Vite projects using `@quasar/app-vite` `>=3.0.0-beta.31`. They are not intended for Webpack projects or JavaScript-only Quasar projects.
14
14
  :::
15
15
 
16
16
  ## Before You Upgrade
17
17
 
18
18
  - Make sure your app is already on a Quasar Vite setup.
19
- - Upgrade the app to `@quasar/app-vite` `>=3.0.0-beta.30`.
19
+ - Upgrade the app to `@quasar/app-vite` `>=3.0.0-beta.31`.
20
20
  - Use TypeScript in the consuming Quasar project.
21
21
  - Import `defineConfig` in `quasar.config.ts` directly from `@quasar/app-vite`.
22
22
  - Use `/// <reference types="@quasar/app-vite/client" />` in `src/env.d.ts`.
@@ -28,6 +28,17 @@ For Q-Press projects, update the app extension package and then invoke it:
28
28
 
29
29
  ```bash
30
30
  pnpm up @md-plugins/quasar-app-extension-q-press@beta
31
+ # or
32
+ npm install @md-plugins/quasar-app-extension-q-press@beta
33
+ # or
34
+ yarn add @md-plugins/quasar-app-extension-q-press@beta
35
+ # or
36
+ bun add @md-plugins/quasar-app-extension-q-press@beta
37
+ ```
38
+
39
+ Then invoke the app extension:
40
+
41
+ ```bash
31
42
  quasar ext invoke @md-plugins/q-press
32
43
  ```
33
44
 
@@ -37,12 +48,62 @@ For direct Vite plugin usage, update the packages you consume:
37
48
 
38
49
  ```bash
39
50
  pnpm up @md-plugins/vite-md-plugin@beta @md-plugins/vite-examples-plugin@beta
51
+ # or
52
+ npm install @md-plugins/vite-md-plugin@beta @md-plugins/vite-examples-plugin@beta
53
+ # or
54
+ yarn add @md-plugins/vite-md-plugin@beta @md-plugins/vite-examples-plugin@beta
55
+ # or
56
+ bun add @md-plugins/vite-md-plugin@beta @md-plugins/vite-examples-plugin@beta
57
+ ```
58
+
59
+ ## Remove App-Level Shared Imports
60
+
61
+ Q-Press applications should not install or import `@md-plugins/shared` directly. The shared package remains part of the MD-Plugins internals, but app-level Q-Press files should use the helpers generated into the app.
62
+
63
+ If your project has this dependency, remove it from the consuming app:
64
+
65
+ ```bash
66
+ pnpm remove @md-plugins/shared
67
+ # or
68
+ npm uninstall @md-plugins/shared
69
+ # or
70
+ yarn remove @md-plugins/shared
71
+ # or
72
+ bun remove @md-plugins/shared
73
+ ```
74
+
75
+ If you have customized generated files and cannot choose `Overwrite All`, update copied Q-Press files that import `slugify` from `@md-plugins/shared`.
76
+
77
+ Use the local helper from `src/.q-press/components/markdown-utils.ts` instead:
78
+
79
+ ```ts
80
+ import { slugify } from './markdown-utils'
81
+ ```
82
+
83
+ For files outside `src/.q-press/components`, import from the generated helper path used by that file. For example:
84
+
85
+ ```ts
86
+ import { slugify } from '@/.q-press/components/markdown-utils'
87
+ ```
88
+
89
+ or:
90
+
91
+ ```ts
92
+ import { slugify } from '../.q-press/components/markdown-utils'
40
93
  ```
41
94
 
42
95
  ## Q-Press Type Globals
43
96
 
44
97
  Q-Press now provides its shared Markdown, menu and `ImportMeta` globals directly from the app extension package. After upgrading to this release line and running `quasar prepare`, projects no longer need to keep a local `src/q-press.globals.d.ts` file.
45
98
 
99
+ If you still see type errors for `TocMenuItem`, `MenuItem`, `MarkdownModule`, `import.meta.glob` or Quasar `import.meta.env` values, run:
100
+
101
+ ```bash
102
+ quasar prepare
103
+ ```
104
+
105
+ Then make sure the app is using the updated `@md-plugins/quasar-app-extension-q-press` package.
106
+
46
107
  ## Environment Variable Changes
47
108
 
48
109
  Quasar CLI Vite 3 exposes runtime flags through `import.meta.env`. If you copied older Q-Press internals into your own code, update them:
@@ -58,6 +119,17 @@ Quasar CLI Vite 3 exposes runtime flags through `import.meta.env`. If you copied
58
119
 
59
120
  Q-Press also uses `QCLI_*` values for Quasar CLI provided build-time values, such as search index and filesystem paths.
60
121
 
122
+ ## Example Action Updates
123
+
124
+ The beta templates include updated example actions for GitHub source links and CodePen playgrounds. If your project keeps customized Q-Press files, compare your copies of these files with the current template:
125
+
126
+ - `src/.q-press/components/MarkdownExample.vue`
127
+ - `src/.q-press/components/MarkdownCodepen.vue`
128
+ - `src/.q-press/components/markdown-utils.ts`
129
+ - `src/siteConfig/index.ts`
130
+
131
+ Set `siteConfig.githubSourceRootSrc` when the source-view link should point at generated example files instead of edit links. Configure `siteConfig.codepen` when examples need external CSS, JavaScript, setup code, package globals or a project-specific `titleSuffix`.
132
+
61
133
  ## Vite Plugin Configuration
62
134
 
63
135
  `viteMdPlugin` should be configured with an options object:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@md-plugins/quasar-app-extension-q-press",
3
- "version": "0.1.0-beta.14",
3
+ "version": "0.1.0-beta.15",
4
4
  "description": "QPress - The Ultimate Markdown Solution for Quasar Framework",
5
5
  "keywords": [
6
6
  "markdown",
@@ -30,26 +30,26 @@
30
30
  "@types/markdown-it": "^14.1.2",
31
31
  "fs-extra": "^11.3.5",
32
32
  "markdown-it": "^14.2.0",
33
- "@md-plugins/md-plugin-codeblocks": "0.1.0-beta.14",
34
- "@md-plugins/md-plugin-frontmatter": "0.1.0-beta.14",
35
- "@md-plugins/md-plugin-image": "0.1.0-beta.14",
36
- "@md-plugins/md-plugin-containers": "0.1.0-beta.14",
37
- "@md-plugins/md-plugin-inlinecode": "0.1.0-beta.14",
38
- "@md-plugins/md-plugin-blockquote": "0.1.0-beta.14",
39
- "@md-plugins/md-plugin-imports": "0.1.0-beta.14",
40
- "@md-plugins/md-plugin-headers": "0.1.0-beta.14",
41
- "@md-plugins/md-plugin-link": "0.1.0-beta.14",
42
- "@md-plugins/md-plugin-table": "0.1.0-beta.14",
43
- "@md-plugins/md-plugin-title": "0.1.0-beta.14",
44
- "@md-plugins/vite-md-plugin": "0.1.0-beta.14"
33
+ "@md-plugins/md-plugin-frontmatter": "0.1.0-beta.15",
34
+ "@md-plugins/md-plugin-blockquote": "0.1.0-beta.15",
35
+ "@md-plugins/md-plugin-containers": "0.1.0-beta.15",
36
+ "@md-plugins/md-plugin-image": "0.1.0-beta.15",
37
+ "@md-plugins/md-plugin-imports": "0.1.0-beta.15",
38
+ "@md-plugins/md-plugin-headers": "0.1.0-beta.15",
39
+ "@md-plugins/md-plugin-inlinecode": "0.1.0-beta.15",
40
+ "@md-plugins/md-plugin-link": "0.1.0-beta.15",
41
+ "@md-plugins/md-plugin-codeblocks": "0.1.0-beta.15",
42
+ "@md-plugins/md-plugin-title": "0.1.0-beta.15",
43
+ "@md-plugins/vite-md-plugin": "0.1.0-beta.15",
44
+ "@md-plugins/md-plugin-table": "0.1.0-beta.15"
45
45
  },
46
46
  "devDependencies": {
47
- "@quasar/app-vite": "3.0.0-beta.31",
47
+ "@quasar/app-vite": "3.0.0-beta.32",
48
48
  "@types/markdown-it": "^14.1.2",
49
49
  "vite": "^8.0.14"
50
50
  },
51
51
  "peerDependencies": {
52
- "@quasar/app-vite": ">=3.0.0-beta.30",
52
+ "@quasar/app-vite": ">=3.0.0-beta.32",
53
53
  "markdown-it": "^14.2.0"
54
54
  },
55
55
  "engines": {
package/src/index.ts CHANGED
@@ -78,13 +78,8 @@ function extendTypeScriptConfig(typescriptConfig: QuasarTypescriptConfig): void
78
78
  }
79
79
 
80
80
  export default defineIndexScript((api) => {
81
- // verify this is a Vite project
82
- if (!api.hasVite) {
83
- throw new Error('This extension requires Vite')
84
- }
85
-
86
81
  api.compatibleWith('quasar', '^2.0.0')
87
- api.compatibleWith('@quasar/app-vite', '>=3.0.0-beta.29')
82
+ api.compatibleWith('@quasar/app-vite', '>=3.0.0-beta.32')
88
83
 
89
84
  // here we extend /quasar.config, so we can add some Vite/Vue stuff
90
85
  api.extendQuasarConf(async (config) => {
package/src/install.ts CHANGED
@@ -8,13 +8,8 @@ import { defineInstallScript } from '@quasar/app-vite'
8
8
  import { existsSync } from 'node:fs'
9
9
 
10
10
  export default defineInstallScript(async (api) => {
11
- // verify this is a Vite project
12
- if (!api.hasVite) {
13
- throw new Error('This extension requires Vite')
14
- }
15
-
16
11
  api.compatibleWith('quasar', '^2.0.0')
17
- api.compatibleWith('@quasar/app-vite', '>=3.0.0-beta.29')
12
+ api.compatibleWith('@quasar/app-vite', '>=3.0.0-beta.32')
18
13
 
19
14
  // project must have pinia installed
20
15
  if ((await api.getStorePackageName()) !== 'pinia') {
package/src/templates/init/src/markdown/guides/upgrade-guide.md CHANGED
@@ -7,16 +7,16 @@ related:
7
7
  - vite-plugins/vite-md-plugin/overview
8
8
  ---
9
9
 
10
- The `0.1.0` beta line moves MD-Plugins and Q-Press to the Quasar CLI Vite 3 beta toolchain. It is the right version to use when your Quasar application is being upgraded to `@quasar/app-vite` `>=3.0.0-beta.30`.
10
+ The `0.1.0` beta line moves MD-Plugins and Q-Press to the Quasar CLI Vite 3 beta toolchain. It is the right version to use when your Quasar application is being upgraded to `@quasar/app-vite` `>=3.0.0-beta.31`.
11
11
 
12
12
  ::: warning
13
- Q-Press and the Quasar app extensions now target Quasar Vite projects using `@quasar/app-vite` `>=3.0.0-beta.30`. They are not intended for Webpack projects or JavaScript-only Quasar projects.
13
+ Q-Press and the Quasar app extensions now target Quasar Vite projects using `@quasar/app-vite` `>=3.0.0-beta.31`. They are not intended for Webpack projects or JavaScript-only Quasar projects.
14
14
  :::
15
15
 
16
16
  ## Before You Upgrade
17
17
 
18
18
  - Make sure your app is already on a Quasar Vite setup.
19
- - Upgrade the app to `@quasar/app-vite` `>=3.0.0-beta.30`.
19
+ - Upgrade the app to `@quasar/app-vite` `>=3.0.0-beta.31`.
20
20
  - Use TypeScript in the consuming Quasar project.
21
21
  - Import `defineConfig` in `quasar.config.ts` directly from `@quasar/app-vite`.
22
22
  - Use `/// <reference types="@quasar/app-vite/client" />` in `src/env.d.ts`.
@@ -28,6 +28,17 @@ For Q-Press projects, update the app extension package and then invoke it:
28
28
 
29
29
  ```bash
30
30
  pnpm up @md-plugins/quasar-app-extension-q-press@beta
31
+ # or
32
+ npm install @md-plugins/quasar-app-extension-q-press@beta
33
+ # or
34
+ yarn add @md-plugins/quasar-app-extension-q-press@beta
35
+ # or
36
+ bun add @md-plugins/quasar-app-extension-q-press@beta
37
+ ```
38
+
39
+ Then invoke the app extension:
40
+
41
+ ```bash
31
42
  quasar ext invoke @md-plugins/q-press
32
43
  ```
33
44
 
@@ -37,12 +48,62 @@ For direct Vite plugin usage, update the packages you consume:
37
48
 
38
49
  ```bash
39
50
  pnpm up @md-plugins/vite-md-plugin@beta @md-plugins/vite-examples-plugin@beta
51
+ # or
52
+ npm install @md-plugins/vite-md-plugin@beta @md-plugins/vite-examples-plugin@beta
53
+ # or
54
+ yarn add @md-plugins/vite-md-plugin@beta @md-plugins/vite-examples-plugin@beta
55
+ # or
56
+ bun add @md-plugins/vite-md-plugin@beta @md-plugins/vite-examples-plugin@beta
57
+ ```
58
+
59
+ ## Remove App-Level Shared Imports
60
+
61
+ Q-Press applications should not install or import `@md-plugins/shared` directly. The shared package remains part of the MD-Plugins internals, but app-level Q-Press files should use the helpers generated into the app.
62
+
63
+ If your project has this dependency, remove it from the consuming app:
64
+
65
+ ```bash
66
+ pnpm remove @md-plugins/shared
67
+ # or
68
+ npm uninstall @md-plugins/shared
69
+ # or
70
+ yarn remove @md-plugins/shared
71
+ # or
72
+ bun remove @md-plugins/shared
73
+ ```
74
+
75
+ If you have customized generated files and cannot choose `Overwrite All`, update copied Q-Press files that import `slugify` from `@md-plugins/shared`.
76
+
77
+ Use the local helper from `src/.q-press/components/markdown-utils.ts` instead:
78
+
79
+ ```ts
80
+ import { slugify } from './markdown-utils'
81
+ ```
82
+
83
+ For files outside `src/.q-press/components`, import from the generated helper path used by that file. For example:
84
+
85
+ ```ts
86
+ import { slugify } from '@/.q-press/components/markdown-utils'
87
+ ```
88
+
89
+ or:
90
+
91
+ ```ts
92
+ import { slugify } from '../.q-press/components/markdown-utils'
40
93
  ```
41
94
 
42
95
  ## Q-Press Type Globals
43
96
 
44
97
  Q-Press now provides its shared Markdown, menu and `ImportMeta` globals directly from the app extension package. After upgrading to this release line and running `quasar prepare`, projects no longer need to keep a local `src/q-press.globals.d.ts` file.
45
98
 
99
+ If you still see type errors for `TocMenuItem`, `MenuItem`, `MarkdownModule`, `import.meta.glob` or Quasar `import.meta.env` values, run:
100
+
101
+ ```bash
102
+ quasar prepare
103
+ ```
104
+
105
+ Then make sure the app is using the updated `@md-plugins/quasar-app-extension-q-press` package.
106
+
46
107
  ## Environment Variable Changes
47
108
 
48
109
  Quasar CLI Vite 3 exposes runtime flags through `import.meta.env`. If you copied older Q-Press internals into your own code, update them:
@@ -58,6 +119,17 @@ Quasar CLI Vite 3 exposes runtime flags through `import.meta.env`. If you copied
58
119
 
59
120
  Q-Press also uses `QCLI_*` values for Quasar CLI provided build-time values, such as search index and filesystem paths.
60
121
 
122
+ ## Example Action Updates
123
+
124
+ The beta templates include updated example actions for GitHub source links and CodePen playgrounds. If your project keeps customized Q-Press files, compare your copies of these files with the current template:
125
+
126
+ - `src/.q-press/components/MarkdownExample.vue`
127
+ - `src/.q-press/components/MarkdownCodepen.vue`
128
+ - `src/.q-press/components/markdown-utils.ts`
129
+ - `src/siteConfig/index.ts`
130
+
131
+ Set `siteConfig.githubSourceRootSrc` when the source-view link should point at generated example files instead of edit links. Configure `siteConfig.codepen` when examples need external CSS, JavaScript, setup code, package globals or a project-specific `titleSuffix`.
132
+
61
133
  ## Vite Plugin Configuration
62
134
 
63
135
  `viteMdPlugin` should be configured with an options object: