https://github.com/teambit/relsym

Converts absolute symlinks to relative ones
https://github.com/teambit/relsym

Last synced: about 1 year ago
JSON representation

Converts absolute symlinks to relative ones

• Host: GitHub
• URL: https://github.com/teambit/relsym
• Owner: teambit
• License: other
• Created: 2018-11-01T13:48:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-02-11T12:31:29.000Z (over 4 years ago)
• Last Synced: 2025-04-03T18:41:58.383Z (about 1 year ago)
• Language: JavaScript
• Size: 203 KB
• Stars: 10
• Watchers: 5
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![CircleCI](https://circleci.com/gh/teambit/relsym/tree/master.svg?style=svg)](https://circleci.com/gh/teambit/relsym/tree/master)

# relsym

A small utility that converts absolute symlinks to relative ones. Similar to [symlinks](https://github.com/brandt/symlinks) but in node.js.

### install

`npm install relsym` / 

`yarn add relsym`

### usage

Accepts either a folder or a symlink. If it receives a folder, it recursively converts all symlinks inside it.

```javascript

const relsym = require('relsym')

relsym('/path/to/my/folder')

// tada!

```

### use with care

This utility mutates the folder or file it is given. If you find a bug, please report it - or better yet, contribute a fix!

### contributing

Yes please!

### license

Apache License, Version 2.0