feat: add new package dependent-path-update

Author: DylanPiercey

.eslintignore

@@ -1,6 +1,11 @@
 *.marko.js
-.cache/
-.nyc_output/
-node_modules/
-coverage/
-dist/
+.cache
+.nyc_output
+coverage
+lerna.json
+package.json
+package-lock.json
+CHANGELOG.md
+packages/*/node_modules
+packages/*/dist
+packages/*/test/fixtures

.gitignore

@@ -3,6 +3,7 @@
 *.DS_Store
 *.marko.js
 *.history/
+.vscode
 *actual.*
 .cache/
 .nyc_output/

.prettierignore

@@ -1,10 +1,11 @@
 *.marko.js
-.cache/
-.nyc_output/
+.cache
+.nyc_output
+coverage
 lerna.json
 package.json
 package-lock.json
 CHANGELOG.md
-node_modules/
-coverage/
-dist/
+packages/*/node_modules
+packages/*/dist
+packages/*/test/fixtures

README.md

@@ -34,6 +34,8 @@
   extract all valid node flags from a list of process args
 - [abort-group](https://github.com/marko-js/utils/blob/master/packages/abort-group/README.md) -
   group a set of cancelable actions to be aborted together at any time.
+- [dependent-path-update](https://github.com/marko-js/utils/blob/master/packages/dependent-path-update/README.md) -
+  A tool to update dependent paths when renaming a file.
 
 ## Contributing
 

package-lock.json

@@ -22,6 +22,7 @@
     "lerna": "3.4.3",
     "lint-staged": "^7.3.0",
     "mocha": "^5.2.0",
+    "mocha-autotest": "^1.0.2",
     "nyc": "^13.1.0",
     "prettier": "^1.14.3",
     "sinon": "^7.0.0"
@@ -32,7 +33,7 @@
       "git add"
     ],
     "*.js": [
-      "eslint -f visualstudio",
+      "eslint --quiet -f visualstudio",
       "prettier --write",
       "git add"
     ]

package.json

@@ -0,0 +1,35 @@
+# dependent-path-update
+
+A tool to update dependent paths when renaming a file.
+
+This uses regexps based on the folder depth to match all possible relative require paths in to file and updates all of those paths to a new path. Ultimately allowing you to rename a file and updating all dependents (not just js files!).
+
+## Install
+
+```bash
+npm install --save dependent-path-update
+```
+
+## Usage
+
+```javascript
+import dependentPathUpdate from "dependent-path-update";
+
+dependentPathUpdate({
+  projectDir: process.cwd(), // The root directory of the project from which all paths should be relative.
+  from: "src/file-a.js", // The original file path.
+  to: "src/files/a.js", // The new file path.
+  files: [
+    // List of glob patterns of files to check.
+    "*.{js,json}"
+  ]
+}).then(output => {
+  // Output contains an object with all of the updated sources.
+  console.log("updated all dependents");
+
+  for (const file in output) {
+    // Save all outputs to disk.
+    fs.writeFileSync(file, output[file], "utf-8");
+  }
+});
+```

packages/dependent-path-update/README.md

@@ -0,0 +1,28 @@
+{
+  "name": "dependent-path-update",
+  "description": "A tool to update dependent paths when renaming a file.",
+  "version": "0.0.0",
+  "author": "Dylan Piercey <[email protected]>",
+  "bugs": "https://github.com/marko-js/utils/issues/new?template=Bug_report.md",
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/marko-js/utils/blob/master/packages/dependent-path-update/README.md",
+  "keywords": [
+    "dependent",
+    "path",
+    "update",
+    "rename"
+  ],
+  "dependencies": {
+    "glob": "^7.1.3",
+    "escape-string-regexp": "^1.0.5"
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "bin": "dist/cli.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/marko-js/utils/tree/master/packages/dependent-path-update"
+  }
+}

packages/dependent-path-update/package.json

@@ -0,0 +1,17 @@
+import { promisify } from "util";
+import _glob from "glob";
+const glob = promisify(_glob);
+
+export default async function getFiles(patterns, globOptions) {
+  return (await Promise.all(
+    patterns.map(pattern => {
+      if (pattern === ".") {
+        pattern = "**/*";
+      } else if (pattern[pattern.length - 1] === "/") {
+        pattern += "**/*";
+      }
+
+      return glob(pattern, globOptions);
+    })
+  )).reduce((a, b) => a.concat(b));
+}

packages/dependent-path-update/src/get-files.js

@@ -0,0 +1,21 @@
+import path from "path";
+import getRelativeRequirePath from "./get-relative-require-path";
+
+export default function getPotentialPaths(projectDir, from, to) {
+  const fromDir = path.dirname(from);
+  const projectRelativePath = path.relative(projectDir, fromDir);
+  const toRelativePath = getRelativeRequirePath(fromDir, to);
+  const potentialPaths = [toRelativePath];
+  let index = projectRelativePath.length;
+  let backtrack = "../";
+
+  do {
+    index = projectRelativePath.lastIndexOf("/", index - 2) + 1;
+    potentialPaths.push(
+      path.join(backtrack, projectRelativePath.slice(index), toRelativePath)
+    );
+    backtrack += "../";
+  } while (index);
+
+  return potentialPaths;
+}

packages/dependent-path-update/src/get-potential-paths.js

@@ -0,0 +1,15 @@
+import path from "path";
+
+export default function getRelativePath(from, to) {
+  const result = path.relative(from, to);
+
+  if (result === "") {
+    return ".";
+  }
+
+  if (result[0] !== ".") {
+    return "./" + result;
+  }
+
+  return result;
+}