⬅️ Back to Table of Contents

📄 path

📊 Analysis Summary

Metric	Count
🔧 Functions	12
📊 Variables & Constants	3

📚 Table of Contents

• Variables & Constants
• Functions

🛠️ File Location:

📂 packages/website-eslint/src/mock/path.js

Variables & Constants

Name	Type	Kind	Value	Exported
splitPathRe	RegExp	let/var	/^(\/?)([\s\S]*?)((?:\.{1,2}\|[^/]+?)?(\.[^./]*\|))\/*$/	✗
sep	"/"	let/var	'/'	✓
delimiter	":"	let/var	':'	✓

---

Functions

resolve(args: any[]): string

Parameters:

• args any[]

Returns: string

Calls:

• path.charAt
• normalizeArray( filter(resolvedPath.split('/'), p => !!p), !resolvedAbsolute, ).join

Internal Comments:

// Skip empty and invalid entries
// At this point the path should be resolved to a full absolute path, but (x3)
// handle relative paths to be safe (might happen when process.cwd() fails) (x3)
// Normalize the path (x3)

Code

export function resolve(...args) {
  let resolvedPath = '';
  let resolvedAbsolute = false;

  for (let i = args.length - 1; i >= -1 && !resolvedAbsolute; i--) {
    const path = i >= 0 ? args[i] : '/';

    // Skip empty and invalid entries
    if (typeof path !== 'string') {
      throw new TypeError('Arguments to path.resolve must be strings');
    } else if (!path) {
      continue;
    }

    resolvedPath = `${path}/${resolvedPath}`;
    resolvedAbsolute = path.charAt(0) === '/';
  }

  // At this point the path should be resolved to a full absolute path, but
  // handle relative paths to be safe (might happen when process.cwd() fails)

  // Normalize the path
  resolvedPath = normalizeArray(
    filter(resolvedPath.split('/'), p => !!p),
    !resolvedAbsolute,
  ).join('/');

  return (resolvedAbsolute ? '/' : '') + resolvedPath || '.';
}

normalize(path: any): string

Parameters:

• path any

Returns: string

Calls:

• isAbsolute
• path.endsWith
• normalizeArray( filter(path.split('/'), p => !!p), !isPathAbsolute, ).join

Internal Comments:

// Normalize the path (x3)

Code

export function normalize(path) {
  const isPathAbsolute = isAbsolute(path);
  const trailingSlash = path.endsWith('/');

  // Normalize the path
  path = normalizeArray(
    filter(path.split('/'), p => !!p),
    !isPathAbsolute,
  ).join('/');

  if (!path && !isPathAbsolute) {
    path = '.';
  }
  if (path && trailingSlash) {
    path += '/';
  }

  return (isPathAbsolute ? '/' : '') + path;
}

isAbsolute(path: any): boolean

Parameters:

• path any

Returns: boolean

Calls:

• path.charAt

Code

export function isAbsolute(path) {
  return path.charAt(0) === '/';
}

join(paths: any[]): string

Parameters:

• paths any[]

Returns: string

Calls:

• normalize
• filter(paths, p => { if (typeof p !== 'string') { throw new TypeError('Arguments to path.join must be strings'); } return p; }).join

Code

export function join(...paths) {
  return normalize(
    filter(paths, p => {
      if (typeof p !== 'string') {
        throw new TypeError('Arguments to path.join must be strings');
      }
      return p;
    }).join('/'),
  );
}

relative(from: any, to: any): string

Parameters:

• from any
• to any

Returns: string

Calls:

• resolve(from).slice
• resolve(to).slice
• arr.slice
• trim
• from.split
• to.split
• Math.min
• [ ...Array(fromParts.length - samePartsLength).fill('..'), ...toParts.slice(samePartsLength), ].join
• Array(fromParts.length - samePartsLength).fill
• toParts.slice

Code

export function relative(from, to) {
  from = resolve(from).slice(1);
  to = resolve(to).slice(1);

  function trim(arr) {
    let start = 0;
    for (; start < arr.length; start++) {
      if (arr[start] !== '') {
        break;
      }
    }

    let end = arr.length - 1;
    for (; end >= 0; end--) {
      if (arr[end] !== '') {
        break;
      }
    }

    if (start > end) {
      return [];
    }
    return arr.slice(start, end - start + 1);
  }

  const fromParts = trim(from.split('/'));
  const toParts = trim(to.split('/'));

  const length = Math.min(fromParts.length, toParts.length);
  let samePartsLength = length;
  for (let i = 0; i < length; i++) {
    if (fromParts[i] !== toParts[i]) {
      samePartsLength = i;
      break;
    }
  }

  return [
    ...Array(fromParts.length - samePartsLength).fill('..'),
    ...toParts.slice(samePartsLength),
  ].join('/');
}

dirname(path: any): string

Parameters:

• path any

Returns: string

Calls:

• splitPath
• dir.slice

Internal Comments:

// No dirname whatsoever
// It has a dirname, strip trailing slash (x3)

Code

export function dirname(path) {
  const result = splitPath(path);
  const root = result[0];
  let dir = result[1];

  if (!root && !dir) {
    // No dirname whatsoever
    return '.';
  }

  if (dir) {
    // It has a dirname, strip trailing slash
    dir = dir.slice(0, -1);
  }

  return root + dir;
}

basename(path: any, ext: any): string

Parameters:

• path any
• ext any

Returns: string

Calls:

• splitPath
• f.slice

Internal Comments:

// TODO: make this comparison case-insensitive on windows?

Code

export function basename(path, ext) {
  let f = splitPath(path)[2];
  // TODO: make this comparison case-insensitive on windows?
  if (ext && f.slice(-1 * ext.length) === ext) {
    f = f.slice(0, f.length - ext.length);
  }
  return f;
}

extname(path: any): string

Parameters:

• path any

Returns: string

Calls:

• splitPath

Code

export function extname(path) {
  return splitPath(path)[3];
}

normalizeArray(parts: any, allowAboveRoot: any): any

Parameters:

• parts any
• allowAboveRoot any

Returns: any

Calls:

• parts.splice
• parts.unshift

Internal Comments:

// if the path tries to go above the root, `up` ends up > 0 (x2)
// if the path is allowed to go above the root, restore leading ..s

Code

function normalizeArray(parts, allowAboveRoot) {
  // if the path tries to go above the root, `up` ends up > 0
  let up = 0;
  for (let i = parts.length - 1; i >= 0; i--) {
    const last = parts[i];
    if (last === '.') {
      parts.splice(i, 1);
    } else if (last === '..') {
      parts.splice(i, 1);
      up++;
    } else if (up) {
      parts.splice(i, 1);
      up--;
    }
  }

  // if the path is allowed to go above the root, restore leading ..s
  if (allowAboveRoot) {
    for (; up--; up) {
      parts.unshift('..');
    }
  }

  return parts;
}

splitPath(filename: any): string[]

Parameters:

• filename any

Returns: string[]

Calls:

• splitPathRe.exec(filename).slice

Code

function (filename) {
  return splitPathRe.exec(filename).slice(1);
}

filter(xs: any, f: any): any

Parameters:

• xs any
• f any

Returns: any

Calls:

• xs.filter
• f
• res.push

Code

function filter(xs, f) {
  if (xs.filter) {
    return xs.filter(f);
  }
  const res = [];
  for (let i = 0; i < xs.length; i++) {
    if (f(xs[i], i, xs)) {
      res.push(xs[i]);
    }
  }
  return res;
}

Internal helpers

Declared inside another function in this file.

trim(arr: any): any

Parameters:

• arr any

Returns: any

Calls:

• arr.slice

Code

function trim(arr) {
    let start = 0;
    for (; start < arr.length; start++) {
      if (arr[start] !== '') {
        break;
      }
    }

    let end = arr.length - 1;
    for (; end >= 0; end--) {
      if (arr[end] !== '') {
        break;
      }
    }

    if (start > end) {
      return [];
    }
    return arr.slice(start, end - start + 1);
  }

---

Generated by Syntax Scribe