Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@nuxt/module-builder
Advanced tools
The complete solution to build and ship Nuxt modules.
@nuxt/schema
We recommend to checkout the Nuxt modules author guide before starting with the module-builder.
For a user to use a module generated from module-builder, it's recommended they have:
Get started with our module starter:
npx nuxi init -t module my-module
The module builder requires a special project structure. You can check out the module template.
src/module.ts
The entrypoint for module definition.
A default export using defineNuxtModule
and ModuleOptions
type export is expected.
You could also optionally export ModuleHooks
or ModuleRuntimeHooks
to annotate any custom hooks the module uses.
import { defineNuxtModule } from '@nuxt/kit'
export interface ModuleOptions {
apiKey: string
}
export interface ModuleHooks {
'my-module:init': any
}
export interface ModuleRuntimeHooks {
'my-module:runtime-hook': any
}
export interface ModuleRuntimeConfig {
PRIVATE_NAME: string
}
export interface ModulePublicRuntimeConfig {
NAME: string
}
export default defineNuxtModule<ModuleOptions>({
meta: {
name: 'my-module',
configKey: 'myModule'
},
defaults: {
apiKey: 'test'
},
async setup (moduleOptions, nuxt) {
// Write module logic in setup function
}
})
src/runtime/
Any runtime file and code that we need to provide by module including plugins, composables and server api, should be in this directory.
Each file will be transformed individually using unjs/mkdist to dist/runtime/
.
package.json
:A minimum package.json
should look like this:
{
"name": "my-module",
"license": "MIT",
"version": "1.0.0",
"exports": {
".": {
"import": "./dist/module.mjs",
"require": "./dist/module.cjs"
}
},
"main": "./dist/module.cjs",
"types": "./dist/types.d.ts",
"files": [
"dist"
],
"scripts": {
"prepack": "nuxt-module-build"
},
"dependencies": {
"@nuxt/kit": "npm:@nuxt/kit-edge@latest"
},
"devDependencies": {
"@nuxt/module-builder": "latest"
}
}
Module builder generates dist files in dist/
directory:
module.mjs
: Module entrypoint build from src/module
module.json
: Module meta extracted from module.mjs
+ package.json
module.cjs
: ESM proxy to allow require module in CommonJS contexttypes.d.ts
: Exported types in addition to shims for nuxt.config
auto completion.runtime/*
: Individually transformed files using unjs/mkdist
.ts
files will be transformed to .mjs
with extracted types on .d.ts
file with same name.vue
files will be transformed with extracted .d.ts
filecorepack enable
pnpm install
pnpm example:build
MIT - Made with 💚
v0.5.5
RuntimeModuleHooks
to ModuleRuntimeHooks
(#194).d.mts
file (#202)ModulePrivateRuntimeConfig
(34ee148)FAQs
Complete solution for building Nuxt modules
The npm package @nuxt/module-builder receives a total of 31,770 weekly downloads. As such, @nuxt/module-builder popularity was classified as popular.
We found that @nuxt/module-builder demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.