# @dev-pack/dev-pack

> dev-pack is a super-fast local development module bundler, server with hot module replacement

Latest version **1.9.0** (published 2019-08-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dev-pack/dev-pack
pnpm add @dev-pack/dev-pack
yarn add @dev-pack/dev-pack
bun add @dev-pack/dev-pack
```

Provides the command `dev-pack`.

## 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.9.0 |
| Published | 2019-08-26 |
| First published | 2019-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 22 |
| Unpacked size | 29.5 KB |
| Known vulnerabilities | 0 (+5 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Víctor García |
| Maintainers | gc-victor |
| Keywords | dev-pack, devlopment, module, bundler, hmr |

## Links

- npm: https://www.npmjs.com/package/@dev-pack/dev-pack
- Repository: https://github.com/gc-victor/dev-pack
- Homepage: https://github.com/gc-victor/dev-pack#readme
- Issues: https://github.com/gc-victor/dev-pack/issues
- npm.io page: https://npm.io/package/@dev-pack/dev-pack

## Dependencies (22)

- [ws](https://npm.io/package/ws.md) 7.1.2
- [mime](https://npm.io/package/mime.md) 2.4.4
- [sade](https://npm.io/package/sade.md) 1.6.1
- [husky](https://npm.io/package/husky.md) 3.0.4
- [dotenv](https://npm.io/package/dotenv.md) 8.1.0
- [eslint](https://npm.io/package/eslint.md) 6.2.2
- [resolve](https://npm.io/package/resolve.md) 1.12.0
- [sucrase](https://npm.io/package/sucrase.md) 3.10.1
- [chokidar](https://npm.io/package/chokidar.md) 3.0.2
- [prettier](https://npm.io/package/prettier.md) 1.18.2
- [memory-fs](https://npm.io/package/memory-fs.md) 0.4.1
- [http-proxy](https://npm.io/package/http-proxy.md) 1.17.0
- [@types/node](https://npm.io/package/@types/node.md) 12.7.2
- [lint-staged](https://npm.io/package/lint-staged.md) 9.2.4
- [query-string](https://npm.io/package/query-string.md) 6.8.2
- [@babel/parser](https://npm.io/package/@babel/parser.md) 7.5.5
- [source-map-url](https://npm.io/package/source-map-url.md) 0.4.0
- [@babel/traverse](https://npm.io/package/@babel/traverse.md) 7.5.5
- [source-list-map](https://npm.io/package/source-list-map.md) 2.0.1
- [eslint-plugin-node](https://npm.io/package/eslint-plugin-node.md) 9.1.0
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) 6.1.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) 3.1.0

## 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.9.0 (latest) — 2019-08-26
- 1.8.0 — 2019-08-26
- 1.7.0 — 2019-03-05
- 1.6.0 — 2019-03-05
- 1.5.0 — 2019-03-04
- 1.4.0 — 2019-03-04
- 1.3.0 — 2019-03-04
- 1.2.0 — 2019-02-26
- 1.1.0 — 2019-02-26
- 1.0.0 — 2019-02-26

## README

# dev-pack

Super-fast local development module bundler, server with hot module replacement.

⚠️ **IMPORTANT**: Don't use it in production!

## Install

Isn't needed to be installed. Please, read below the "How to use" section.

`npm install --save-dev @dev-pack/dev-pack`

`yarn add --dev @dev-pack/dev-pack`

## How to use

You have to run the command `npx @dev-pack/dev-pack start`, and use the options that you need, to have a really fast dev server with hmr running.

Optionally you can use a config file, by default called **.devpackrc.json**.

dev-pack will look in the load at the input folder for a index.html, a styles.css (not-required), and index.js/ts/tsx.

When watch is set to true, it's default value, it will listen for changes to styles.css and any *.js file in the input folder.

### Using devpackrc.json

```
{
  "externals": ["unfetch"],
  "globals": {
    "react": {
      "cdn": "https://unpkg.com/react@16/umd/react.development.js",
      "window": "React"
    },
    "react-dom":  {
      "cdn": "https://unpkg.com/react-dom@16/umd/react-dom.development.js",
      "window": "ReactDOM"
    }
  },
  "html": "public/index.html",
  "input": "src",
  "js": "src/index.tsx",
  "proxy": "http://localhost:8080"
}
```

### Using CLI

`-c, --config`

Configuration file.

Default: .devpackrc.json

`-w, --watch`

Comma-separate list of directories and/or files to watch

Default: true

`-s, --socket`

Specify a WebSocket port.

Default: 1235

`-e, --external`

Comma-separate, without spaces, list of module IDs to include. Example: react,react-dom
 
Default: none.

`-x, --exclude`

Comma-separate list of directories to exclude. 

Default: node_modules

`-i, --input`

Entry folder.

Default: example

`-h, --html`

Entry html file.

Default: src/index.html

`-j, --js`

Entry JS or TS file.

Default: src/index.js

`-y, --css`

Entry CSS file.

Default: src/styles.css

`-g, --globals`

Global variables. `'{"moduleID": {"window": "GlobalVariable", "cdn": "https://cdn.com"}}'`

Default: none

`-p, --port`

Specify a port.

Default: 1234

`-x, --proxy`

Specify a proxy.

Default: none

## Run cli example

`node src/cli.js start -i example -j example/index.js`

## Compatible Versioning

### Summary

Given a version number MAJOR.MINOR, increment the:

- MAJOR version when you make backwards-incompatible updates of any kind
- MINOR version when you make 100% backwards-compatible updates

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR format.

[![ComVer](https://img.shields.io/badge/ComVer-compliant-brightgreen.svg)](https://github.com/staltz/comver)

## Contribute

First off, thanks for taking the time to contribute!
Now, take a moment to be sure your contributions make sense to everyone else.

### Reporting Issues

Found a problem? Want a new feature? First of all, see if your issue or idea has [already been reported](../../issues).
If it hasn't, just open a [new clear and descriptive issue](../../issues/new).

### Commit message conventions

We are following *AngularJS Git Commit Message Conventions*. This leads to more readable messages that are easy to follow when looking through the project history.

- [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w)
- [Commit Message Guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit)

### Submitting pull requests

Pull requests are the greatest contributions, so be sure they are focused in scope and do avoid unrelated commits.

-   Fork it!
-   Clone your fork: `git clone http://git.trivago.trv/<your-username>/react-form-core`
-   Navigate to the newly cloned directory: `cd react-form-core`
-   Create a new branch for the new feature: `git checkout -b my-new-feature`
-   Install the tools necessary for development: `npm install`
-   Make your changes.
-   `npm run build` to verify your change doesn't increase output size.
-   `npm test` to make sure your change doesn't break anything.
-   Commit your changes: `git commit -am 'Add some feature'`
-   Push to the branch: `git push origin my-new-feature`
-   Submit a pull request with full remarks documenting your changes.

## License

[MIT License](https://github.com/gc-victor/dev-pack/blob/master/LICENSE.md)

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