projen
Version:
CDK for software projects
109 lines • 12.6 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ensureRelativePathStartsWithDot = ensureRelativePathStartsWithDot;
exports.isHiddenPath = isHiddenPath;
exports.ensureNotHiddenPath = ensureNotHiddenPath;
exports.isPathInside = isPathInside;
exports.realpathOfClosestExisting = realpathOfClosestExisting;
exports.ensurePathInsideProject = ensurePathInsideProject;
const node_fs_1 = require("node:fs");
const node_path_1 = require("node:path");
/**
* Helper function to format a path as dot notation regardless of how it
* was handed in.
*
* @param path - can be formatted as "path", "./path" (but not "/path", as it is absolute)
* @returns "./path"
*/
function ensureRelativePathStartsWithDot(path) {
if (path.startsWith(".")) {
return path;
}
if (path.startsWith("/")) {
throw new Error(`Path ${path} must be relative`);
}
return `./${path}`;
}
/**
* Checks if part of the file path is hidden
*/
function isHiddenPath(path) {
return /(^|\/)\.[^\/\.]/g.test(path);
}
/**
* Helper to assert a path is not hidden
*/
function ensureNotHiddenPath(value, name) {
if (isHiddenPath(value)) {
throw Error(`${name} cannot be a hidden path, got: ${value}`);
}
}
/**
* Checks if `file` is strictly inside `dir` (the directory itself does not count).
*
* Purely lexical: does not consult the filesystem, so symlinks are not
* resolved. Relative paths are resolved against the current working directory.
*/
function isPathInside(dir, file) {
const rel = (0, node_path_1.relative)(dir, file);
return (rel !== "" &&
!rel.startsWith(`..${node_path_1.sep}`) &&
rel !== ".." &&
!(0, node_path_1.isAbsolute)(rel));
}
/**
* Resolves symlinks in `p`, falling back to the closest existing ancestor for
* paths that do not exist (yet).
*/
function realpathOfClosestExisting(p) {
const missing = new Array();
let current = (0, node_path_1.resolve)(p);
while (true) {
try {
return (0, node_path_1.join)((0, node_fs_1.realpathSync)(current), ...missing);
}
catch {
const parent = (0, node_path_1.dirname)(current);
if (parent === current) {
return (0, node_path_1.resolve)(p);
}
missing.unshift((0, node_path_1.basename)(current));
current = parent;
}
}
}
/**
* Asserts that a path stays strictly inside a project directory.
*
* Use this before passing a user-configurable path to a destructive command
* (e.g. `rm -fr`): an absolute path or a path traversing outside of the
* project directory (via `..` or a symlink) could otherwise delete files
* anywhere on the machine. The project directory itself (`.`) is also
* rejected.
*
* The check resolves both paths on the filesystem (symlinks in existing path
* segments are followed). The last segment of the path is intentionally kept
* as-is: a symlink inside the project only affects the link itself.
*
* @param value the path to check, relative to the project directory
* @param name name of the option, used in the error message
* @param projectDir the project directory the path must stay inside of
* @throws if the path is absolute or does not stay inside the project directory
*/
function ensurePathInsideProject(value, name, projectDir) {
if ((0, node_path_1.isAbsolute)(value)) {
throw new Error(`${name} must be a relative path within the project directory, got absolute path: ${value}`);
}
const baseDir = realpathOfClosestExisting(projectDir);
const resolved = (0, node_path_1.resolve)(baseDir, value);
if (!isPathInside(baseDir, resolved)) {
throw new Error(`${name} must be inside the project directory, got: ${value}`);
}
// the path might traverse outside of the project through a symlinked
// directory, which a lexical `resolve` cannot detect
const realParent = realpathOfClosestExisting((0, node_path_1.dirname)(resolved));
if (!isPathInside(baseDir, (0, node_path_1.join)(realParent, (0, node_path_1.basename)(resolved)))) {
throw new Error(`${name} must be inside the project directory, but points outside of it through a symlink, got: ${value}`);
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/util/path.ts"],"names":[],"mappings":";;AAkBA,0EAUC;AAKD,oCAEC;AAKD,kDAIC;AAQD,oCAQC;AAMD,8DAgBC;AAoBD,0DA4BC;AAlID,qCAAuC;AACvC,yCAQmB;AAEnB;;;;;;GAMG;AACH,SAAgB,+BAA+B,CAAC,IAAY;IAC1D,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,mBAAmB,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,KAAK,IAAI,EAAE,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,IAAY;IACvC,OAAO,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CAAC,KAAa,EAAE,IAAY;IAC7D,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,KAAK,CAAC,GAAG,IAAI,kCAAkC,KAAK,EAAE,CAAC,CAAC;IAChE,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,GAAW,EAAE,IAAY;IACpD,MAAM,GAAG,GAAG,IAAA,oBAAQ,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChC,OAAO,CACL,GAAG,KAAK,EAAE;QACV,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,eAAG,EAAE,CAAC;QAC3B,GAAG,KAAK,IAAI;QACZ,CAAC,IAAA,sBAAU,EAAC,GAAG,CAAC,CACjB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,yBAAyB,CAAC,CAAS;IACjD,MAAM,OAAO,GAAG,IAAI,KAAK,EAAU,CAAC;IACpC,IAAI,OAAO,GAAG,IAAA,mBAAO,EAAC,CAAC,CAAC,CAAC;IAEzB,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,CAAC;YACH,OAAO,IAAA,gBAAI,EAAC,IAAA,sBAAY,EAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;QACjD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,MAAM,GAAG,IAAA,mBAAO,EAAC,OAAO,CAAC,CAAC;YAChC,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;gBACvB,OAAO,IAAA,mBAAO,EAAC,CAAC,CAAC,CAAC;YACpB,CAAC;YACD,OAAO,CAAC,OAAO,CAAC,IAAA,oBAAQ,EAAC,OAAO,CAAC,CAAC,CAAC;YACnC,OAAO,GAAG,MAAM,CAAC;QACnB,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,uBAAuB,CACrC,KAAa,EACb,IAAY,EACZ,UAAkB;IAElB,IAAI,IAAA,sBAAU,EAAC,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,6EAA6E,KAAK,EAAE,CAC5F,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,yBAAyB,CAAC,UAAU,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,IAAA,mBAAO,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAEzC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,+CAA+C,KAAK,EAAE,CAC9D,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,qDAAqD;IACrD,MAAM,UAAU,GAAG,yBAAyB,CAAC,IAAA,mBAAO,EAAC,QAAQ,CAAC,CAAC,CAAC;IAChE,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAA,gBAAI,EAAC,UAAU,EAAE,IAAA,oBAAQ,EAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,2FAA2F,KAAK,EAAE,CAC1G,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { realpathSync } from \"node:fs\";\nimport {\n  basename,\n  dirname,\n  isAbsolute,\n  join,\n  relative,\n  resolve,\n  sep,\n} from \"node:path\";\n\n/**\n * Helper function to format a path as dot notation regardless of how it\n * was handed in.\n *\n * @param path - can be formatted as \"path\", \"./path\" (but not \"/path\", as it is absolute)\n * @returns \"./path\"\n */\nexport function ensureRelativePathStartsWithDot(path: string): string {\n  if (path.startsWith(\".\")) {\n    return path;\n  }\n\n  if (path.startsWith(\"/\")) {\n    throw new Error(`Path ${path} must be relative`);\n  }\n\n  return `./${path}`;\n}\n\n/**\n * Checks if part of the file path is hidden\n */\nexport function isHiddenPath(path: string) {\n  return /(^|\\/)\\.[^\\/\\.]/g.test(path);\n}\n\n/**\n * Helper to assert a path is not hidden\n */\nexport function ensureNotHiddenPath(value: string, name: string) {\n  if (isHiddenPath(value)) {\n    throw Error(`${name} cannot be a hidden path, got: ${value}`);\n  }\n}\n\n/**\n * Checks if `file` is strictly inside `dir` (the directory itself does not count).\n *\n * Purely lexical: does not consult the filesystem, so symlinks are not\n * resolved. Relative paths are resolved against the current working directory.\n */\nexport function isPathInside(dir: string, file: string): boolean {\n  const rel = relative(dir, file);\n  return (\n    rel !== \"\" &&\n    !rel.startsWith(`..${sep}`) &&\n    rel !== \"..\" &&\n    !isAbsolute(rel)\n  );\n}\n\n/**\n * Resolves symlinks in `p`, falling back to the closest existing ancestor for\n * paths that do not exist (yet).\n */\nexport function realpathOfClosestExisting(p: string): string {\n  const missing = new Array<string>();\n  let current = resolve(p);\n\n  while (true) {\n    try {\n      return join(realpathSync(current), ...missing);\n    } catch {\n      const parent = dirname(current);\n      if (parent === current) {\n        return resolve(p);\n      }\n      missing.unshift(basename(current));\n      current = parent;\n    }\n  }\n}\n\n/**\n * Asserts that a path stays strictly inside a project directory.\n *\n * Use this before passing a user-configurable path to a destructive command\n * (e.g. `rm -fr`): an absolute path or a path traversing outside of the\n * project directory (via `..` or a symlink) could otherwise delete files\n * anywhere on the machine. The project directory itself (`.`) is also\n * rejected.\n *\n * The check resolves both paths on the filesystem (symlinks in existing path\n * segments are followed). The last segment of the path is intentionally kept\n * as-is: a symlink inside the project only affects the link itself.\n *\n * @param value the path to check, relative to the project directory\n * @param name name of the option, used in the error message\n * @param projectDir the project directory the path must stay inside of\n * @throws if the path is absolute or does not stay inside the project directory\n */\nexport function ensurePathInsideProject(\n  value: string,\n  name: string,\n  projectDir: string,\n) {\n  if (isAbsolute(value)) {\n    throw new Error(\n      `${name} must be a relative path within the project directory, got absolute path: ${value}`,\n    );\n  }\n\n  const baseDir = realpathOfClosestExisting(projectDir);\n  const resolved = resolve(baseDir, value);\n\n  if (!isPathInside(baseDir, resolved)) {\n    throw new Error(\n      `${name} must be inside the project directory, got: ${value}`,\n    );\n  }\n\n  // the path might traverse outside of the project through a symlinked\n  // directory, which a lexical `resolve` cannot detect\n  const realParent = realpathOfClosestExisting(dirname(resolved));\n  if (!isPathInside(baseDir, join(realParent, basename(resolved)))) {\n    throw new Error(\n      `${name} must be inside the project directory, but points outside of it through a symlink, got: ${value}`,\n    );\n  }\n}\n"]}