File: README.md

package info (click to toggle)
node-yarnpkg 4.1.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 24,752 kB
  • sloc: javascript: 38,953; ansic: 26,035; cpp: 7,247; sh: 2,829; makefile: 724; perl: 493
file content (24 lines) | stat: -rw-r--r-- 1,061 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# @yarnpkg/builder

A CLI tool designed for creating, building, and managing complex plugins.

> This version of the builder is for creating plugins for Yarn 3.x. Yarn 3 plugins are not compatible with Yarn 2 installations, however Yarn 2 plugins are usually compatible with Yarn 3. If you wish to create plugins for Yarn 2, please use v2.x of the builder (`yarn add @yarnpkg/builder@^2`).

## Features

- `builder new plugin` command for scaffolding new plugins
- `builder build plugin` command for building complex plugins
- supports TypeScript out-of-the-box
- uses ESBuild internally, providing treeshaking, minification, and various other optimizations out-of-the-box

## Installation

`yarn add -D @yarnpkg/builder`

## Commands

- [`builder new plugin`](https://yarnpkg.com/builder/cli/new/plugin) - Create a new plugin.

- [`builder build plugin`](https://yarnpkg.com/builder/cli/build/plugin) - Build a local plugin.

- [`builder build bundle`](https://yarnpkg.com/builder/cli/build/bundle) - Build a yarn.js bundle from our repository **(internal)**.