@yarnpkg/lockfile

What is @yarnpkg/lockfile?

The @yarnpkg/lockfile npm package is designed for parsing and generating `yarn.lock` files. It allows developers to programmatically interact with the contents of these lock files, which are used by Yarn to lock down the versions of package dependencies for a project. This ensures consistent installations across different machines and environments.

What are @yarnpkg/lockfile's main functionalities?

Parse a yarn.lock file

This feature allows you to parse the contents of a `yarn.lock` file into a JSON object. This can be useful for analyzing or manipulating the dependencies of a project programmatically.

"const fs = require('fs');\nconst lockfile = require('@yarnpkg/lockfile');\n\nlet file = fs.readFileSync('yarn.lock', 'utf8');\nlet json = lockfile.parse(file);\nconsole.log(json);"

Generate a yarn.lock file content

This feature enables you to generate the content for a `yarn.lock` file from a JSON object. This could be useful for creating or updating a lock file programmatically after modifying project dependencies.

"const fs = require('fs');\nconst lockfile = require('@yarnpkg/lockfile');\n\nlet json = {\n  type: 'success',\n  object: {\n    'package-name@version': {\n      version: '1.0.0',\n      resolved: 'https://registry.yarnpkg.com/package-name/-/package-name-1.0.0.tgz',\n      integrity: 'sha512-...'\n    }\n  }\n};\n\nlet file = lockfile.stringify(json.object);\nfs.writeFileSync('yarn.lock', file);"

Other packages similar to @yarnpkg/lockfile

lockfile

The `lockfile` package provides basic locking of resources in Node.js but does not specifically handle `yarn.lock` or `package-lock.json` files. It's more general-purpose compared to @yarnpkg/lockfile, which is focused on Yarn's lock file format.

README

yarn-lockfile

Parse and/or write yarn.lock files

Usage Examples

const fs = require('fs');
const lockfile = require('@yarnpkg/lockfile');
// or (es6)
import fs from 'fs';
import * as lockfile from '@yarnpkg/lockfile';

let file = fs.readFileSync('yarn.lock', 'utf8');
let json = lockfile.parse(file);

console.log(json);

let fileAgain = lockfile.stringify(json);

console.log(fileAgain);