Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gruntjs/grunt-contrib-symlink
Create symbolic links.
https://github.com/gruntjs/grunt-contrib-symlink
Last synced: 7 days ago
JSON representation
Create symbolic links.
- Host: GitHub
- URL: https://github.com/gruntjs/grunt-contrib-symlink
- Owner: gruntjs
- License: mit
- Created: 2013-07-26T19:18:15.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2021-03-22T15:02:24.000Z (almost 4 years ago)
- Last Synced: 2024-12-26T06:07:44.976Z (14 days ago)
- Language: JavaScript
- Size: 27.3 KB
- Stars: 56
- Watchers: 6
- Forks: 20
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-contrib-symlink v1.0.0 [](https://travis-ci.org/gruntjs/grunt-contrib-symlink) [](https://ci.appveyor.com/project/gruntjs/grunt-contrib-symlink/branch/master)
> Create symbolic links.
## Getting Started
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-contrib-symlink --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-contrib-symlink');
```
## Symlink task
_Run this task with the `grunt symlink` command._
Task targets, files and options may be specified according to the grunt [Configuring tasks](http://gruntjs.com/configuring-tasks) guide. Pay special attention to the [Building the files object dynamically](http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically) section, which explains how to create many src-dest file mappings all at once.
Note that the symlink mode (file, dir) is determined automatically based on the src file type.
### Usage Examples
```js
symlink: {
options: {
// Enable overwrite to delete symlinks before recreating them
overwrite: false,
// Enable force to overwrite symlinks outside the current working directory
force: false
},
// The "build/target.txt" symlink will be created and linked to
// "source/target.txt". It should appear like this in a file listing:
// build/target.txt -> ../source/target.txt
explicit: {
src: 'source/target.txt',
dest: 'build/target.txt'
},
// These examples using "expand" to generate src-dest file mappings:
// http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
expanded: {
files: [
// All child files and directories in "source", starting with "foo-" will
// be symlinked into the "build" directory, with the leading "source"
// stripped off.
{
expand: true,
overwrite: false,
cwd: 'source',
src: ['foo-*'],
dest: 'build'
},
// All child directories in "source" will be symlinked into the "build"
// directory, with the leading "source" stripped off.
{
expand: true,
overwrite: false,
cwd: 'source',
src: ['*'],
dest: 'build',
filter: 'isDirectory'
}
]
},
}
```
#### CLI overwrite option
To override the overwrite option via the CLI pass it as an option
```shell
grunt symlink --overwrite
```
#### Usage tips on Microsoft Windows
Make sure your command prompt has administrative privileges, otherwise
the task will not work.
## Release History
* 2016-02-28 v1.0.0 Added `force` option when overwriting a symlink outside the current working directory.
* 2014-02-01 v0.3.0 Fixed symlinking to '.'. Add Windows usage hints. Added error logging and force failure when unable to create a symlink.
* 2013-07-26 v0.2.0 Initial release as rewritten, officially-maintained, contrib plugin.
* 2012-12-21 v0.1.1 Unofficial release.
* 2012-12-20 v0.1.0 Unofficial release.
---
Task submitted by ["Cowboy" Ben Alman](http://benalman.com/)
*This file was generated on Thu Apr 14 2016 09:11:03.*