{"id":20119803,"url":"https://github.com/gruntjs/grunt-contrib-symlink","last_synced_at":"2025-07-25T05:37:50.041Z","repository":{"id":53593140,"uuid":"11692975","full_name":"gruntjs/grunt-contrib-symlink","owner":"gruntjs","description":"Create symbolic links.","archived":false,"fork":false,"pushed_at":"2021-03-22T15:02:24.000Z","size":28,"stargazers_count":56,"open_issues_count":6,"forks_count":20,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-07-13T13:59:38.064Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gruntjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-07-26T19:18:15.000Z","updated_at":"2024-10-12T08:14:19.000Z","dependencies_parsed_at":"2022-09-06T05:20:22.077Z","dependency_job_id":null,"html_url":"https://github.com/gruntjs/grunt-contrib-symlink","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/gruntjs/grunt-contrib-symlink","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntjs%2Fgrunt-contrib-symlink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntjs%2Fgrunt-contrib-symlink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntjs%2Fgrunt-contrib-symlink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntjs%2Fgrunt-contrib-symlink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gruntjs","download_url":"https://codeload.github.com/gruntjs/grunt-contrib-symlink/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntjs%2Fgrunt-contrib-symlink/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266962231,"owners_count":24012994,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T19:17:14.468Z","updated_at":"2025-07-25T05:37:49.986Z","avatar_url":"https://github.com/gruntjs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-contrib-symlink v1.0.0 [![Build Status: Linux](https://travis-ci.org/gruntjs/grunt-contrib-symlink.svg?branch=master)](https://travis-ci.org/gruntjs/grunt-contrib-symlink) [![Build Status: Windows](https://ci.appveyor.com/api/projects/status/sx8wri5lj9g3eq7f/branch/master?svg=true)](https://ci.appveyor.com/project/gruntjs/grunt-contrib-symlink/branch/master)\n\n\u003e Create symbolic links.\n\n\n\n## Getting Started\n\nIf 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:\n\n```shell\nnpm install grunt-contrib-symlink --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-contrib-symlink');\n```\n\n\n\n\n## Symlink task\n_Run this task with the `grunt symlink` command._\n\nTask 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.\n\nNote that the symlink mode (file, dir) is determined automatically based on the src file type.\n\n\n### Usage Examples\n\n```js\nsymlink: {\n  options: {\n    // Enable overwrite to delete symlinks before recreating them\n    overwrite: false,\n    // Enable force to overwrite symlinks outside the current working directory\n    force: false\n  },\n  // The \"build/target.txt\" symlink will be created and linked to\n  // \"source/target.txt\". It should appear like this in a file listing:\n  // build/target.txt -\u003e ../source/target.txt\n  explicit: {\n    src: 'source/target.txt',\n    dest: 'build/target.txt'\n  },\n  // These examples using \"expand\" to generate src-dest file mappings:\n  // http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically\n  expanded: {\n    files: [\n      // All child files and directories in \"source\", starting with \"foo-\" will\n      // be symlinked into the \"build\" directory, with the leading \"source\"\n      // stripped off.\n      {\n        expand: true,\n        overwrite: false,\n        cwd: 'source',\n        src: ['foo-*'],\n        dest: 'build'\n      },\n      // All child directories in \"source\" will be symlinked into the \"build\"\n      // directory, with the leading \"source\" stripped off.\n      {\n        expand: true,\n        overwrite: false,\n        cwd: 'source',\n        src: ['*'],\n        dest: 'build',\n        filter: 'isDirectory'\n      }\n    ]\n  },\n}\n```\n\n#### CLI overwrite option\n\nTo override the overwrite option via the CLI pass it as an option\n\n```shell\n  grunt symlink --overwrite\n```\n\n#### Usage tips on Microsoft Windows\n\nMake sure your command prompt has administrative privileges, otherwise\nthe task will not work.\n\n\n## Release History\n\n * 2016-02-28   v1.0.0   Added `force` option when overwriting a symlink outside the current working directory.\n * 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.\n * 2013-07-26   v0.2.0   Initial release as rewritten, officially-maintained, contrib plugin.\n * 2012-12-21   v0.1.1   Unofficial release.\n * 2012-12-20   v0.1.0   Unofficial release.\n\n---\n\nTask submitted by [\"Cowboy\" Ben Alman](http://benalman.com/)\n\n*This file was generated on Thu Apr 14 2016 09:11:03.*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgruntjs%2Fgrunt-contrib-symlink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgruntjs%2Fgrunt-contrib-symlink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgruntjs%2Fgrunt-contrib-symlink/lists"}