https://github.com/ejnshtein/resolve-symlinks

Resolve issues with locally installed packages
https://github.com/ejnshtein/resolve-symlinks

cli development nodejs npm yarn

Last synced: 17 days ago
JSON representation

Resolve issues with locally installed packages

• Host: GitHub
• URL: https://github.com/ejnshtein/resolve-symlinks
• Owner: ejnshtein
• License: mit
• Created: 2022-06-20T13:05:48.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-06-20T21:22:04.000Z (over 2 years ago)
• Last Synced: 2024-10-07T16:21:06.443Z (about 1 month ago)
• Topics: cli, development, nodejs, npm, yarn
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/resolve-symlinks
• Size: 321 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# resolve-symlinks

## Usage

```bash

npx resolve-symlinks

```

## Why this exists

When you install package using npm/yarn locally (`npm i ./path/to/package`) it actually links your package to **.config/yarn/link/\** first, and only then to your **node_modules** folder.

So, if you have 2 folders with locally installed packages with the same name in **package.json**, the first package you install will be linked to global directory, second one will use link from first package.

The following diagram might help understanding the situation:

![](./assets/resolve-symlinks-diagram.png)

Because of that your dev-servers might not work as expected (reload on safe) since your are saving files in one project, while the package is actually linked to other directory.

## How it works

The whole source code is about 200 lines of code, when it runs it does the following things:  

1. Checks if **package.json** even exists. Exits if it does not.

2. Loads data from **package.json**. Checks if **dependencies** field exists and is of type **object**. Exits if it is not.

3. Checks if **node_modules** exists. If they do not exist, runs a prompt to install dependencies using `npm i` command. (can be changed later)

4. Filters dependencies to process only locally installed ones.

5. Checks if packages exists. If they do not, exits.

6. Checks if packages exists in **node_modules** folder. If they do not, exits.

7. Loads real paths of locally installed dependencies.

8. Filters dependencies to process only those which are installed from incorrect path. Aka, the whole idea of this package.

9. If there are any, logs them in the console and prompts to fix them.  

If you want to fix them, this package will do the following:  

1. Unlink package from **./config/yarn/link/\**.  

2. Unlink package from **node_modules**.  

3. Link package into **./config/yarn/link/\**  

4. Link global package into **node_modules/\**  

If not, will end the process.

That is it.