# @manpacker/generator

> Frontend generator build project

Latest version **1.10.0** (published 2021-02-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @manpacker/generator
pnpm add @manpacker/generator
yarn add @manpacker/generator
bun add @manpacker/generator
```

Provides the command `manpacker`.

## 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.10.0 |
| Published | 2021-02-07 |
| First published | 2019-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 32 |
| Unpacked size | 76.2 KB |
| Known vulnerabilities | 0 (+7 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | winterfete |
| Maintainers | winterfete |
| Keywords | webpack, manpacker, generator, build |

## Links

- npm: https://www.npmjs.com/package/@manpacker/generator
- Repository: https://github.com/manpackers/front-build
- Homepage: https://github.com/manpackers/front-build#readme
- Issues: https://github.com/manpackers/front-build/issues
- npm.io page: https://npm.io/package/@manpacker/generator

## Dependencies (32)

- [ora](https://npm.io/package/ora.md) ^5.3.0
- [less](https://npm.io/package/less.md) ^3.9.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.3
- [stylus](https://npm.io/package/stylus.md) ^0.54.5
- [webpack](https://npm.io/package/webpack.md) ^4.34.0
- [commander](https://npm.io/package/commander.md) ^2.20.0
- [node-sass](https://npm.io/package/node-sass.md) ^4.12.0
- [zip-local](https://npm.io/package/zip-local.md) ^0.3.4
- [css-loader](https://npm.io/package/css-loader.md) ^2.1.1
- [url-loader](https://npm.io/package/url-loader.md) ^1.1.2
- [file-loader](https://npm.io/package/file-loader.md) ^3.0.1
- [less-loader](https://npm.io/package/less-loader.md) ^4.1.0
- [postcss-url](https://npm.io/package/postcss-url.md) ^8.0.0
- [sass-loader](https://npm.io/package/sass-loader.md) ^7.1.0
- [babel-loader](https://npm.io/package/babel-loader.md) ^8.0.6
- [style-loader](https://npm.io/package/style-loader.md) ^0.23.1
- [eslint-loader](https://npm.io/package/eslint-loader.md) ^4.0.0
- [px2rem-loader](https://npm.io/package/px2rem-loader.md) ^0.1.9
- [stylus-loader](https://npm.io/package/stylus-loader.md) ^3.0.2
- [webpack-merge](https://npm.io/package/webpack-merge.md) ^4.2.1
- [postcss-import](https://npm.io/package/postcss-import.md) ^12.0.1
- [postcss-loader](https://npm.io/package/postcss-loader.md) ^3.0.0
- [postcss-preset-env](https://npm.io/package/postcss-preset-env.md) ^6.6.0
- [resolve-url-loader](https://npm.io/package/resolve-url-loader.md) ^3.1.0
- [webpack-dev-server](https://npm.io/package/webpack-dev-server.md) ^3.7.1
- [html-webpack-plugin](https://npm.io/package/html-webpack-plugin.md) ^4.5.1
- [style-resources-loader](https://npm.io/package/style-resources-loader.md) ^1.2.1
- [mini-css-extract-plugin](https://npm.io/package/mini-css-extract-plugin.md) ^0.11.3
- [stylelint-webpack-plugin](https://npm.io/package/stylelint-webpack-plugin.md) ^2.1.1
- [eslint-friendly-formatter](https://npm.io/package/eslint-friendly-formatter.md) ^4.0.1
- [optimize-css-assets-webpack-plugin](https://npm.io/package/optimize-css-assets-webpack-plugin.md) ^5.0.1

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 1.10.0 (latest) — 2021-02-07
- 1.9.0 — 2020-04-06
- 1.8.6 — 2019-06-27
- 1.8.5 — 2019-06-13
- 1.8.4 — 2019-06-06
- 1.8.3 — 2019-06-05
- 1.8.2 — 2019-06-05
- 1.8.1 — 2019-05-29
- 1.8.0 — 2019-05-19
- 1.7.3 — 2019-05-15
- 1.7.2 — 2019-05-15
- 1.7.1 — 2019-05-15
- 1.7.0 — 2019-05-15
- 1.6.1 — 2019-05-10
- 1.6.0 — 2019-05-10
- … 5 more at https://npm.io/package/@manpacker/generator/versions

## README

![npm](https://img.shields.io/npm/v/@manpacker/generator.svg)
![npm bundle size](https://img.shields.io/bundlephobia/min/@manpacker/generator.svg)
![npm](https://img.shields.io/npm/dw/@manpacker/generator.svg)
![NPM](https://img.shields.io/npm/l/@manpacker/generator.svg)
<br><br>
![nodei.co](https://nodei.co/npm/@manpacker/generator.png?downloads=true&downloadRank=true&stars=true)
<br>
# Explain
Manpacker is a set of build engine based on [webpack](https://www.webpackjs.com/) to build engine package.<br>
Entry file supported file extension <code>js</code> or <code>ts</code><br>
Support for multi-portal file build, Files must be in the build <code>root</code> directory.<br>
## .manpackeric
Project default initialization file, Can be a <code>javascript</code> script file, or a <code>json</code> configuration file.<br>
Example: json<br>
```
{"output": "view"}
```
You can also set the <code>manpacker</code> field in the <code>package.json</code> file.<br>
Example:<br>
```
{"manpacker": {"root": "src"}}
```
Final input result, Merge <code>.manpackeric</code> config item.
```
{"root": "src", "output": "view"}
```
You can customize the project initialization file name.<br>
Example:<br>
Custom name: development.ic.js
```
npx manpacker --ci development.ic.js
```
```
manpacker --ci development.ic.js
```
# Install
```
npm i @manpacker/generator -D
```
# Usage
## CLI
Start the local development environment.
```
manpacker server
```
```
manpacker server --ic [value] -c [config] --port [number]
```
Construction of production environment engineering project.
```
manpacker build
```
```
manpacker build --ic [value] -c [config]
```
## API
```
const manpacker = require('@manpacker/generator')
```
### method
#### .compile
Core compilation method
```
const { compile } = require('@manpacker/generator')
compile({ env, ic, config })
```

|param|type|explain|
|-----|----|-------|
|env|string|<code>env: NDOE_ENV variabl</code>|
|ic|object|<code>[.manpackeric](#.manpackeric)</code> config item object|
|config|function|<code>[manpacker.webpack.js](#manpacker.webpack.js)</code> return funtion|

#### .Commander
Commander is Create command-line class.
```
const { Commander } = require('@manpacker/generator')

let { version } = require('./package.json')
let commander = new Commander({ version })

```
Explain commander methods

|method|explain|
|------|-------|
|build|Default build production environment, enter project directory|
|server|Launch Development Environment, Local Interconnect Service, default Port 8090|
|parse|Compile registration command Lint|
#### .createCssLoader
Create css loader generator.
```
const { createCssLoader } = require('@manpacker/generator')
```
|param|type|explain|
|-----|----|-------|
|ic|object|code>.manpackeric</code> config item object|
|...loader|[object,string]|style loader|

Example:
```
createCssLoader(ic, { loader: 'resolve-url-loader' }, { loader: 'sass-loader' })
```
```
createCssLoader(ic, 'resolve-url-loader', 'sass-loader')
```
#### .createURILoader
Create URI file loader generator.

|param|teype|explain|
|-----|-----|-------|
|dir|string|create new dir for URI file.|

#### .createEslintLoader
Create Eslint loader generator.

|param|teype|explain|
|-----|-----|-------|
|rgx|RegExp|Create eslint loader.|

## .manpackeric
Default root file name: <code>.manpackeric</code><br>
Configuration item description:<br>

|name|type|value|description|
|----|----|-----|-----------|
|root|string|default: src| Source directory for building the project|
|output|string|default: view|Directory output after build|
|ext|string|default:htm|Extension of the outputted page|
|cdn|string|default: "/"|Domain name for static Resource, "publicPath" attribute value|
|define|object|dedalut: {NODE_ENV: process.env.NODE_ENV}|Define constants in a project, <code>eslintrc</code> set global key-value|
|pages|object|default: {}|Multi-portal file page configuration [Example](#pages)|
|remUnit|number|default: 100|Conversion of <code>px</code> with <code>750px</code> Design Diagram, Minimum cardinality.|
|isPx2rem|boolean|default:true|Pixel unit <code>px</code> conversion <code>rem</code>|
|injectStyle|array|default:[]|Global style files that need to be injected, Avoid repeating reference, [Example](#injectStyle)|
|isCssExtract|boolean|default: fasle|Extract css separate files|
|isMergeCommon|boolean|default:false|When multiple portal files are used, the common code section is extracted|
|minChunks|number|default: 2|If <code>isMergeCommon:true</code>, Extracts the minimum entry file number of files for the public code.|
|isCssModule|boolean|default:false|Whether styles are introduced as css templates, [Example](#isCssModule)|
|isMiniHTML|boolean|default:true|Compressed page.|
|template|string|default:'template.html'|Build-time template file.|
|map|string|default: ' '|Source map file URI|
|isEslint|boolean|default: true|Start the eslint-loader feature by default|
|isZip|boolean|default: false|Compressed project are zip’s ext. |
|proxy|object|default: {}|Resolve browser request interface joint cross-domain. |

### .pages
Ingress File header Settin.
Example:
Entry files <code>index.js</code>
```
{"page": {"index": "Test title"}}
```
More entry files <code>index.ts</code>、<code>list.ts</code>, and so on.
```
{"pages": {"index": "Test title", "list": "List test title"}}
```

### .injectStyle
Inject global style file, Avoid manual introduction<br>
Example:
```
{"injectStyle": ["./common/style/mixins.scss", "./common/style/varable.scss"]}
```
```
{"injectStyle": ["./common/style/index.scss"]}
```
### .isCssModule
Introduction of css style to work with Modular approach.<br>
Example: <br>
index.scss
```
.frame {margin: auto;}
```
index.jsx
```
import Style from './index.scss'

<div class={Style.frame}></div>
```
### .proxy

```
{
  '/api': {
    'target': 'https://maindomain.com',
    'changeOrigin': true,
    'secure': true,
    'pathRewrite': {
      '^/api': ''
    },
    'logLevel': 'debug'
  }
}
```
```
API: http://localhost:8090/api/home => https://maindomain.com/home
```

## postcss.config.js
Specific reference: [postcss](https://www.npmjs.com/package/postcss)

This generator includes plugins: <code>postcss-preset-env</code> <code>postcss-import</code> <code>postcss-url</code> <code>cssnano</code><br>
Extend the postcss plug-in the root directory: create file <code>postcss.config.js</code>

## manpacker.webpack.js
Default root file name: <code>manpacker.webpack.js</code>
```
module.exports = ic => {
  // webpack config item.
  return {}
}
```
The parameter <code>ic</code> is the injected initialization parameter object.<br>
Webpack configuration items can be set based on <code>ic</code>
## Npm
[link](https://www.npmjs.com/package/@manpacker/generator)

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