CLI + Scoped Packages

README.md

@@ -1,7 +1,34 @@
 # symlinked
 Node 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)
 
-## Setup
+## CLI
+
+### Install via `npm` or `yarn`
+```
+npm install --global symlinked
+```
+
+```
+yarn add global symlinked
+```
+
+### Usage
+
+```
+Usage: symlinked [<path>]
+
+  Finds all linked package names of an npm package.
+
+Options:
+
+  -h, --help     Display this usage info
+  -p, --paths    Get linked package paths
+  -r, --roots    Get linked package roots
+  -l, --links    Get linked package links
+```
+
+## API
+
 ### Install via `npm` or `yarn`
 ```
 npm install symlinked
@@ -16,16 +43,16 @@ yarn add symlinked
 var symlinked = require("symlinked")
 ```
 
-## Methods
+### Methods
 - `symlinked.names(dir: ".")` get array of linked package names
 - `symlinked.paths(dir: ".")` get array of linked package paths
 - `symlinked.roots(dir: ".")` get array of linked package roots
 - `symlinked.links(dir: ".")` get array of linked package links
 - `symlinked.is(path)` test if path exists and is linked
 - `symlinked.read(path)` read link
 
-## Examples
-### Ran in package directory with `said` dependency linked on both ends
+### Examples
+#### Ran in package directory with `said` dependency linked on both ends
 ```js
 symlinked.names()
 // [ 'said' ]

bin.js

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+
+var symlinked = require("./")
+
+var help = false
+var dashdash = false
+var error = null
+var flags = []
+
+var args = process.argv.slice(2).filter(function(arg) {
+  if (dashdash)
+    return !!arg
+  else if (arg === "--")
+    dashdash = true
+  else if (arg === "--paths" || arg === "-p")
+    flags.push("paths")
+  else if (arg === "--roots" || arg === "-r")
+    flags.push("roots")
+  else if (arg === "--links" || arg === "-l")
+    flags.push("links")
+  else if (arg.match(/^(-+|\/)(h(elp)?|\?)$/))
+    help = true
+  else if (arg.match(/^-/))
+    error = "Unknown flag: " + arg
+  else
+    return !!arg
+})
+
+if (help || args.length > 1 || flags.length > 1 || error) {
+  // If they didn't ask for help, then this is not a "success"
+  var log = help ? console.log : console.error
+  log("Usage: symlinked [<path>]")
+  log("")
+  log("  Finds all linked package names of an npm package.")
+  log("")
+  if (error) {
+    log("  " + error)
+    log("")
+  }
+  if (flags.length > 1) {
+    log("  Maximum of one flag may be passed at a time. Received: " + JSON.stringify(flags))
+    log("")
+  }
+  log("Options:")
+  log("")
+  log("  -h, --help     Display this usage info")
+  log("  -p, --paths    Get linked package paths")
+  log("  -r, --roots    Get linked package roots")
+  log("  -l, --links    Get linked package links")
+  process.exit(help ? 0 : 1)
+} else
+  go(args[0] || ".")
+
+function go (dir) {
+  var exec = symlinked[flags[0] || "names"]
+  var results = exec(dir)
+  for (var i = 0; i < results.length; i++) {
+      console.log(results[i])
+  }
+}

index.js

@@ -9,14 +9,23 @@ function search(dir) {
   var context = path.resolve(dir)
   if (!fs.existsSync(context)) return []
   var contents = fs.readdirSync(context)
-  return contents.map(function(name) {
+  var scopedRoots = []
+  var results = contents.filter(function (name) {
+    var isBin = name === ".bin"
+    var isScoped = name.charAt(0) === "@"
+    if (isScoped) scopedRoots.push(path.join(dir, name))
+    return !isScoped && !isBin
+  }).map(function(name) {
     var relative = path.join(dir, name)
     var found = new Found
     found.name = name
     found.path = path.resolve(relative)
     if (is(relative)) found.link = read(relative)
     return found
   })
+  return scopedRoots.reduce(function (_, scopedRoot) {
+    return _.concat(search(scopedRoot))
+  }, results)
 }
 
 function read(p) {

package.json

@@ -3,6 +3,7 @@
   "version": "0.3.0",
   "description": "Node utility to list packages that are npm linked",
   "main": "index.js",
+  "bin": "bin.js",
   "scripts": {
     "demo": "node demo.js",
     "lint": "eslint . --ext .js",