Move fs methods to registry package

Author: jdalton

package-lock.json

@@ -111,8 +111,8 @@
     "@socketregistry/is-interactive": "1.0.6",
     "@socketregistry/packageurl-js": "1.0.8",
     "@socketsecurity/config": "3.0.1",
-    "@socketsecurity/registry": "1.0.256",
-    "@socketsecurity/sdk": "1.4.67",
+    "@socketsecurity/registry": "1.0.258",
+    "@socketsecurity/sdk": "1.4.68",
     "@types/blessed": "0.1.25",
     "@types/cmd-shim": "5.0.2",
     "@types/js-yaml": "4.0.9",
@@ -126,7 +126,7 @@
     "@types/which": "3.0.4",
     "@types/yargs-parser": "21.0.3",
     "@typescript-eslint/parser": "8.38.0",
-    "@typescript/native-preview": "7.0.0-dev.20250801.1",
+    "@typescript/native-preview": "7.0.0-dev.20250802.1",
     "@vitest/coverage-v8": "3.2.4",
     "blessed": "0.1.81",
     "blessed-contrib": "4.11.0",

package.json

@@ -11,7 +11,11 @@ import semver from 'semver'
 
 import { PackageURL } from '@socketregistry/packageurl-js'
 import { debugDir, debugFn, isDebug } from '@socketsecurity/registry/lib/debug'
-import { readJson, writeJson } from '@socketsecurity/registry/lib/fs'
+import {
+  readJson,
+  safeStatsSync,
+  writeJson,
+} from '@socketsecurity/registry/lib/fs'
 import { spawn } from '@socketsecurity/registry/lib/spawn'
 import { isNonEmptyString } from '@socketsecurity/registry/lib/strings'
 
@@ -22,7 +26,6 @@ import {
   getSocketPullRequestTitle,
 } from './socket-git.mts'
 import constants from '../../constants.mts'
-import { safeStatsSync } from '../../utils/fs.mts'
 import { getPurlObject } from '../../utils/purl.mts'
 
 import type { SocketArtifact } from '../../utils/alert/artifact.mts'

src/commands/fix/pull-request.mts

@@ -1,10 +1,13 @@
 import { existsSync } from 'node:fs'
 import path from 'node:path'
 
+import {
+  safeReadFileSync,
+  safeStatsSync,
+} from '@socketsecurity/registry/lib/fs'
 import { logger } from '@socketsecurity/registry/lib/logger'
 
 import constants from '../../constants.mts'
