symlink-dir 5.0.0 → 5.0.2

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2021 Zoltan Kochan <z@kochan.io>
+Copyright (c) 2016-2023 Zoltan Kochan <z@kochan.io>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -2,8 +2,8 @@
 
 > Cross-platform directory symlinking
 
-<!--@shields('npm', 'travis', 'appveyor')-->
-[![npm version](https://img.shields.io/npm/v/symlink-dir.svg)](https://www.npmjs.com/package/symlink-dir) [![Build Status](https://img.shields.io/travis/zkochan/symlink-dir/master.svg)](https://travis-ci.org/zkochan/symlink-dir) [![Build Status on Windows](https://img.shields.io/appveyor/ci/zkochan/symlink-dir/master.svg)](https://ci.appveyor.com/project/zkochan/symlink-dir/branch/master)
+<!--@shields('npm')-->
+[![npm version](https://img.shields.io/npm/v/symlink-dir.svg)](https://www.npmjs.com/package/symlink-dir)
 <!--/@-->
 
 * Always uses "junctions" on Windows. Even though support for "symbolic links" was added in Vista+, users by default lack permission to create them
@@ -49,10 +49,14 @@ symlinkDir('src', 'node_modules/src')
 
 ## API
 
-### `symlinkDir(src, dest): Promise<{ reused: boolean, warn?: string }>`
+### `symlinkDir(src, dest, opts?): Promise<{ reused: boolean, warn?: string }>`
 
 Creates a symlink in `dest` that points to `src`.
 
+Options:
+
+* `overwrite` - *boolean* - is `true` by default. When `false`, existing files at dest are not overwritten.
+
 Result:
 
 * `reused` - *boolean* - is `true` if the symlink already existed pointing to the `src`.

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AACA,6BAA6B;AAE7B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AAElC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA"}

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-declare function symlinkDir(src: string, dest: string): Promise<{
+declare function symlinkDir(src: string, dest: string, opts?: {
+    overwrite?: boolean;
+}): Promise<{
     reused: Boolean;
     warn?: string;
 }>;

package/dist/index.js

@@ -14,19 +14,19 @@ function resolveSrcOnWin(src, dest) {
 function resolveSrcOnNonWin(src, dest) {
     return path.relative(path.dirname(dest), src);
 }
-function symlinkDir(src, dest) {
+function symlinkDir(src, dest, opts) {
     dest = betterPathResolve(dest);
     src = betterPathResolve(src);
     if (src === dest)
         throw new Error(`Symlink path is the same as the target path (${src})`);
     src = resolveSrc(src, dest);
-    return forceSymlink(src, dest);
+    return forceSymlink(src, dest, opts);
 }
 /**
  * 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).
  */
-async function forceSymlink(src, dest) {
+async function forceSymlink(src, dest, opts) {
     try {
         await fs_1.promises.symlink(src, dest, symlinkType);
         return { reused: false };
@@ -43,10 +43,13 @@ async function forceSymlink(src, dest) {
                         `Details: ${mkdirError}`;
                     throw mkdirError;
                 }
-                await fs_1.promises.symlink(src, dest, symlinkType);
+                await forceSymlink(src, dest, opts);
                 return { reused: false };
             case 'EEXIST':
             case 'EISDIR':
+                if ((opts === null || opts === void 0 ? void 0 : opts.overwrite) === false) {
+                    throw err;
+                }
                 // If the target file already exists then we proceed.
                 // Additional checks are done below.
                 break;
@@ -61,18 +64,28 @@ async function forceSymlink(src, dest) {
     catch (err) {
         // Dest is not a link
         const parentDir = path.dirname(dest);
-        const ignore = `.ignored_${path.basename(dest)}`;
-        await renameOverwrite(dest, path.join(parentDir, ignore));
+        let warn;
+        if (opts === null || opts === void 0 ? void 0 : opts.renameTried) {
+            // This is needed in order to fix a mysterious bug that sometimes happens on macOS.
+            // It is hard to reproduce and is described here: https://github.com/pnpm/pnpm/issues/5909#issuecomment-1400066890
+            await fs_1.promises.unlink(dest);
+            warn = `Symlink wanted name was occupied by directory or file. Old entity removed: "${parentDir}${path.sep}{${path.basename(dest)}".`;
+        }
+        else {
+            const ignore = `.ignored_${path.basename(dest)}`;
+            await renameOverwrite(dest, path.join(parentDir, ignore));
+            warn = `Symlink wanted name was occupied by directory or file. Old entity moved: "${parentDir}${path.sep}{${path.basename(dest)} => ${ignore}".`;
+        }
         return {
-            ...await forceSymlink(src, dest),
-            warn: `Symlink wanted name was occupied by directory or file. Old entity moved: "${parentDir}${path.sep}{${path.basename(dest)} => ${ignore}}".`,
+            ...await forceSymlink(src, dest, { ...opts, renameTried: true }),
+            warn,
         };
     }
     if (src === linkString) {
         return { reused: true };
     }
     await fs_1.promises.unlink(dest);
-    return await forceSymlink(src, dest);
+    return await forceSymlink(src, dest, opts);
 }
 // for backward compatibility
 symlinkDir['default'] = symlinkDir;

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,yDAAyD;AACzD,2BAAmC;AACnC,6BAA6B;AAC7B,oDAAoD;AAEpD,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAS,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AAErG,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,SAAS,eAAe,CAAE,GAAW,EAAE,IAAY;IACjD,OAAO,GAAG,GAAG,IAAI,CAAA;AACnB,CAAC;AAED,SAAS,kBAAkB,CAAE,GAAW,EAAE,IAAY;IACpD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAA;AAC/C,CAAC;AAED,SAAS,UAAU,CAAE,GAAW,EAAE,IAAY,EAAE,IAA8B;IAC5E,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAC9B,GAAG,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAA;IAE5B,IAAI,GAAG,KAAK,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,GAAG,GAAG,CAAC,CAAA;IAEzF,GAAG,GAAG,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IAE3B,OAAO,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;AACtC,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,YAAY,CACzB,GAAW,EACX,IAAY,EACZ,IAGC;IAED,IAAI;QACF,MAAM,aAAE,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,WAAW,CAAC,CAAA;QACxC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;KACzB;IAAC,OAAO,GAAG,EAAE;QACZ,QAAgC,GAAI,CAAC,IAAI,EAAE;YACzC,KAAK,QAAQ;gBACX,IAAI;oBACF,MAAM,aAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;iBACxD;gBAAC,OAAO,UAAU,EAAE;oBACnB,UAAU,CAAC,OAAO,GAAG,kCAAkC,GAAG,SAAS,IAAI,KAAK;wBAC1E,yFAAyF;wBACzF,YAAY,UAAU,EAAE,CAAA;oBAC1B,MAAM,UAAU,CAAA;iBACjB;gBACD,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;gBACnC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;YAC1B,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,MAAK,KAAK,EAAE;oBAC7B,MAAM,GAAG,CAAA;iBACV;gBACD,qDAAqD;gBACrD,oCAAoC;gBACpC,MAAK;YACP;gBACE,MAAM,GAAG,CAAA;SACZ;KACF;IAED,IAAI,UAAkB,CAAA;IACtB,IAAI;QACF,UAAU,GAAG,MAAM,aAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;KACrC;IAAC,OAAO,GAAG,EAAE;QACZ,qBAAqB;QACrB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACpC,IAAI,IAAa,CAAA;QACjB,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,EAAE;YACrB,mFAAmF;YACnF,kHAAkH;YAClH,MAAM,aAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACrB,IAAI,GAAG,+EAA+E,SAAS,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAA;SACtI;aAAM;YACL,MAAM,MAAM,GAAG,YAAY,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAA;YAChD,MAAM,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAA;YACzD,IAAI,GAAG,6EAA6E,SAAS,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,MAAM,IAAI,CAAA;SACjJ;QAED,OAAO;YACL,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;YAChE,IAAI;SACL,CAAA;KACF;IAED,IAAI,GAAG,KAAK,UAAU,EAAE;QACtB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;KACxB;IACD,MAAM,aAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACrB,OAAO,MAAM,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;AAC5C,CAAC;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": "5.0.0",
+  "version": "5.0.2",
   "description": "Cross-platform directory symlinking",
   "main": "dist/index.js",
   "files": [
@@ -17,18 +17,9 @@
     "dir",
     "folder"
   ],
-  "scripts": {
-    "pretest": "rimraf node_modules/src",
-    "test": "ts-node test",
-    "test-md": "mos t",
-    "premd": "rimraf node_modules/src && npm run tsc",
-    "md": "mos",
-    "tsc": "rimraf dist && tsc",
-    "prepublishOnly": "npm run tsc"
-  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/zkochan/symlink-dir.git"
+    "url": "git+https://github.com/pnpm/symlink-dir.git"
   },
   "author": {
     "name": "Zoltan Kochan",
@@ -37,24 +28,22 @@
   },
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/zkochan/symlink-dir/issues"
+    "url": "https://github.com/pnpm/symlink-dir/issues"
   },
-  "homepage": "https://github.com/zkochan/symlink-dir#readme",
+  "homepage": "https://github.com/pnpm/symlink-dir#readme",
   "devDependencies": {
-    "@types/node": "^14.0.11",
-    "@types/tape": "^4.13.0",
-    "mos": "^1.3.1",
-    "mos-plugin-readme": "^1.0.4",
+    "@types/node": "^16.18.3",
+    "@types/tape": "^4.13.2",
     "rimraf": "^3.0.2",
-    "tape": "^5.0.1",
-    "tempy": "^1.0.0",
-    "ts-node": "^9.0.0",
-    "typescript": "^4.0.0",
+    "tape": "^5.6.1",
+    "tempy": "^1.0.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.3",
     "write-json-file": "^4.3.0"
   },
   "dependencies": {
     "better-path-resolve": "^1.0.0",
-    "rename-overwrite": "^4.0.0"
+    "rename-overwrite": "^4.0.3"
   },
   "mos": {
     "plugins": [
@@ -66,5 +55,11 @@
   },
   "engines": {
     "node": ">=12.10"
+  },
+  "scripts": {
+    "pretest": "rimraf node_modules/src",
+    "test": "ts-node test",
+    "premd": "rimraf node_modules/src && npm run tsc",
+    "tsc": "rimraf dist && tsc"
   }
-}
+}