Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rohit-gohri/yarn-lock-to-package-json
Create package.jsons from yarn.lock for docker caching
https://github.com/rohit-gohri/yarn-lock-to-package-json
berry docker pnpm-fetch yarn
Last synced: 3 months ago
JSON representation
Create package.jsons from yarn.lock for docker caching
- Host: GitHub
- URL: https://github.com/rohit-gohri/yarn-lock-to-package-json
- Owner: rohit-gohri
- License: mit
- Created: 2022-12-03T13:48:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T08:16:39.000Z (10 months ago)
- Last Synced: 2024-04-25T08:20:45.991Z (10 months ago)
- Topics: berry, docker, pnpm-fetch, yarn
- Language: JavaScript
- Homepage:
- Size: 1.02 MB
- Stars: 14
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# yarn-lock-to-package-json
[](https://www.npmjs.com/package/yarn-lock-to-package-json)
A simple script to be used in Dockerfile to do yarn install without copying all `package.json`s in a monorepo workspace. Use case inspired by [pnpm's fetch command](https://pnpm.io/cli/fetch) but for Yarn Berry.
## Usage in Dockerfile
```Dockerfile
# ------------------------------------------------------------------------------
# First image (install dependencies)
# ------------------------------------------------------------------------------
FROM node:16-alpine as yarn
LABEL stage=yarn
WORKDIR /workspace
COPY .yarn ./.yarn
COPY yarn.lock .yarnrc.yml ./
RUN yarn dlx yarn-lock-to-package-json
RUN yarn install --immutable
# ------------------------------------------------------------------------------
# Server image (build image with production dependencies only)
# ------------------------------------------------------------------------------
FROM yarn as server
LABEL stage=server
WORKDIR /workspace
# Overwrite dummy package.json with actual ones (so that we can use scripts)
COPY package.json ./
COPY packages ./packages
COPY apps/server ./apps/server
RUN yarn workspaces foreach -tR --from @workspace-name/server run build
RUN cd apps/server && yarn workspaces focus --production
CMD ["yarn", "workspace", "@workspace-name/server", "start"]
```
## Yarn Plugin
For similar functionality but packaged in a yarn plugin you can check out [yarn-plugin-fetch](https://github.com/devthejo/yarn-plugin-fetch) by [@devthejo](https://github.com/devthejo), it uses this package internally to provide the same feature plus adds workspace focus support and more tools.
## Working
What it does is parse the lockfile and recreate the monorepo structure by creating dummy `package.json` for each package in the workspace. These dummy package.json don't invalidate your docker cache when you change a script or increment a version and so your docker build cache remains valid up to the layer of `RUN yarn install --immutable`.
Test it by copying your `yarn.lock` to a new folder and run `npx yarn-lock-to-package-json`.
This is the dummy file generated:
```md
{
"name": "@monorepo/package",
"version": "0.0.0",
"description": "**DON'T COMMIT** Generated file for caching",
"private": true,
"dependencies": {
"typescript": "^4.5.5"
}
}
```
### Motivation
These existing issues in yarn
- [Install without package.json](https://github.com/yarnpkg/yarn/issues/4813)
- [Fetch dependencies from yarn.lock only](https://github.com/yarnpkg/berry/issues/4529)
- [A command to just download and cache dependencies from lockfile](https://github.com/yarnpkg/berry/discussions/4380)