usemods-nuxt 0.0.8 → 0.0.11

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 (6) hide show
  1. package/README.md +16 -60
  2. package/dist/module.json +3 -3
  3. package/dist/module.mjs +2 -2
  4. package/dist/types.d.mts +4 -4
  5. package/dist/types.d.ts +4 -4
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -1,36 +1,29 @@
1
- <!--
2
- Get your module up and running quickly.
1
+ ![Frame 1209](https://github.com/jrmymbtlr/usemods/assets/24998792/e2dda730-da67-448d-b1c8-bad447c5fa5b)
3
2
 
4
- Find and replace all on all files (CMD+SHIFT+F):
5
- - Name: My Module
6
- - Package name: mods-module
7
- - Description: My new Nuxt module
8
- -->
9
-
10
- # My Module
3
+ # Use Mods (Nuxt Module)
4
+ Auto-imported functions and modifiers for zippy Nuxt developers.
11
5
 
12
6
  [![npm version][npm-version-src]][npm-version-href]
13
7
  [![npm downloads][npm-downloads-src]][npm-downloads-href]
14
8
  [![License][license-src]][license-href]
15
9
  [![Nuxt][nuxt-src]][nuxt-href]
16
10
 
17
- My new Nuxt module for doing amazing things.
18
-
19
- - [✨ &nbsp;Release Notes](/CHANGELOG.md)
20
- <!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/mods-module?file=playground%2Fapp.vue) -->
21
- <!-- - [📖 &nbsp;Documentation](https://example.com) -->
11
+ <!-- Badges -->
12
+ [npm-version-src]: https://img.shields.io/npm/v/usemods-nuxt/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
13
+ [npm-version-href]: https://npmjs.com/package/usemods-nuxt
22
14
 
23
- ## Features
15
+ [npm-downloads-src]: https://img.shields.io/npm/dm/usemods-nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
16
+ [npm-downloads-href]: https://npmjs.com/package/usemods-nuxt
24
17
 
25
- <!-- Highlight some of the features your module provide here -->
18
+ [license-src]: https://img.shields.io/npm/l/usemods-nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
19
+ [license-href]: https://npmjs.com/package/usemods-nuxt
26
20
 
27
- - ⛰ &nbsp;Foo
28
- - 🚠 &nbsp;Bar
29
- - 🌲 &nbsp;Baz
21
+ [nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
22
+ [nuxt-href]: https://nuxt.com
30
23
 
31
24
  ## Quick Setup
32
25
 
33
- 1. Add `mods-module` dependency to your project
26
+ 1. Add `usemods` dependency to your project
34
27
 
35
28
  ```bash
36
29
  # Using pnpm
@@ -43,49 +36,12 @@ yarn add --dev mods-module
43
36
  npm install --save-dev mods-module
44
37
  ```
45
38
 
46
- 2. Add `mods-module` to the `modules` section of `nuxt.config.ts`
39
+ 2. Add `usemods` to the `modules` section of `nuxt.config.ts`
47
40
 
48
41
  ```js
49
42
  export default defineNuxtConfig({
50
- modules: ["mods-module"],
43
+ modules: ["usemods"],
51
44
  })
52
45
  ```
53
46
 
54
- That's it! You can now use My Module in your Nuxt app ✨
55
-
56
- ## Development
57
-
58
- ```bash
59
- # Install dependencies
60
- npm install
61
-
62
- # Generate type stubs
63
- npm run dev:prepare
64
-
65
- # Develop with the playground
66
- npm run dev
67
-
68
- # Build the playground
69
- npm run dev:build
70
-
71
- # Run ESLint
72
- npm run lint
73
-
74
- # Run Vitest
75
- npm run test
76
- npm run test:watch
77
-
78
- # Release new version
79
- npm run release
80
- ```
81
-
82
- <!-- Badges -->
83
-
84
- [npm-version-src]: https://img.shields.io/npm/v/mods-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
85
- [npm-version-href]: https://npmjs.com/package/mods-module
86
- [npm-downloads-src]: https://img.shields.io/npm/dm/mods-module.svg?style=flat&colorA=18181B&colorB=28CF8D
87
- [npm-downloads-href]: https://npmjs.com/package/mods-module
88
- [license-src]: https://img.shields.io/npm/l/mods-module.svg?style=flat&colorA=18181B&colorB=28CF8D
89
- [license-href]: https://npmjs.com/package/mods-module
90
- [nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
91
- [nuxt-href]: https://nuxt.com
47
+ That's it! You've got every mod in your Nuxt app ✨
package/dist/module.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "name": "mods-module",
3
- "configKey": "modsModule",
4
- "version": "0.0.8"
2
+ "name": "usemods",
3
+ "configKey": "usemods",
4
+ "version": "0.0.11"
5
5
  }
package/dist/module.mjs CHANGED
@@ -946,8 +946,8 @@ const utils = {
946
946
 
947
947
  const module = defineNuxtModule({
948
948
  meta: {
949
- name: "mods-module",
950
- configKey: "modsModule"
949
+ name: "usemods",
950
+ configKey: "usemods"
951
951
  },
952
952
  // Default configuration options of the Nuxt module
953
953
  defaults: {
package/dist/types.d.mts CHANGED
@@ -3,13 +3,13 @@ import type { ModuleOptions } from './module.js'
3
3
 
4
4
 
5
5
  declare module '@nuxt/schema' {
6
- interface NuxtConfig { ['modsModule']?: Partial<ModuleOptions> }
7
- interface NuxtOptions { ['modsModule']?: ModuleOptions }
6
+ interface NuxtConfig { ['usemods']?: Partial<ModuleOptions> }
7
+ interface NuxtOptions { ['usemods']?: ModuleOptions }
8
8
  }
9
9
 
10
10
  declare module 'nuxt/schema' {
11
- interface NuxtConfig { ['modsModule']?: Partial<ModuleOptions> }
12
- interface NuxtOptions { ['modsModule']?: ModuleOptions }
11
+ interface NuxtConfig { ['usemods']?: Partial<ModuleOptions> }
12
+ interface NuxtOptions { ['usemods']?: ModuleOptions }
13
13
  }
14
14
 
15
15
 
package/dist/types.d.ts CHANGED
@@ -3,13 +3,13 @@ import type { ModuleOptions } from './module'
3
3
 
4
4
 
5
5
  declare module '@nuxt/schema' {
6
- interface NuxtConfig { ['modsModule']?: Partial<ModuleOptions> }
7
- interface NuxtOptions { ['modsModule']?: ModuleOptions }
6
+ interface NuxtConfig { ['usemods']?: Partial<ModuleOptions> }
7
+ interface NuxtOptions { ['usemods']?: ModuleOptions }
8
8
  }
9
9
 
10
10
  declare module 'nuxt/schema' {
11
- interface NuxtConfig { ['modsModule']?: Partial<ModuleOptions> }
12
- interface NuxtOptions { ['modsModule']?: ModuleOptions }
11
+ interface NuxtConfig { ['usemods']?: Partial<ModuleOptions> }
12
+ interface NuxtOptions { ['usemods']?: ModuleOptions }
13
13
  }
14
14
 
15
15
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "usemods-nuxt",
3
- "version": "0.0.8",
3
+ "version": "0.0.11",
4
4
  "description": "Zippy little modifiers and utilities for your Nuxt app.",
5
5
  "repository": {
6
6
  "type": "git",