localpkg

Monorepo supports local packages.

Why use localpkg?

When using local packages in a monorepo, you might experience peer dependency problems because you use symbolic links.

But if you use localpkg, hard links the files declared in the files field in the package.json

In other words, it has the same effect as a package installed by the npm registry.

Installation

• local

> pnpm add @gron1gh1/localpkg -D # or yarn / npm
> pnpm localpkg -v

• global

> pnpm add -g @gron1gh1/localpkg # or yarn global add @gron1gh1/localpkg / npm install -g @gron1gh1/localpkg
> localpkg -v

package.json setting for local package

Specify files field to export out

• example

"name": "A"
...
"files": [
    "dist",
    "package.json"
],
...

package.json setting for app

After pnpm install or yarn install, synchronization must be performed through the localpkg command.
That is, it must be done immediately before build or development.

• example

"name": "bar"
...
"scripts": {
    "build": "localpkg && vite build",
    "dev": "localpkg && vite"
},
...

The dependency field must specify the package name and link keyword to use, and the path where the local package resides must be specified as the relative path.

• example

"name": "bar"
...
"dependencies": {
    "foo": "link:../../packages/foo",
},
...

If you followed the example above well, you can use it inside the bar package as follows:

// This code in "bar" package
import { sum } from "foo";