symlink-dir 1.0.3 → 1.1.3

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Zoltan Kochan
+Copyright (c) 2016-2018 Zoltan Kochan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -7,7 +7,7 @@
 <!--/@-->
 
 Always uses "junctions" on Windows. Even though support for "symbolic links" was added in Vista+, users by default
-lack permission to create them 
+lack permission to create them
 
 ## Installation
 
@@ -31,12 +31,29 @@ symlink-dir . node_modules/my-package
 'use strict'
 const symlinkDir = require('symlink-dir')
 const path = require('path')
-const cwd = process.cwd()
 
-symlinkDir(path.join(cwd, 'src'), path.join(cwd, 'node_modules/src'))
+symlinkDir('src', 'node_modules/src')
+  .then(result => {
+    console.log(result)
+    //> { reused: false }
+
+    return symlinkDir('src', 'node_modules/src')
+  })
+  .then(result => {
+    console.log(result)
+    //> { reused: true }
+  })
+  .catch(err => console.error(err))
 ```
 <!--/@-->
 
+## API
+
+### `symlinkDir(src, dest): Promise<{reused: boolean}>`
+
+Creates a symlink in `dest` that points to `src`. Returns an object that contains a boolean property called `reused`.
+`reused` is `true` if the symlink already existed pointing to the `src`.
+
 ## License
 
-[MIT](./LICENSE) © [Zoltan Kochan](http://kochan.io)
+[MIT](./LICENSE) © [Zoltan Kochan](https://www.kochan.io)

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -1,2 +1,4 @@
-declare function symlinkDir(src: string, dest: string): Promise<void>;
+declare function symlinkDir(src: string, dest: string): Promise<{
+    reused: Boolean;
+}>;
 export = symlinkDir;

package/dist/index.js

@@ -11,23 +11,28 @@ const fs = require("mz/fs");
 const path = require("path");
 const mkdirp = require("mkdirp-promise");
 const isWindows = require("is-windows");
+const IS_WINDOWS = isWindows();
 // Always use "junctions" on Windows. Even though support for "symbolic links" was added in Vista+, users by default
 // lack permission to create them
-const symlinkType = isWindows() ? 'junction' : 'dir';
+const symlinkType = IS_WINDOWS ? 'junction' : 'dir';
+const resolveSrc = IS_WINDOWS ? resolveSrcOnWin : resolveSrcOnNonWin;
+function resolveSrcOnWin(src, dest) {
+    return `${path.resolve(src)}\\`;
+}
+function resolveSrcOnNonWin(src, dest) {
+    return path.relative(path.dirname(dest), path.resolve(src));
+}
 function symlinkDir(src, dest) {
     return __awaiter(this, void 0, void 0, function* () {
-        src = path.resolve(src);
         dest = path.resolve(dest);
-        // Junction points can't be relative
-        const rel = symlinkType !== 'junction' ? path.relative(path.dirname(dest), src) : src;
+        src = resolveSrc(src, dest);
         try {
-            yield forceSymlink(rel, dest);
+            return yield forceSymlink(src, dest);
         }
         catch (err) {
             if (err.code === 'ENOENT') {
                 yield mkdirp(path.dirname(dest));
-                yield forceSymlink(rel, dest);
-                return;
+                return yield forceSymlink(src, dest);
             }
             throw err;
         }
@@ -41,16 +46,17 @@ function forceSymlink(src, dest) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             yield fs.symlink(src, dest, symlinkType);
+            return { reused: false };
         }
         catch (err) {
             if (err.code !== 'EEXIST')
                 throw err;
             const linkString = yield fs.readlink(dest);
             if (src === linkString) {
-                return;
+                return { reused: true };
             }
             yield fs.unlink(dest);
-            yield forceSymlink(src, dest);
+            return yield forceSymlink(src, dest);
         }
     });
 }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4BAA4B;AAC5B,6BAA6B;AAE7B,yCAAyC;AACzC,wCAAwC;AAExC,oHAAoH;AACpH,iCAAiC;AACjC,MAAM,WAAW,GAAG,SAAS,EAAE,GAAG,UAAU,GAAG,KAAK,CAAA;AAEpD,oBAA2B,GAAW,EAAE,IAAY;;QAClD,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QACvB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAEzB,oCAAoC;QACpC,MAAM,GAAG,GAAG,WAAW,KAAK,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,CAAA;QAErF,IAAI,CAAC;YACH,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QAC/B,CAAC;QAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACb,EAAE,CAAC,CAAyB,GAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACnD,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;gBAChC,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;gBAC7B,MAAM,CAAA;YACR,CAAC;YACD,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;CAAA;AAED;;;GAGG;AACH,sBAA6B,GAAW,EAAE,IAAY;;QACpD,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,WAAW,CAAC,CAAA;QAC1C,CAAC;QAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACb,EAAE,CAAC,CAAyB,GAAI,CAAC,IAAI,KAAK,QAAQ,CAAC;gBAAC,MAAM,GAAG,CAAA;YAE7D,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;YAC1C,EAAE,CAAC,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC;gBACvB,MAAM,CAAA;YACR,CAAC;YACD,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACrB,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;CAAA;AAED,6BAA6B;AAC7B,UAAU,CAAC,SAAS,CAAC,GAAG,UAAU,CAAA;AAElC,iBAAS,UAAU,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4BAA4B;AAC5B,6BAA6B;AAE7B,yCAAyC;AACzC,wCAAwC;AAExC,MAAM,UAAU,GAAG,SAAS,EAAE,CAAA;AAE9B,oHAAoH;AACpH,iCAAiC;AACjC,MAAM,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAA;AAEnD,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,eAAe,CAAA,CAAC,CAAC,kBAAkB,CAAA;AAEnE,yBAA0B,GAAW,EAAE,IAAY;IACjD,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA;AACjC,CAAC;AAED,4BAA6B,GAAW,EAAE,IAAY;IACpD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;AAC7D,CAAC;AAED,oBAA2B,GAAW,EAAE,IAAY;;QAClD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACzB,GAAG,GAAG,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QAE3B,IAAI;YACF,OAAO,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;SACrC;QAAC,OAAO,GAAG,EAAE;YACZ,IAA4B,GAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAClD,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;gBAChC,OAAO,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;aACrC;YACD,MAAM,GAAG,CAAA;SACV;IACH,CAAC;CAAA;AAED;;;GAGG;AACH,sBAA6B,GAAW,EAAE,IAAY;;QACpD,IAAI;YACF,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,WAAW,CAAC,CAAA;YACxC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;SACzB;QAAC,OAAO,GAAG,EAAE;YACZ,IAA4B,GAAI,CAAC,IAAI,KAAK,QAAQ;gBAAE,MAAM,GAAG,CAAA;YAE7D,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;YAC1C,IAAI,GAAG,KAAK,UAAU,EAAE;gBACtB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;aACxB;YACD,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACrB,OAAO,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;SACrC;IACH,CAAC;CAAA;AAED,6BAA6B;AAC7B,UAAU,CAAC,SAAS,CAAC,GAAG,UAAU,CAAA;AAElC,iBAAS,UAAU,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "symlink-dir",
-  "version": "1.0.3",
+  "version": "1.1.3",
   "description": "Cross-platform directory symlinking",
   "main": "dist/index.js",
   "files": [
@@ -17,10 +17,12 @@
     "folder"
   ],
   "scripts": {
+    "pretest": "rimraf node_modules/src",
     "test": "npm run tsc && mos t",
+    "premd": "rimraf node_modules/src && npm run tsc",
     "md": "mos",
-    "tsc": "rm -rf dist && tsc",
-    "prepublish": "npm run tsc"
+    "tsc": "rimraf dist && tsc",
+    "prepublishOnly": "npm run tsc"
   },
   "repository": {
     "type": "git",
@@ -28,8 +30,8 @@
   },
   "author": {
     "name": "Zoltan Kochan",
-    "email": "zoltan.kochan@gmail.com",
-    "url": "http://kochan.io"
+    "email": "z@kochan.io",
+    "url": "https://www.kochan.io"
   },
   "license": "MIT",
   "bugs": {
@@ -37,17 +39,16 @@
   },
   "homepage": "https://github.com/zkochan/symlink-dir#readme",
   "devDependencies": {
-    "cash-rm": "^0.2.0",
-    "mos": "^1.3.1",
+    "mos": "^2.0.0-alpha.3",
     "mos-plugin-readme": "^1.0.4",
+    "rimraf": "^2.6.1",
     "typescript": "^2.0.3"
   },
   "dependencies": {
-    "@types/mz": "0.0.31",
-    "@types/node": "^7.0.4",
+    "@types/mz": "0.0.32",
+    "@types/node": "^10.0.8",
     "graceful-fs": "^4.1.11",
     "is-windows": "^1.0.0",
-    "mkdirp": "^0.5.1",
     "mkdirp-promise": "^5.0.0",
     "mz": "^2.4.0"
   },

package/dist/forceSymlink.d.ts

@@ -1,6 +0,0 @@
-export declare type SymlinkType = 'junction' | 'dir';
-/**
- * Creates a symlink. Re-link if a symlink already exists at the supplied
- * srcPath. API compatible with [`fs#symlink`](https://nodejs.org/api/fs.html#fs_fs_symlink_srcpath_dstpath_type_callback).
- */
-export default function forceSymlink(srcPath: string, dstPath: string, type: SymlinkType): Promise<void>;

