Convert the registry of your yarn.lock file.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig
.gitignore
.travis.yml
LICENSE
README.md
cli.js
index.js
package.json
test.js
test.js.md
test.js.snap
yarn.lock

README.md

convert-registry

This is a module to convert the registry of your yarn.lock file.

Why?

See Deprecating registry.yarnpkg.com.

Also, you can use this module in CI environment. For example, if you're a Chinese user, you may use 3rd-party npm registry mirror. However, the connection speed between CI and that mirror is very slow, so you can run this module before installing your dependencies to reduce installation time.

Usage

You can use this module as Node.js library or in CLI.

Node.js library

Basic Usage

Install it locally:

$ yarn add --dev convert-registry

Then, write a script like this:

const fs = require('fs')
const convertRegistry = require('convert-registry')

const lockfile = fs.readFileSync('./yarn.lock', 'utf-8')
convertRegistry(lockfile, 'https://registry.npmjs.org/')
  .then(newLockfile => fs.writeFileSync('./yarn.lock', newLockfile))

Full API

convertRegistry(content, registry = 'https://registry.npmjs.org/')
content

Type: string Required: true

This is the yarn.lock file content, not the path of yarn.lock file.

registry

Type: string Default: 'https://registry.npmjs.org/'

The registry URL you want to convert to, and if you omit this parameter, the default value is "https://registry.npmjs.org/".

Return Value

Type: Promise<string>

It returns a Promise because this module will do network requests. It is a Promise-wrapped string, so the string is the converted lockfile. That is, you should save it to file manually by some APIs like fs.writeFileSync.

CLI

Basic Usage

Install it globally:

$ yarn global add convert-registry

Use:

$ convert-registry https://registry.npmjs.org/

Full CLI Usage

This CLI program receives 1-2 arguments.

The first argument is the registry.

The second argument is the path of lock file. You can omit it, so it will use yarn.lock in the current working directory.

License

MIT Licensed

Copyright © 2018-present Pig Fang