util.ts•2.42 kB
import { execSync } from 'child_process'
import fs from 'fs'
import _ from 'lodash'
import { dirname, isAbsolute, resolve } from 'path'
import { fileURLToPath } from 'url'
/** Object.keys() with more accurate types */
export type KeysOf<T> = Array<keyof T>
// From Cursor
const CWD = process.env.WORKSPACE_FOLDER_PATHS || process.cwd()
const util = {
CWD,
// Relative to the project root
REPO: resolve(dirname(fileURLToPath(import.meta.url)), '..'),
/** Resolve a path relative to the project root (avoids __dirname recreation everywhere) */
resolve(path: string, dir = CWD): string {
if (isAbsolute(path)) {
return path
}
return resolve(dir, path)
},
readFile(path: string, def?: string): string {
if (!util.exists(path)) {
if (_.isNil(def)) {
throw new Error(`File not found: ${path}`)
}
return def
}
return fs.readFileSync(path, 'utf-8')
},
writeFile(path: string, content: string): void {
util.mkdirp(dirname(path))
fs.writeFileSync(path, content, 'utf-8')
},
appendNdjson(path: string, ...lines: object[]): void {
util.mkdirp(dirname(path))
const content = lines.map(line => JSON.stringify(line)).join('\n') + '\n'
fs.appendFileSync(path, content, 'utf-8')
},
mkdirp: _.memoize((path: string): void => {
if (!util.exists(path)) {
fs.mkdirSync(path, { recursive: true })
}
}),
ext(path: string): string {
const match = path.match(/\.(\w{2,5})$/)
return match ? match[1] : ''
},
isFile(path: string): boolean {
return !!util.ext(path)
},
exists(path: string): boolean {
return fs.existsSync(path)
},
/** Object.keys() with more accurate types */
keysOf<T extends object>(obj: T): KeysOf<T> {
return Object.keys(obj) as KeysOf<T>
},
trimLines(str: string): string {
return str.replace(/^ +\n?/gm, '').trim()
},
clamp(value: number, min: number, max: number): number {
return Math.max(min, Math.min(value, max))
},
truncate(str: string, maxLength: number, ellipsis = '...'): string {
return str.length > maxLength ? str.slice(0, maxLength) + ellipsis : str
},
execSync,
int,
}
function int(str: string): number | undefined
function int(str: string, def: number): number
function int(str: string, def?: number) {
const num = Number.parseInt(str, 10)
return Number.isNaN(num) ? def : num
}
export default util