# nuxt-module-builder

> Nuxt Standard Module Builder

Latest version **1.0.0** (published 2017-12-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install nuxt-module-builder
pnpm add nuxt-module-builder
yarn add nuxt-module-builder
bun add nuxt-module-builder
```

Provides the command `nuxt-module`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-12-29 |
| First published | 2017-08-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 28 |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | alexchopin, atinux, pi0 |

## Links

- npm: https://www.npmjs.com/package/nuxt-module-builder
- Homepage: https://github.com/nuxt/module-builder
- npm.io page: https://npm.io/package/nuxt-module-builder

## Dependencies (28)

- [jest](https://npm.io/package/jest.md) ^22.0.4
- [nuxt](https://npm.io/package/nuxt.md) next
- [debug](https://npm.io/package/debug.md) ^3.1.0
- [jsdom](https://npm.io/package/jsdom.md) ^11.2.0
- [eslint](https://npm.io/package/eslint.md) ^4.14.0
- [rollup](https://npm.io/package/rollup.md) ^0.53.1
- [codecov](https://npm.io/package/codecov.md) ^3.0.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^5.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [standard-version](https://npm.io/package/standard-version.md) ^4.2.0
- [eslint-plugin-vue](https://npm.io/package/eslint-plugin-vue.md) ^2.1.0
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^21.5.0
- [eslint-plugin-node](https://npm.io/package/eslint-plugin-node.md) ^5.2.1
- [rollup-plugin-copy](https://npm.io/package/rollup-plugin-copy.md) ^0.2.3
- [babel-preset-es2015](https://npm.io/package/babel-preset-es2015.md) ^6.24.1
- [rollup-plugin-alias](https://npm.io/package/rollup-plugin-alias.md) ^1.4.0
- [rollup-plugin-babel](https://npm.io/package/rollup-plugin-babel.md) ^3.0.3
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.8.0
- [babel-plugin-istanbul](https://npm.io/package/babel-plugin-istanbul.md) ^4.1.5
- [eslint-plugin-promise](https://npm.io/package/eslint-plugin-promise.md) ^3.6.0
- [eslint-config-standard](https://npm.io/package/eslint-config-standard.md) ^11.0.0-beta.0
- [eslint-plugin-standard](https://npm.io/package/eslint-plugin-standard.md) ^3.0.1
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.5
- [rollup-plugin-commonjs](https://npm.io/package/rollup-plugin-commonjs.md) ^8.2.6
- [rollup-plugin-filesize](https://npm.io/package/rollup-plugin-filesize.md) ^1.5.0
- [rollup-plugin-node-resolve](https://npm.io/package/rollup-plugin-node-resolve.md) ^3.0.0
- [babel-plugin-array-includes](https://npm.io/package/babel-plugin-array-includes.md) ^2.0.3
- [rollup-plugin-node-builtins](https://npm.io/package/rollup-plugin-node-builtins.md) ^2.1.2

## Recent versions

- 1.0.0 (latest) — 2017-12-29
- 0.0.2 — 2017-08-28
- 0.0.1 — 2017-08-16
- 0.0.0 — 2017-08-16

## README

# Nuxt Module Builder
[![npm (scoped with tag)](https://img.shields.io/npm/v/nuxt-module-builder/latest.svg?style=flat-square)](https://npmjs.com/package/nuxt-module-builder)
[![npm](https://img.shields.io/npm/dt/nuxt-module-builder.svg?style=flat-square)](https://npmjs.com/package/nuxt-module-builder)
[![Dependencies](https://david-dm.org/nuxt/module-builder/status.svg?style=flat-square)](https://david-dm.org/nuxt/module-builder)
   

> 🏗️ Nuxt Standard Module Builder

### ⚠️ This package is still under development

## Features
- Build modules using same tool-chain of nuxt
- ES6 Support out of the box
- Nuxt inspired build system using optional single `nuxt.module.config.js` file
- Standard eslint rules

### Using module starter template
Just head to [nuxt-community/module-template](https://github.com/nuxt-community/module-template)
to make your fresh module in few minutes.

## Getting started

Edit **package.json** like this:

```json
{
    "scripts": {
        "build": "nuxt-module"
    },
    "devDependencies": {
        "nuxt-module-builder": "latest"
    }
}
```

Create **src/index.js** file:

```js
export default async function (moduleOptions) {
    // ...
}
```

Optionally add a `moduleBuilder` section in **package.json** 
or create **nuxt.module.config.js** in the root of module project to customize module builder:

```js
module.exports = {
    meta: {
        name: 'myModule'
    },
    plugins: [
        // rollup plugins
    ]
}
```

You can now use `npm run nuxt-module` to generate `dist/index.js`


For watch mode, you can use `nuxt-module --watch`

## ESLint
TODO

## License

[MIT License](./LICENSE)

Copyright (c) 2017 Nuxt.js

---
_Source: https://npm.io/package/nuxt-module-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._