https://github.com/mixmaxhq/deyarn

A command-line tool for converting projects that use Yarn to npm.
https://github.com/mixmaxhq/deyarn

unsupported

Last synced: about 2 months ago
JSON representation

A command-line tool for converting projects that use Yarn to npm.

• Host: GitHub
• URL: https://github.com/mixmaxhq/deyarn
• Owner: mixmaxhq
• Created: 2018-05-03T19:03:43.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-08-09T21:49:14.000Z (about 1 year ago)
• Last Synced: 2024-07-08T19:59:06.961Z (3 months ago)
• Topics: unsupported
• Language: JavaScript
• Size: 66.4 KB
• Stars: 261
• Watchers: 8
• Forks: 12
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# `deyarn`

A command-line tool for converting projects that use `yarn` to `npm`.

The follow-up to [`npm2yarn`](https://github.com/mixmaxhq/npm2yarn). See https://mixmax.com/blog/to-yarn-and-back-again-npm for motivation.

## Procedure

`deyarn`:

1. Removes `yarn.lock` if it exists

2. Removes `node_modules` to avoid any installation conflicts

3. Installs your project dependencies using `npm`, generating a `package-lock.json` file

4. Logs a list of manual steps to be taken to complete the transition

This conversion will likely involve the upgrading of some/many of your transitive dependencies, so make sure to test thoroughly! :)

## Quick Start

You can use deyarn via [npx](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner) to quickly convert a project without needing to install deyarn first. Just run the following command in your project directory:

```sh

npx deyarn

```

_Note: The directory must be a Git repository._

## Alternative Usage

Alternatively you can install deyarn globally (see below) and then run `$ deyarn` in your project directory instead.

## Installation

```sh

npm install -g deyarn

```

or

```sh

yarn global add deyarn

```

## Contributing

We welcome your pull requests! Please lint your code.

## Changelog

* 1.0.0 Add initial code