{"id":16760336,"url":"https://github.com/ryanve/symlinked","last_synced_at":"2025-10-28T06:16:00.613Z","repository":{"id":65412286,"uuid":"90173302","full_name":"ryanve/symlinked","owner":"ryanve","description":"Got symlinked packages?","archived":false,"fork":false,"pushed_at":"2021-10-25T15:54:55.000Z","size":32,"stargazers_count":8,"open_issues_count":2,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-15T21:51:23.626Z","etag":null,"topics":["nodejs","npm-link","symlinks","yarn-link"],"latest_commit_sha":null,"homepage":"https://ryanve.dev/symlinked/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryanve.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-03T17:04:03.000Z","updated_at":"2024-02-04T16:49:06.000Z","dependencies_parsed_at":"2023-01-22T07:45:17.267Z","dependency_job_id":null,"html_url":"https://github.com/ryanve/symlinked","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanve%2Fsymlinked","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanve%2Fsymlinked/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanve%2Fsymlinked/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanve%2Fsymlinked/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryanve","download_url":"https://codeload.github.com/ryanve/symlinked/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244311175,"owners_count":20432673,"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","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":["nodejs","npm-link","symlinks","yarn-link"],"created_at":"2024-10-13T04:23:09.796Z","updated_at":"2025-10-28T06:16:00.523Z","avatar_url":"https://github.com/ryanve.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# symlinked\nNode utility to list symlinks made by [`npm link`](https://docs.npmjs.com/cli/link), [`yarn link`](https://yarnpkg.com/lang/en/docs/cli/link/), or [`fs.link`](https://nodejs.org/api/fs.html)\n\n## Install\n\n```\nnpm install symlinked\n```\n\nLocal install as above is best practice if you are using in a shared codebase because then all developers will use the same version. CLI can be used locally via npx or via npm scripts. `npm install` has a `--global` flag you can add if you prefer global use. Yarn can be used via `yarn add` and `yarn global add` respectively if you prefer yarn.\n\n## CLI\n\n```\nUsage: symlinked \u003ccommand\u003e [\u003cpath\u003e]\n\n  Finds all linked package names of an npm package.\n\nCommands:\n\n  names    Get linked package names\n  paths    Get linked package paths\n  roots    Get linked package roots\n  links    Get linked package links\n\nOptions:\n\n  -h, --help     Display this usage info\n```\n\n### CLI example\n\n\u003cpre\u003e\n\u003cb\u003e# Link some packages for example\u003c/b\u003e\nnpm link @songkick/promise-retry\nnpm link eol\n\n\u003cb\u003e$ symlinked names\u003c/b\u003e\n@songkick/promise-retry\neol\n\n\u003cb\u003e$ symlinked paths\u003c/b\u003e\n/Users/doe/project/node_modules/@songkick/promise-retry\n/Users/doe/project/node_modules/eol\n\n\u003cb\u003e$ symlinked roots\u003c/b\u003e\n/Users/doe/project/node_modules/@songkick/promise-retry/node_modules\n/Users/doe/project/node_modules/eol/node_modules\n\n\u003cb\u003e$ symlinked links\u003c/b\u003e\n/usr/local/lib/node_modules/@songkick/promise-retry\n/usr/local/lib/node_modules/eol\n\u003c/pre\u003e\n\n## API\n\n### `require`\n```js\nconst symlinked = require(\"symlinked\")\n```\n\n### Methods\n- `symlinked.names(dir: \".\")` get array of linked package names\n- `symlinked.paths(dir: \".\")` get array of linked package paths\n- `symlinked.roots(dir: \".\")` get array of linked package roots\n- `symlinked.links(dir: \".\")` get array of linked package links\n- `symlinked.is(path)` test if path exists and is linked\n- `symlinked.read(path)` read link\n\n### Examples\n#### Ran in package directory with `said` dependency linked on both ends\n```js\nsymlinked.names()\n// [ 'said' ]\n```\n\n```js\nsymlinked.paths()\n// [ '/Users/jdoe/symlinked/node_modules/said' ]\n```\n\n```js\nsymlinked.roots()\n// [ '/Users/jdoe/symlinked/node_modules/said/node_modules' ]\n```\n\n```js\nsymlinked.links()\n// [ '/Users/said' ]\n```\n\n## Webpack\n### [`resolve.modules`](https://webpack.js.org/configuration/resolve/#resolve-modules) configuration to resolve dependencies of linked dependencies\n\n```js\nmodule.exports = {\n  resolve: {\n    modules: [\"node_modules\"].concat(symlinked.roots())\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanve%2Fsymlinked","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryanve%2Fsymlinked","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanve%2Fsymlinked/lists"}