# @growing-web-examples/wpm

> A package manager tool based on importmap

Latest version **0.0.2** (published 2022-03-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @growing-web-examples/wpm
pnpm add @growing-web-examples/wpm
yarn add @growing-web-examples/wpm
bun add @growing-web-examples/wpm
```

Provides the command `wpm`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-03-17 |
| First published | 2022-03-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 7 |
| Unpacked size | 12.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | aui |
| Maintainers | vvben, aui |

## Links

- npm: https://www.npmjs.com/package/@growing-web-examples/wpm
- npm.io page: https://npm.io/package/@growing-web-examples/wpm

## Dependencies (7)

- [semver](https://npm.io/package/semver.md) ^7.3.5
- [commander](https://npm.io/package/commander.md) ^9.0.0
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.2
- [@jspm/generator](https://npm.io/package/@jspm/generator.md) ^1.0.0-beta.29
- [single-line-log](https://npm.io/package/single-line-log.md) ^1.1.2
- [json-schema-ref-parser](https://npm.io/package/json-schema-ref-parser.md) ^9.0.9
- [@growing-web/dancf-provider](https://npm.io/package/@growing-web/dancf-provider.md) 0.0.1

## Recent versions

- 0.0.2 (latest) — 2022-03-17
- 0.0.1 — 2022-03-17

## README

# wpm

这是一个基于 importmap 的包管理工具。

## 安装

```bash
npm install -g @growing-web-examples/wpm
```

## 指南

### 配置文件

`web-module.json` 将作为 wpm 的配置文件。

```json
{
  "defaultProvider": "dancf",
  "providers": {},
  "env": ["production", "browser", "module"],
  "dependencies": {
    "react": "^17.0.2"
  }
}
```

### 安装模块

```bash
wpm install
```

运行命令后，它将会生成 `importmap.json` 文件，它是 [导入映射](https://github.com/WICG/import-maps) 的标准格式，你可以用它管理模块。

```json
{
  "imports": {
    "react": "https://es.dancf.com/npm:react@17.0.2/index.js"
  },
  "scopes": {
    "https://es.dancf.com/": {
      "object-assign": "https://es.dancf.com/npm:object-assign@4.1.1/index.js"
    }
  }
}
```

### 与本地依赖保持一致

```json
{
  "defaultProvider": "dancf",
  "providers": {},
  "env": ["production", "browser", "module"],
  "dependencies": {
    "$ref": "./package.json#/dependencies"
  }
}
```

`web-module.json` 支持使用 [`$ref`](https://json-schema.org/understanding-json-schema/structuring.html#id18) 语法，它可以引入外部定义的 JSON 内容。

### 合并多个依赖表

```json
{
  "defaultProvider": "dancf",
  "providers": {},
  "env": ["production", "browser", "module"],
  "dependencies": [{
    "$ref": "./package.json#/dependencies"
  }, {
    "react": "^17.0.2"
  }]
}
```

内部将使用 `Object.assign(...dependencies)` 进行合并，因此右边的优先级高于左边。

### 工作空间模块

```json
{
  "defaultProvider": "dancf",
  "providers": {},
  "env": ["production", "browser", "module"],
  "dependencies": {
    "test": "workspace:*"
  }
}
```

`workspace:*` 协议可以根据工作空间内的本地包来确定版本号，也就是说 wpm 安装的时候会最终读取工作空间对应的包的版本号来工作。

### 固定远程模块

```json
{
  "defaultProvider": "dancf",
  "providers": {},
  "env": ["production", "browser", "module"],
  "dependencies": {
    "vue": "https://cdn.com/vue.js"
  }
}
```

wpm 会忽略 `https:` 定义的远程模块，它不会去解析它。

### 切换 CDN

`defaultProvider` 可以指定默认的模块提供者，你可以在公共 CDN 或者 `nodemodules` 切换，默认值是 `jspm`。

### 本地调试

通常情况下将使用 CDN 而不是 `nodemodules` 来管理模块，如果需要单独调试某个包，可以将其映射到本地来。

首先，创建 `web-module.dev.json` 文件，并且设置环境变量 `NODE_ENV` 为 `development`。


将所有模块映射到本地：

```json
{
  "defaultProvider": "nodemodules",
  "providers": {},
  "env": ["production", "browser", "module"],
  "dependencies": [{
    "$ref": "./package.json#/dependencies"
  }, {
    "react": "^17.0.2"
  }]
}
```

只映射特定的模块：

```json
{
  "defaultProvider": "dancf",
  "providers": {
    "react": "nodemodules"
  },
  "env": ["production", "browser", "module"],
  "dependencies": [{
    "$ref": "./package.json#/dependencies"
  }, {
    "react": "^17.0.2"
  }]
}
```

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