extra-filesystem 0.5.0 → 0.5.1

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "extra-filesystem",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "",
   "keywords": [],
   "files": [
-    "lib"
+    "lib",
+    "src"
   ],
   "type": "module",
   "main": "lib/index.js",

package/src/checksum-file.ts

@@ -0,0 +1,14 @@
+import crypto from 'crypto'
+import fs from 'fs'
+
+export async function checksumFile(
+  algorithm: string
+, filename: string
+): Promise<string> {
+  const hash = crypto.createHash(algorithm)
+  const stream = fs.createReadStream(filename)
+  for await (const chunk of stream) {
+    hash.update(chunk)
+  }
+  return hash.digest('hex')
+}

package/src/copy-sync.ts

@@ -0,0 +1,7 @@
+import fs from 'fs-extra'
+
+export function copySync(sourcePath: string, destinationPath: string): void {
+  fs.copySync(sourcePath, destinationPath, {
+    overwrite: true
+  })
+}

package/src/copy.ts

@@ -0,0 +1,10 @@
+import fs from 'fs-extra'
+
+export async function copy(
+  sourcePath: string
+, destinationPath: string
+): Promise<void> {
+  await fs.copy(sourcePath, destinationPath, {
+    overwrite: true
+  })
+}

package/src/create-temp-dir-sync.ts

@@ -0,0 +1,8 @@
+import { ensureDirSync } from './ensure-dir-sync.js'
+import { createTempNameSync } from './create-temp-name-sync.js'
+
+export function createTempDirSync(): string {
+  const dirname = createTempNameSync()
+  ensureDirSync(dirname)
+  return dirname
+}

package/src/create-temp-dir.ts

@@ -0,0 +1,8 @@
+import { ensureDir } from './ensure-dir.js'
+import { createTempName } from './create-temp-name.js'
+
+export async function createTempDir(): Promise<string> {
+  const dirname = await createTempName()
+  await ensureDir(dirname)
+  return dirname
+}

package/src/create-temp-file-sync.ts

@@ -0,0 +1,8 @@
+import { ensureFileSync } from './ensure-file-sync.js'
+import { createTempNameSync } from './create-temp-name-sync.js'
+
+export function createTempFileSync(): string {
+  const filename = createTempNameSync()
+  ensureFileSync(filename)
+  return filename
+}

package/src/create-temp-file.ts

@@ -0,0 +1,8 @@
+import { ensureFile } from './ensure-file.js'
+import { createTempName } from './create-temp-name.js'
+
+export async function createTempFile(): Promise<string> {
+  const filename = await createTempName()
+  await ensureFile(filename)
+  return filename
+}

package/src/create-temp-name-sync.ts

@@ -0,0 +1,5 @@
+import { tmpNameSync } from 'tmp-promise'
+
+export function createTempNameSync(): string {
+  return tmpNameSync()
+}

package/src/create-temp-name.ts

@@ -0,0 +1,5 @@
+import { tmpName } from 'tmp-promise'
+
+export async function createTempName(): Promise<string> {
+  return await tmpName()
+}

package/src/empty-dir-sync.ts

@@ -0,0 +1,8 @@
+import fs from 'fs'
+import { removeSync } from './remove-sync.js'
+import path from 'path'
+
+export function emptyDirSync(dirname: string): void {
+  const names = fs.readdirSync(dirname)
+  names.forEach(name => removeSync(path.join(dirname, name)))
+}

package/src/empty-dir.ts

@@ -0,0 +1,9 @@
+import fs from 'fs/promises'
+import { remove } from './remove.js'
+import { each } from 'extra-promise'
+import path from 'path'
+
+export async function emptyDir(dirname: string): Promise<void> {
+  const names = await fs.readdir(dirname)
+  await each(names, name => remove(path.join(dirname, name)))
+}

package/src/ensure-dir-sync.ts

@@ -0,0 +1,5 @@
+import fs from 'fs'
+
+export function ensureDirSync(dirname: string): void {
+  fs.mkdirSync(dirname, { recursive: true })
+}

package/src/ensure-dir.ts

