@mevbg/nuxt-kit 0.1.1
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/LICENSE +15 -0
- package/README.md +80 -0
- package/dist/module.d.mts +15 -0
- package/dist/module.json +9 -0
- package/dist/module.mjs +30 -0
- package/dist/runtime/defaults.d.ts +1 -0
- package/dist/runtime/defaults.js +1 -0
- package/dist/runtime/plugins/wm.plugin.d.ts +2 -0
- package/dist/runtime/plugins/wm.plugin.js +7 -0
- package/dist/types.d.mts +11 -0
- package/package.json +82 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
ISC License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025, Martin Metodiev
|
|
4
|
+
|
|
5
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
|
6
|
+
purpose with or without fee is hereby granted, provided that the above
|
|
7
|
+
copyright notice and this permission notice appear in all copies.
|
|
8
|
+
|
|
9
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
10
|
+
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
11
|
+
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
12
|
+
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
13
|
+
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
14
|
+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
15
|
+
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Mev’s Nuxt Kit
|
|
2
|
+
|
|
3
|
+
> A personal kit module developed for Nuxt
|
|
4
|
+
|
|
5
|
+
[![npm version][npm-version-src]][npm-version-href]
|
|
6
|
+
[![License][license-src]][license-href]
|
|
7
|
+
[![Nuxt][nuxt-src]][nuxt-href]
|
|
8
|
+
|
|
9
|
+
## 🎯 Overview
|
|
10
|
+
|
|
11
|
+
TODO: To be written…
|
|
12
|
+
|
|
13
|
+
## 🚀 Features
|
|
14
|
+
|
|
15
|
+
TODO: To be written…
|
|
16
|
+
|
|
17
|
+
## 📦 Setup
|
|
18
|
+
|
|
19
|
+
1. Install the module to your Nuxt application with one command:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx nuxi module add @mevbg/nuxt-kit
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
2. Include it in the modules list in `nuxt.config.ts`:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
// nuxt.config.ts
|
|
29
|
+
|
|
30
|
+
export default defineNuxtConfig({
|
|
31
|
+
modules: ['@mevbg/nuxt-kit'],
|
|
32
|
+
|
|
33
|
+
mevKit: {
|
|
34
|
+
// config
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
That's it!
|
|
40
|
+
You can now use `Mev’s Nuxt Kit` in your Nuxt app. ✨
|
|
41
|
+
|
|
42
|
+
## ⚙️ Usage
|
|
43
|
+
|
|
44
|
+
TODO: To be written…
|
|
45
|
+
|
|
46
|
+
## 🔧 Development
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# Install dependencies
|
|
50
|
+
npm install
|
|
51
|
+
|
|
52
|
+
# Generate type stubs
|
|
53
|
+
npm run dev:prepare
|
|
54
|
+
|
|
55
|
+
# Develop with the playground
|
|
56
|
+
npm run dev
|
|
57
|
+
|
|
58
|
+
# Build the playground
|
|
59
|
+
npm run dev:build
|
|
60
|
+
|
|
61
|
+
# Run ESLint
|
|
62
|
+
npm run lint
|
|
63
|
+
|
|
64
|
+
# Release new version
|
|
65
|
+
npm run release
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## 🤝🏻 Contributing
|
|
69
|
+
|
|
70
|
+
This is a personal tool and no contributions are expected.
|
|
71
|
+
At least for now. 😋
|
|
72
|
+
|
|
73
|
+
<!-- Badges -->
|
|
74
|
+
|
|
75
|
+
[npm-version-src]: https://img.shields.io/npm/v/%40mevbg%2Fnuxt-kit/latest.svg?style=flat&colorA=020420&colorB=00DC82
|
|
76
|
+
[npm-version-href]: https://npmjs.com/package/@mevbg/nuxt-kit
|
|
77
|
+
[license-src]: https://img.shields.io/npm/l/@mevbg/nuxt-kit.svg?style=flat&colorA=020420&colorB=00DC82
|
|
78
|
+
[license-href]: https://github.com/mevbg/nuxt-kit/blob/main/LICENSE
|
|
79
|
+
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
|
|
80
|
+
[nuxt-href]: https://nuxt.com
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import * as _nuxt_schema from '@nuxt/schema';
|
|
2
|
+
import { ColorSchemeKey } from '@mevbg/nuxt-color-scheme';
|
|
3
|
+
export * from '@mevbg/nuxt-color-scheme';
|
|
4
|
+
|
|
5
|
+
interface NuxtKitOptions {
|
|
6
|
+
colorScheme?: {
|
|
7
|
+
default?: ColorSchemeKey;
|
|
8
|
+
systemScheme?: boolean;
|
|
9
|
+
};
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
declare const _default: _nuxt_schema.NuxtModule<NuxtKitOptions, NuxtKitOptions, false>;
|
|
13
|
+
|
|
14
|
+
export { _default as default };
|
|
15
|
+
export type { NuxtKitOptions };
|
package/dist/module.json
ADDED
package/dist/module.mjs
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { defineNuxtModule, createResolver, addPlugin, installModule } from '@nuxt/kit';
|
|
2
|
+
import { DEFAULT_COLOR_SCHEME } from '../dist/runtime/defaults.js';
|
|
3
|
+
export * from '@mevbg/nuxt-color-scheme';
|
|
4
|
+
|
|
5
|
+
const module = defineNuxtModule({
|
|
6
|
+
meta: {
|
|
7
|
+
name: "@mevbg/nuxt-kit",
|
|
8
|
+
configKey: "mevKit"
|
|
9
|
+
},
|
|
10
|
+
// Default configuration options of the Nuxt module
|
|
11
|
+
defaults: {
|
|
12
|
+
colorScheme: {
|
|
13
|
+
default: DEFAULT_COLOR_SCHEME,
|
|
14
|
+
systemScheme: true
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
async setup(options, nuxt) {
|
|
18
|
+
nuxt.options.runtimeConfig.public.mevKit = {
|
|
19
|
+
colorScheme: {
|
|
20
|
+
default: options.colorScheme?.default ?? DEFAULT_COLOR_SCHEME,
|
|
21
|
+
systemScheme: options.colorScheme?.systemScheme ?? true
|
|
22
|
+
}
|
|
23
|
+
};
|
|
24
|
+
const resolver = createResolver(import.meta.url);
|
|
25
|
+
addPlugin(resolver.resolve("./runtime/plugins/wm.plugin"));
|
|
26
|
+
await installModule("@mevbg/nuxt-color-scheme");
|
|
27
|
+
}
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
export { module as default };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const DEFAULT_COLOR_SCHEME = "light";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export const DEFAULT_COLOR_SCHEME = "light";
|
package/dist/types.d.mts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { NuxtModule } from '@nuxt/schema'
|
|
2
|
+
|
|
3
|
+
import type { default as Module } from './module.mjs'
|
|
4
|
+
|
|
5
|
+
export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
|
|
6
|
+
|
|
7
|
+
export { default } from './module.mjs'
|
|
8
|
+
|
|
9
|
+
export { type NuxtKitOptions } from './module.mjs'
|
|
10
|
+
|
|
11
|
+
export * from '@mevbg/nuxt-color-scheme'
|
package/package.json
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@mevbg/nuxt-kit",
|
|
3
|
+
"title": "Mev’s Nuxt Kit",
|
|
4
|
+
"version": "0.1.1",
|
|
5
|
+
"description": "Mev’s personal Nuxt kit module.",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"nuxt kit",
|
|
8
|
+
"nuxt starter",
|
|
9
|
+
"nuxt scaffolding",
|
|
10
|
+
"nuxt module",
|
|
11
|
+
"mevbg",
|
|
12
|
+
"personal"
|
|
13
|
+
],
|
|
14
|
+
"homepage": "https://github.com/mevbg/nuxt-kit#readme",
|
|
15
|
+
"bugs": {
|
|
16
|
+
"url": "https://github.com/mevbg/nuxt-kit/issues"
|
|
17
|
+
},
|
|
18
|
+
"repository": {
|
|
19
|
+
"type": "git",
|
|
20
|
+
"url": "git+ssh://git@github.com/mevbg/nuxt-kit.git"
|
|
21
|
+
},
|
|
22
|
+
"license": "ISC",
|
|
23
|
+
"author": {
|
|
24
|
+
"name": "Martin Metodiev • Mev",
|
|
25
|
+
"email": "martin@mev.bg",
|
|
26
|
+
"url": "https://mev.bg"
|
|
27
|
+
},
|
|
28
|
+
"type": "module",
|
|
29
|
+
"main": "./dist/module.mjs",
|
|
30
|
+
"typesVersions": {
|
|
31
|
+
"*": {
|
|
32
|
+
".": [
|
|
33
|
+
"./dist/types.d.mts",
|
|
34
|
+
"./src/types.d.ts"
|
|
35
|
+
]
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"exports": {
|
|
39
|
+
".": {
|
|
40
|
+
"types": "./dist/types.d.mts",
|
|
41
|
+
"import": "./dist/module.mjs"
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
"files": [
|
|
45
|
+
"dist"
|
|
46
|
+
],
|
|
47
|
+
"scripts": {
|
|
48
|
+
"prepack": "nuxt-module-build build",
|
|
49
|
+
"dev": "npm run dev:prepare && nuxi dev playground",
|
|
50
|
+
"dev:build": "nuxi build playground",
|
|
51
|
+
"dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
|
|
52
|
+
"release": "npm run lint && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
|
|
53
|
+
"lint": "eslint .",
|
|
54
|
+
"lint:fix": "eslint . --fix",
|
|
55
|
+
"format": "prettier --write .",
|
|
56
|
+
"format:check": "prettier --check ."
|
|
57
|
+
},
|
|
58
|
+
"engines": {
|
|
59
|
+
"node": ">=22.x",
|
|
60
|
+
"npm": ">=10.x"
|
|
61
|
+
},
|
|
62
|
+
"dependencies": {
|
|
63
|
+
"@mevbg/design-essentials-vendor": "^2.0.4",
|
|
64
|
+
"@mevbg/nuxt-color-scheme": "^1.0.1",
|
|
65
|
+
"@nuxt/kit": "^4.0.3"
|
|
66
|
+
},
|
|
67
|
+
"devDependencies": {
|
|
68
|
+
"@nuxt/devtools": "^2.6.2",
|
|
69
|
+
"@nuxt/eslint-config": "^1.8.0",
|
|
70
|
+
"@nuxt/module-builder": "^1.0.2",
|
|
71
|
+
"@nuxt/schema": "^4.0.3",
|
|
72
|
+
"@types/node": "latest",
|
|
73
|
+
"changelogen": "^0.6.2",
|
|
74
|
+
"eslint": "^9.33.0",
|
|
75
|
+
"eslint-config-prettier": "^10.1.8",
|
|
76
|
+
"eslint-plugin-prettier": "^5.5.4",
|
|
77
|
+
"nuxt": "^4.0.3",
|
|
78
|
+
"prettier-plugin-organize-imports": "^4.2.0",
|
|
79
|
+
"typescript": "~5.9.2",
|
|
80
|
+
"vue-tsc": "^3.0.5"
|
|
81
|
+
}
|
|
82
|
+
}
|