https://github.com/jantimon/yarn-plugin-leaf

Yarn plugin experiment
https://github.com/jantimon/yarn-plugin-leaf

Last synced: 28 days ago
JSON representation

Yarn plugin experiment

• Host: GitHub
• URL: https://github.com/jantimon/yarn-plugin-leaf
• Owner: jantimon
• License: mit
• Created: 2022-05-04T15:03:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-19T20:17:44.000Z (over 2 years ago)
• Last Synced: 2024-04-15T01:09:31.890Z (7 months ago)
• Language: TypeScript
• Size: 890 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yarn-plugin-leaf

Yarn has a powerful workspace feature which installs all workspace modules together.

The `yarn-plugin-leaf` plugin adds `leaf` modules. Leaf modules are standalone

modules with a standalone package.json and yarn.lock file.

In contrast to workspace modules leaf modules and all of their dependencies are only 

installed on demand.

## Installation

```shell

yarn plugin import https://raw.githubusercontent.com/jantimon/yarn-plugin-leaf/main/bundles/%40yarnpkg/plugin-leaf.js

```

## Example

```json

{

  "name": "my project",

  "leafModules": [

    "local-modules/*"

  ]

}

```

## Usage

Activate a leaf module and install all it's dependencies:

```

  yarn leaf activate my-special-package

```

Disable a leaf module and uninstall all it's dependencies:

```

  yarn leaf disable my-special-package

```

Updates of all active leaf modules will run automatically

during your normal yarn install run

```

  yarn

```

Update the `yarn leaf` module:

```

  yarn plugin import https://raw.githubusercontent.com/jantimon/yarn-plugin-leaf/main/bundles/%40yarnpkg/plugin-leaf.js

```