@@ -0,0 +1,5 @@
+import fs from 'fs/promises'
+
+export async function ensureDir(dirname: string): Promise<void> {
+  await fs.mkdir(dirname, { recursive: true })
+}

package/src/ensure-file-sync.ts

@@ -0,0 +1,14 @@
+import { ensureDirSync } from './ensure-dir-sync.js'
+import path from 'path'
+import fs from 'fs'
+import { pass } from '@blackglory/prelude'
+
+export function ensureFileSync(filename: string): void {
+  const dir = path.dirname(filename)
+  ensureDirSync(dir)
+  try {
+    fs.closeSync(fs.openSync(filename, 'wx'))
+  } catch {
+    pass()
+  }
+}

package/src/ensure-file.ts

@@ -0,0 +1,15 @@
+import { ensureDir } from './ensure-dir.js'
+import path from 'path'
+import fs from 'fs/promises'
+import { pass } from '@blackglory/prelude'
+
+export async function ensureFile(filename: string): Promise<void> {
+  const dir = path.dirname(filename)
+  await ensureDir(dir)
+  try {
+    const handle = await fs.open(filename, 'wx')
+    await handle.close()
+  } catch {
+    pass()
+  }
+}

package/src/find-all-dirnames.ts

@@ -0,0 +1,22 @@
+import fs from 'fs/promises'
+import path from 'path'
+
+export async function* findAllDirnames(
+  dirname: string
+, predicate: (dirname: string) => boolean = _ => true
+): AsyncIterableIterator<string> {
+  const subDirnames = await getSubDirnames(dirname)
+  for (const dirname of subDirnames) {
+    if (predicate(dirname)) {
+      yield dirname
+      yield* findAllDirnames(dirname, predicate)
+    }
+  }
+}
+
+async function getSubDirnames(dirname: string): Promise<string[]> {
+  const dirents = await fs.readdir(dirname, { withFileTypes: true })
+  return dirents
+    .filter(x => x.isDirectory())
+    .map(x => path.join(dirname, x.name))
+}

package/src/find-all-filenames.ts

@@ -0,0 +1,20 @@
+import fs from 'fs/promises'
+import path from 'path'
+
+export async function* findAllFilenames(
+  dirname: string
+, predicate: (dirname: string) => boolean = _ => true
+): AsyncIterableIterator<string> {
+  const dirents = await fs.readdir(dirname, { withFileTypes: true })
+  for (const dirent of dirents) {
+    if (dirent.isDirectory()) {
+      const subDirname = path.join(dirname, dirent.name)
+      if (predicate(subDirname)) {
+        yield* findAllFilenames(subDirname, predicate)
+      }
+    } else {
+      const filename = path.join(dirname, dirent.name)
+      yield filename
+    }
+  }
+}

package/src/find-up-package-filename-sync.ts

@@ -0,0 +1,14 @@
+import path from 'path'
+import { pathExistsSync } from './path-exists-sync.js'
+
+export function findUpPackageFilenameSync(pathname: string): string | undefined {
+  pathname = path.resolve(pathname)
+  while (true) {
+    const filename = path.resolve(pathname, 'package.json')
+    if (pathExistsSync(filename)) return filename
+
+    const newpathname = path.resolve(pathname, '..')
+    if (newpathname === pathname) return
+    pathname = newpathname
+  }
+}

package/src/find-up-package-filename.ts

@@ -0,0 +1,14 @@
+import path from 'path'
+import { pathExists } from './path-exists.js'
+
+export async function findUpPackageFilename(pathname: string): Promise<string | undefined> {
+  pathname = path.resolve(pathname)
+  while (true) {
+    const filename = path.resolve(pathname, 'package.json')
+    if (await pathExists(filename)) return filename
+
+    const newpathname = path.resolve(pathname, '..')
+    if (newpathname === pathname) return
+    pathname = newpathname
+  }
+}

package/src/get-long-extension.ts

