https://github.com/linkorb/symlinker
symlinker: develop packages locally through symlinks (composer, npm, ansible-galaxy)
https://github.com/linkorb/symlinker
Last synced: about 2 months ago
JSON representation
symlinker: develop packages locally through symlinks (composer, npm, ansible-galaxy)
- Host: GitHub
- URL: https://github.com/linkorb/symlinker
- Owner: linkorb
- License: mit
- Created: 2023-07-30T10:51:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-03T02:50:12.000Z (6 months ago)
- Last Synced: 2025-02-11T15:43:02.637Z (4 months ago)
- Language: PHP
- Homepage: https://engineering.linkorb.com
- Size: 123 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
symlinker
============
Creates or updates symlinks from a config file
## Use-cases:
* Develop packages locally (composer, npm, ansible-galaxy)
## Installation:
```sh
$ git clone [email protected]:linkorb/symlinker.git
$ cd symlinker
$ composer install
```
Then update your `PATH` environment to include the `bin/` directory of the symlinker repository.
## Usage:
Create a file called `symlinker.yaml` in the root of your project, for example:
```yaml
links:
- "~/git/my-composer-package:./vendor/my-org/my-composer-package" # PHP / Composer
- "~/git/my-node-package:./node_modules/my-node-package" # Node / NPM
- "~/git/ansible-role-example:./roles/example" # Ansible / Galaxy
- "~/my-content:./my-content" # ... or any other arbitrary symlink
```
Your `symlinker.yaml` file is specific for your development environment, so be sure to add it to your `~/.gitignore` (in your home-dir, not `./.gitignore` in the repo!)
Then you can quickly (re)install the symlinks:
```sh
$ symlinker link
```
## How does it work?
symlinker loops over your configured "links". for every link it:
1. checks if the "from" directory or file exists
2. checks if the "to" symlink already exists at the target. if so, it removes it.
3. checks if "to" is a directory or file. if so, it archives the existing data to `/tmp/symlinker/archive/` + full path + date + time
4. sets up the symlink from "from" to "to".
So if you've accidentally replaced a directory with valuable files with a symlink, you can always recover it from the archive directory.
## Contributing
We welcome contributions to make this repository even better. Whether it's fixing a bug, adding a feature, or improving documentation, your help is highly appreciated. To get started, fork this repository then clone your fork.
Be sure to familiarize yourself with LinkORB's [Contribution Guidelines](/CONTRIBUTING.md) for our standards around commits, branches, and pull requests, as well as our [code of conduct](/.github/CODE_OF_CONDUCT.md) before submitting any changes.
If you are unable to implement changes you like yourself, don't hesitate to open a new issue report so that we or others may take care of it.
## Brought to you by the LinkORB Engineering team
Check out our other projects at [linkorb.com/engineering](http://www.linkorb.com/engineering).
By the way, we're hiring!