package/dist/forceSymlink.js

@@ -1,34 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-const fs = require("mz/fs");
-/**
- * Creates a symlink. Re-link if a symlink already exists at the supplied
- * srcPath. API compatible with [`fs#symlink`](https://nodejs.org/api/fs.html#fs_fs_symlink_srcpath_dstpath_type_callback).
- */
-function forceSymlink(srcPath, dstPath, type) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            yield fs.symlink(srcPath, dstPath, type);
-        }
-        catch (err) {
-            if (err.code !== 'EEXIST')
-                throw err;
-            const linkString = yield fs.readlink(dstPath);
-            if (srcPath === linkString) {
-                return;
-            }
-            yield fs.unlink(dstPath);
-            yield forceSymlink(srcPath, dstPath, type);
-        }
-    });
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = forceSymlink;
-//# sourceMappingURL=forceSymlink.js.map

package/dist/forceSymlink.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"forceSymlink.js","sourceRoot":"","sources":["../src/forceSymlink.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4BAA4B;AAI5B;;;GAGG;AACH,sBAA4C,OAAe,EAAE,OAAe,EAAE,IAAiB;;QAC7F,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;QAC1C,CAAC;QAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACb,EAAE,CAAC,CAAyB,GAAI,CAAC,IAAI,KAAK,QAAQ,CAAC;gBAAC,MAAM,GAAG,CAAA;YAE7D,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;YAC7C,EAAE,CAAC,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC;gBAC3B,MAAM,CAAA;YACR,CAAC;YACD,MAAM,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YACxB,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;QAC5C,CAAC;IACH,CAAC;CAAA;;AAbD,+BAaC"}