@@ -0,0 +1,13 @@
+import path from 'path'
+
+export function getLongExtension(filename: string): string {
+  let result = ''
+  let remainder = filename
+  while (true) {
+    const extension = path.extname(remainder)
+    if (!extension) break
+    remainder = path.basename(remainder, extension)
+    result = extension + result
+  }
+  return result
+}

package/src/get-short-basename.ts

@@ -0,0 +1,6 @@
+import path from 'path'
+import { getLongExtension } from './get-long-extension.js'
+
+export function getShortBasename(filename: string): string {
+  return path.basename(filename, getLongExtension(filename))
+}

package/src/index.ts

@@ -0,0 +1,47 @@
+export * from './create-temp-dir.js'
+export * from './create-temp-dir-sync.js'
+export * from './create-temp-file.js'
+export * from './create-temp-file-sync.js'
+export * from './create-temp-name.js'
+export * from './create-temp-name-sync.js'
+export * from './empty-dir.js'
+export * from './empty-dir-sync.js'
+export * from './ensure-dir.js'
+export * from './ensure-dir-sync.js'
+export * from './ensure-file.js'
+export * from './ensure-file-sync.js'
+export * from './path-exists.js'
+export * from './path-exists-sync.js'
+export * from './read-ndjson-file.js'
+export * from './read-ndjson-file-sync.js'
+export * from './read-json-file.js'
+export * from './read-json-file-sync.js'
+export * from './read-yaml-file.js'
+export * from './read-yaml-file-sync.js'
+export * from './write-json-file.js'
+export * from './write-json-file-sync.js'
+export * from './write-yaml-file.js'
+export * from './write-yaml-file-sync.js'
+export * from './write-iterable-to-file.js'
+export * from './read-file-line-by-line.js'
+export * from './read-file-line-by-line-sync.js'
+export * from './move.js'
+export * from './move-sync.js'
+export * from './copy.js'
+export * from './copy-sync.js'
+export * from './remove.js'
+export * from './remove-sync.js'
+export * from './find-all-filenames.js'
+export * from './find-all-dirnames.js'
+export * from './get-long-extension.js'
+export * from './get-short-basename.js'
+export * from './is-directory.js'
+export * from './is-directory-sync.js'
+export * from './is-file.js'
+export * from './is-file-sync.js'
+export * from './is-readable.js'
+export * from './is-writable.js'
+export * from './is-sub-path-of.js'
+export * from './checksum-file.js'
+export * from './find-up-package-filename.js'
+export * from './find-up-package-filename-sync.js'

package/src/is-directory-sync.ts

@@ -0,0 +1,6 @@
+import fs from 'fs'
+
+export function isDirectorySync(path: string): boolean {
+  const stat = fs.statSync(path)
+  return stat.isDirectory()
+}

package/src/is-directory.ts

@@ -0,0 +1,6 @@
+import fs from 'fs/promises'
+
+export async function isDirectory(path: string): Promise<boolean> {
+  const stat = await fs.stat(path)
+  return stat.isDirectory()
+}

package/src/is-file-sync.ts

@@ -0,0 +1,6 @@
+import fs from 'fs'
+
+export function isFileSync(path: string): boolean {
+  const stat = fs.statSync(path)
+  return stat.isFile()
+}

package/src/is-file.ts

@@ -0,0 +1,6 @@
+import fs from 'fs/promises'
+
+export async function isFile(path: string): Promise<boolean> {
+  const stat = await fs.stat(path)
+  return stat.isFile()
+}

package/src/is-readable.ts

@@ -0,0 +1,11 @@
+import fs from 'fs/promises'
+import { constants } from 'fs'
+
+export async function isReadable(path: string): Promise<boolean> {
+  try {
+    await fs.access(path, constants.R_OK)
+    return true
+  } catch {
+    return false
+  }
+}

package/src/is-sub-path-of.ts

@@ -0,0 +1,9 @@
+import path from 'path'
+
+// Source: https://stackoverflow.com/a/45242825/5462167
+export function isSubPathOf(subject: string, object: string): boolean {
+  const relative = path.relative(object, subject)
+  return relative !== ''
+      && !relative.startsWith('..')
+      && !path.isAbsolute(relative)
+}