-import { safeReadFileSync, safeStatsSync } from '../../utils/fs.mts'
 import { tildify } from '../../utils/tildify.mts'
 
 export async function outputCmdJson(cwd: string) {

src/commands/json/output-cmd-json.mts

@@ -1,8 +1,8 @@
+import { safeReadFile } from '@socketsecurity/registry/lib/fs'
 import { logger } from '@socketsecurity/registry/lib/logger'
 import { spawn } from '@socketsecurity/registry/lib/spawn'
 
 import constants from '../../constants.mts'
-import { safeReadFile } from '../../utils/fs.mts'
 
 export async function convertSbtToMaven({
   bin,

src/commands/manifest/convert_sbt_to_maven.mts

@@ -3,11 +3,11 @@ import path from 'node:path'
 
 import config from '@socketsecurity/config'
 import { debugFn } from '@socketsecurity/registry/lib/debug'
+import { safeReadFileSync } from '@socketsecurity/registry/lib/fs'
 import { logger } from '@socketsecurity/registry/lib/logger'
 import { naturalCompare } from '@socketsecurity/registry/lib/sorts'
 
 import constants from '../constants.mts'
-import { safeReadFileSync } from './fs.mts'
 
 import type { CResult } from '../types.mts'
 

src/utils/config.mts

@@ -1,4 +1,4 @@
-import { existsSync, promises as fs, readFileSync, statSync } from 'node:fs'
+import { promises as fs } from 'node:fs'
 import path from 'node:path'
 
 import { remove } from '@socketsecurity/registry/lib/fs'
@@ -7,19 +7,6 @@ import { pEach } from '@socketsecurity/registry/lib/promises'
 import constants from '../constants.mts'
 import { globNodeModules } from './glob.mts'
 
-import type { Remap } from '@socketsecurity/registry/lib/objects'
-import type { Abortable } from 'node:events'
-import type {
-  BigIntStats,
-  ObjectEncodingOptions,
-  OpenMode,
-  PathLike,
-  PathOrFileDescriptor,
-  StatSyncOptions,
-  Stats,
-} from 'node:fs'
-import type { FileHandle } from 'node:fs/promises'
-
 export async function removeNodeModules(cwd = process.cwd()) {
   const nodeModulesPaths = await globNodeModules(cwd)
   await pEach(
@@ -64,118 +51,3 @@ export async function findUp(
   }
   return undefined
 }
-
-export function isDirectorySync(filepath: string): boolean {
-  return existsSync(filepath) && !!safeStatsSync(filepath)?.isDirectory()
-}
-
-export type ReadFileOptions = Remap<
-  ObjectEncodingOptions &
-    Abortable & {
-      flag?: OpenMode | undefined
-    }
->
-
-export async function readFileBinary(
-  filepath: PathLike | FileHandle,
-  options?: ReadFileOptions | undefined,
-): Promise<Buffer> {
-  return (await fs.readFile(filepath, {
-    // Lazily access constants.abortSignal.
-    signal: constants.abortSignal,
-    ...options,
-    encoding: 'binary',
-  } as ReadFileOptions)) as Buffer
-}
-
-export async function readFileUtf8(
-  filepath: PathLike | FileHandle,
-  options?: ReadFileOptions | undefined,
-): Promise<string> {
-  return await fs.readFile(filepath, {
-    // Lazily access constants.abortSignal.
-    signal: constants.abortSignal,
-    ...options,
-    encoding: 'utf8',
-  })
-}
-
-export async function safeReadFile(
-  filepath: PathLike | FileHandle,
-  options?: 'utf8' | 'utf-8' | { encoding: 'utf8' | 'utf-8' } | undefined,
-): Promise<string | undefined>
-
-export async function safeReadFile(
-  filepath: PathLike | FileHandle,
-  options?: ReadFileOptions | NodeJS.BufferEncoding | undefined,
-): Promise<Awaited<ReturnType<typeof fs.readFile>> | undefined> {
-  try {
-    return await fs.readFile(filepath, {
-      encoding: 'utf8',
-      // Lazily access constants.abortSignal.
-      signal: constants.abortSignal,
-      ...(typeof options === 'string' ? { encoding: options } : options),
-    })
-  } catch {}
-  return undefined
-}
-
-export function safeReadFileSync(
-  filepath: PathOrFileDescriptor,
-  options?: 'utf8' | 'utf-8' | { encoding: 'utf8' | 'utf-8' } | undefined,
-): string | undefined
-
-export function safeReadFileSync(
-  filepath: PathOrFileDescriptor,
-  options?:
-    | {
-        encoding?: NodeJS.BufferEncoding | undefined
-        flag?: string | undefined
-      }
-    | NodeJS.BufferEncoding
-    | undefined,
-): ReturnType<typeof readFileSync> | undefined {
-  try {
-    return readFileSync(filepath, {
-      encoding: 'utf8',
-      ...(typeof options === 'string' ? { encoding: options } : options),
-    })
-  } catch {}
-  return undefined
-}
-
-export function safeStatsSync(
-  filepath: PathLike,
-  options?: undefined,
-): Stats | undefined
-
-export function safeStatsSync(
-  filepath: PathLike,
-  options?: StatSyncOptions & {
-    bigint?: false | undefined
-  },
-): Stats | undefined
-
-export function safeStatsSync(
-  filepath: PathLike,
-  options: StatSyncOptions & {
-    bigint: true
-  },
-): BigIntStats | undefined
-
-export function safeStatsSync(
-  filepath: PathLike,
-  options: StatSyncOptions & {
-    bigint: boolean
-  },
-): Stats | BigIntStats | undefined
-
-export function safeStatsSync(
-  filepath: PathLike,
-  options?: StatSyncOptions,
-): Stats | BigIntStats | undefined {
-  try {
-    return statSync(filepath, { throwIfNoEntry: false, ...options })
-  } catch {}
-  return undefined
-}