nuxt-codemirror 0.0.1 → 0.0.2

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 (3) hide show
  1. package/README.md +85 -86
  2. package/dist/module.json +1 -1
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,86 +1,85 @@
1
-
2
-
3
- # Nuxt CodeMirror
4
-
5
- [![npm version][npm-version-src]][npm-version-href]
6
- [![npm downloads][npm-downloads-src]][npm-downloads-href]
7
- [![License][license-src]][license-href]
8
- [![Nuxt][nuxt-src]][nuxt-href]
9
-
10
- Codemirror as a Nuxt module. Demo preview: Coming soon
11
-
12
-
13
- - [✨  Release Notes](/CHANGELOG.md)
14
- <!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
15
- <!-- - [📖 &nbsp;Documentation](https://example.com) -->
16
-
17
- ## Features
18
-
19
- <!-- Highlight some of the features your module provide here -->
20
- - 🚀 Easily configure codemirror to your own needs using almost every API
21
- - 🚠 Built with Typescript
22
- - 🌲 Custom useNuxtCodeMirror composable for creating your own editor
23
- - Built for CodeMirror 6 and above
24
-
25
- ## Quick Setup
26
-
27
- Install the module to your Nuxt application with one command:
28
-
29
- ```bash
30
- npx nuxi module add thimodev/nuxt-codemirror
31
- ```
32
-
33
- That's it! You can now use Nuxt-codemirror in your Nuxt app ✨
34
-
35
- ## Contribution
36
-
37
- <details>
38
- <summary>Local development</summary>
39
-
40
- ```bash
41
- # Install dependencies
42
- pnpm i
43
-
44
- # Generate type stubs
45
- pnpm dev:prepare
46
-
47
- # Develop with the playground
48
- pnpm dev
49
-
50
- # Build the playground
51
- pnpm dev:build
52
-
53
- # Run ESLint
54
- pnpm lint
55
-
56
- # Run Vitest
57
- pnpm test
58
- pnpm test:watch
59
-
60
- # Release new version
61
- pnpm release
62
- ```
63
-
64
- </details>
65
-
66
-
67
- <!-- Badges -->
68
- [npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82
69
- [npm-version-href]: https://npmjs.com/package/my-module
70
-
71
- [npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=020420&colorB=00DC82
72
- [npm-downloads-href]: https://npmjs.com/package/my-module
73
-
74
- [license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=020420&colorB=00DC82
75
- [license-href]: https://npmjs.com/package/my-module
76
-
77
- [nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
78
- [nuxt-href]: https://nuxt.com
79
-
80
-
81
-
82
- ## FAQ
83
-
84
- - I get an extension duplicate error: Fix Unrecognized extension value in extension set ([object Object]). This sometimes happens because multiple instances of @codemirror/state are loaded, breaking instanceof checks.
85
-
86
- For now write shamefully-hoist=true in your .npmrc file to solve this. We are working on a better solution
1
+
2
+
3
+ # Nuxt-CodeMirror
4
+
5
+ [![npm version][npm-version-src]][npm-version-href]
6
+ [![npm downloads][npm-downloads-src]][npm-downloads-href]
7
+ [![License][license-src]][license-href]
8
+ [![Nuxt][nuxt-src]][nuxt-href]
9
+
10
+ My new Nuxt module for doing amazing things.
11
+
12
+ - [✨ &nbsp;Release Notes](/CHANGELOG.md)
13
+ <!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
14
+ <!-- - [📖 &nbsp;Documentation](https://example.com) -->
15
+
16
+ ## Features
17
+
18
+ <!-- Highlight some of the features your module provide here -->
19
+ - ⛰ &nbsp;Foo
20
+ - 🚠 &nbsp;Bar
21
+ - 🌲 &nbsp;Baz
22
+
23
+ ## Quick Setup
24
+
25
+ Install the module to your Nuxt application with one command:
26
+
27
+ ```bash
28
+ npx nuxi module add my-module
29
+ ```
30
+
31
+ That's it! You can now use My Module in your Nuxt app ✨
32
+
33
+
34
+ ## Contribution
35
+
36
+ <details>
37
+ <summary>Local development</summary>
38
+
39
+ ```bash
40
+ # Install dependencies
41
+ npm install
42
+
43
+ # Generate type stubs
44
+ npm run dev:prepare
45
+
46
+ # Develop with the playground
47
+ npm run dev
48
+
49
+ # Build the playground
50
+ npm run dev:build
51
+
52
+ # Run ESLint
53
+ npm run lint
54
+
55
+ # Run Vitest
56
+ npm run test
57
+ npm run test:watch
58
+
59
+ # Release new version
60
+ npm run release
61
+ ```
62
+
63
+ </details>
64
+
65
+
66
+ <!-- Badges -->
67
+ [npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82
68
+ [npm-version-href]: https://npmjs.com/package/my-module
69
+
70
+ [npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=020420&colorB=00DC82
71
+ [npm-downloads-href]: https://npmjs.com/package/my-module
72
+
73
+ [license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=020420&colorB=00DC82
74
+ [license-href]: https://npmjs.com/package/my-module
75
+
76
+ [nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
77
+ [nuxt-href]: https://nuxt.com
78
+
79
+
80
+
81
+ ## TO write FAQ
82
+
83
+ - I get extension duplicate error: Fix Unrecognized extension value in extension set ([object Object]). This sometimes happens because multiple instances of @codemirror/state are loaded, breaking instanceof checks.
84
+
85
+ shamefully hoist solves it for now with pnpm together with a resolutions config for codemirror state
package/dist/module.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "nuxt-codemirror",
3
3
  "configKey": "nuxtCodemirror",
4
- "version": "0.0.1",
4
+ "version": "0.0.2",
5
5
  "builder": {
6
6
  "@nuxt/module-builder": "0.8.1",
7
7
  "unbuild": "2.0.0"
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "nuxt-codemirror",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "Nuxt codemirror module",
5
- "repository": "https://github.com/ThimoDEV/nuxt-codemirror",
5
+ "repository": "your-org/my-module",
6
6
  "license": "MIT",
7
7
  "type": "module",
8
8
  "exports": {