package/src/is-writable.ts

@@ -0,0 +1,11 @@
+import fs from 'fs/promises'
+import { constants } from 'fs'
+
+export async function isWritable(path: string): Promise<boolean> {
+  try {
+    await fs.access(path, constants.W_OK)
+    return true
+  } catch {
+    return false
+  }
+}

package/src/move-sync.ts

@@ -0,0 +1,7 @@
+import fs from 'fs-extra'
+
+export function moveSync(oldPath: string, newPath: string): void {
+  fs.moveSync(oldPath, newPath, {
+    overwrite: true
+  })
+}

package/src/move.ts

@@ -0,0 +1,7 @@
+import fs from 'fs-extra'
+
+export async function move(oldPath: string, newPath: string): Promise<void> {
+  await fs.move(oldPath, newPath, {
+    overwrite: true
+  })
+}

package/src/path-exists-sync.ts

@@ -0,0 +1,13 @@
+import fs from 'fs'
+
+/**
+ * Note: Combining pathExists with other fs functions will introduce race conditions.
+ */
+export function pathExistsSync(path: string): boolean {
+  try {
+    fs.accessSync(path)
+    return true
+  } catch {
+    return false
+  }
+}

package/src/path-exists.ts

@@ -0,0 +1,13 @@
+import fs from 'fs/promises'
+
+/**
+ * Note: Combining pathExists with other fs functions will introduce race conditions.
+ */
+export async function pathExists(path: string): Promise<boolean> {
+  try {
+    await fs.access(path)
+    return true
+  } catch {
+    return false
+  }
+}

package/src/read-file-line-by-line-sync.ts

@@ -0,0 +1,25 @@
+import fs from 'fs'
+
+export function* readFileLineByLineSync(
+  filename: string
+, encoding: BufferEncoding = 'utf-8'
+): IterableIterator<string> {
+  const fd = fs.openSync(filename, 'r')
+  const bufferSize = 1024 * 64
+  const buffer = Buffer.alloc(bufferSize)
+
+  let bytesRead: number
+  let remainingLine = ''
+  while ((bytesRead = fs.readSync(fd, buffer, 0, bufferSize, null)) !== 0) {
+    const str = buffer.toString(encoding, 0, bytesRead)
+    const lines = str.split(/\r?\n/)
+    lines[0] = remainingLine + lines[0]
+    while (lines.length > 1) {
+      yield lines.shift()!
+    }
+    remainingLine = lines.shift()!
+  }
+  if (remainingLine) yield remainingLine
+
+  fs.closeSync(fd)
+}

package/src/read-file-line-by-line.ts

@@ -0,0 +1,14 @@
+import fs from 'fs'
+import readline from 'readline'
+
+export function readFileLineByLine(
+  filename: string
+, encoding: BufferEncoding = 'utf-8'
+): AsyncIterable<string> {
+  const fileStream = fs.createReadStream(filename, { encoding })
+
+  return readline.createInterface({
+    input: fileStream
+  , crlfDelay: Infinity
+  })
+}

package/src/read-json-file-sync.ts

@@ -0,0 +1,9 @@
+import fs from 'fs'
+
+export function readJSONFileSync<T>(
+  filename: string
+, encoding: BufferEncoding = 'utf-8'
+): T {
+  const text = fs.readFileSync(filename, encoding)
+  return JSON.parse(text)
+}

package/src/read-json-file.ts

@@ -0,0 +1,9 @@
+import fs from 'fs/promises'
+
+export async function readJSONFile<T>(
+  filename: string
+, encoding: BufferEncoding = 'utf-8'
+): Promise<T> {
+  const text = await fs.readFile(filename, encoding)
+  return JSON.parse(text)
+}

package/src/read-ndjson-file-sync.ts

@@ -0,0 +1,14 @@
+import { filter, map } from 'iterable-operator'
+import { readFileLineByLineSync } from './read-file-line-by-line-sync.js'
+import { pipe } from 'extra-utils'
+
+export function readNDJSONFileSync<T>(
+  filename: string
+, encoding: BufferEncoding = 'utf-8'
+): IterableIterator<T> {
+  return pipe(
+    readFileLineByLineSync(filename, encoding)
+  , iter => filter(iter, line => line.trim() !== '')
+  , iter => map(iter, line => JSON.parse(line))
+  )
+}

