globify-gitignore/src/path-utils.ts

Convert Gitignore to Glob patterns

import { promises } from "fs"
const { stat } = promises
import { normalize } from "path"

/**
 * Converts given path to Posix (replacing \ with /)
 *
 * @param {string} givenPath Path to convert
 * @returns {string} Converted filepath
 */
export function posixifyPath(givenPath: string): string {
  return normalize(givenPath).replace(/\\/g, "/")
}

/**
 * Converts given path to Posix (replacing \ with /) and removing ending slashes
 *
 * @param {string} givenPath Path to convert
 * @returns {string} Converted filepath
 */
export function posixifyPathNormalized(givenPath: string): string {
  return posixifyPath(givenPath).replace(/\/$/, "")
}

/** Enum that specifies the path type. 1 for directory, 2 for file, 0 for others */
export enum PATH_TYPE {
  OTHER,
  DIRECTORY,
  FILE,
}

/**
 * Get the type of the given path
 *
 * @param {string} givenPath Absolute path
 * @returns {Promise<PATH_TYPE>}
 */
export async function getPathType(filepath: string): Promise<PATH_TYPE> {
  let pathStat
  try {
    pathStat = await stat(filepath)
  } catch (error) {
    return PATH_TYPE.OTHER
  }
  if (pathStat.isDirectory()) {
    return PATH_TYPE.DIRECTORY
  } else if (pathStat.isFile()) {
    return PATH_TYPE.FILE
  }
  return PATH_TYPE.OTHER
}