package/src/read-ndjson-file.ts

@@ -0,0 +1,14 @@
+import { filterAsync, mapAsync } from 'iterable-operator'
+import { readFileLineByLine } from './read-file-line-by-line.js'
+import { pipe } from 'extra-utils'
+
+export function readNDJSONFile<T>(
+  filename: string
+, encoding: BufferEncoding = 'utf-8'
+): AsyncIterableIterator<T> {
+  return pipe(
+    readFileLineByLine(filename, encoding)
+  , iter => filterAsync(iter, line => line.trim() !== '')
+  , iter => mapAsync(iter, line => JSON.parse(line))
+  )
+}

package/src/read-yaml-file-sync.ts

@@ -0,0 +1,11 @@
+import fs from 'fs'
+import YAML from 'js-yaml'
+
+export function readYAMLFileSync<T>(
+  filename: string
+, encoding: BufferEncoding = 'utf-8'
+): T {
+  const text = fs.readFileSync(filename, encoding)
+  const data = YAML.load(text)
+  return data as T
+}

package/src/read-yaml-file.ts

@@ -0,0 +1,11 @@
+import fs from 'fs/promises'
+import YAML from 'js-yaml'
+
+export async function readYAMLFile<T>(
+  filename: string
+, encoding: BufferEncoding = 'utf-8'
+): Promise<T> {
+  const text = await fs.readFile(filename, encoding)
+  const data = YAML.load(text)
+  return data as T
+}

package/src/remove-sync.ts

@@ -0,0 +1,5 @@
+import fs from 'fs'
+
+export function removeSync(path: string): void {
+  fs.rmSync(path, { recursive: true, force: true })
+}

package/src/remove.ts

@@ -0,0 +1,5 @@
+import fs from 'fs/promises'
+
+export async function remove(path: string): Promise<void> {
+  await fs.rm(path, { recursive: true, force: true })
+}

package/src/write-iterable-to-file.ts

@@ -0,0 +1,12 @@
+import fs from 'fs'
+import stream from 'stream'
+import { pipeline } from 'stream/promises'
+
+export async function writeIterableToFile(
+  filename: string
+, iterable: Iterable<string> | AsyncIterable<string>
+): Promise<void> {
+  const readStream = stream.Readable.from(iterable)
+  const writeStream = fs.createWriteStream(filename)
+  await pipeline(readStream, writeStream)
+}

package/src/write-json-file-sync.ts

@@ -0,0 +1,10 @@
+import fs from 'fs'
+
+export function writeJSONFileSync(
+  filename: string
+, data: unknown
+, options: { spaces?: number } = {}
+): void {
+  const text = JSON.stringify(data, undefined, options.spaces)
+  fs.writeFileSync(filename, text, 'utf-8')
+}

package/src/write-json-file.ts

@@ -0,0 +1,10 @@
+import fs from 'fs/promises'
+
+export async function writeJSONFile(
+  filename: string
+, data: unknown
+, options: { spaces?: number } = {}
+): Promise<void> {
+  const text = JSON.stringify(data, undefined, options.spaces)
+  await fs.writeFile(filename, text, 'utf-8')
+}

package/src/write-yaml-file-sync.ts

@@ -0,0 +1,7 @@
+import fs from 'fs'
+import YAML from 'js-yaml'
+
+export function writeYAMLFileSync(filename: string, data: unknown): void {
+  const text = YAML.dump(data)
+  fs.writeFileSync(filename, text, 'utf-8')
+}

package/src/write-yaml-file.ts

@@ -0,0 +1,7 @@
+import fs from 'fs/promises'
+import YAML from 'js-yaml'
+
+export async function writeYAMLFile(filename: string, data: unknown): Promise<void> {
+  const text = YAML.dump(data)
+  await fs.writeFile(filename, text, 'utf-8')
+}