@fullstackunicorn/filesystem 1.0.0

package/index.js

@@ -0,0 +1,65 @@
+import * as fsSync from 'fs'
+import * as fsAsync from 'fs/promises'
+import { constants } from 'fs'
+
+export const fss = {
+    exists: (...args) => fsSync.existsSync(...args),
+    readFile: (...args) => fss.exists(...args) ? fsSync.readFileSync(...args) : null,
+    readText: (path) => fss.exists(path) ? fsSync.readFileSync(path, 'utf8') : null,
+    readJSON: (...args) => {
+        try { return fss.exists(...args) ? JSON.parse(fsSync.readFileSync(...args), 'utf8') : {} }
+        catch { return {} }
+    },
+    writeJSON: (path, json) => fsSync.writeFileSync(path, JSON.stringify(json, null, 2)),
+    readDir: (...args) => fss.exists(...args) ? fsSync.readdirSync(...args) : [],
+    readDirVisible: (path) => (
+        fss.readDir(path, { withFileTypes: true }) || []
+    ).filter(e => e.isDirectory() && !e.name.startsWith('.')).map(e => e.name),
+    isDir: (path) => {
+        try { return fsSync.statSync(path).isDirectory() }
+        catch { return false }
+    },
+    ensureDir: (path) => { if (!fss.exists(path)) fsSync.mkdirSync(path, { recursive: true }) },
+    writeText: (path, text) => fsSync.writeFileSync(path, text),
+    listFiles: (path, ext = null) => fss.readDir(path).filter(f => !ext || f.endsWith(ext)),
+    safeUnlink: (path) => { if (fss.exists(path)) fsSync.unlinkSync(path) },
+    safeRemove: (path) => { if (fss.exists(path)) fsSync.rmSync(path, { recursive: true, force: true }) },
+    copyFile: fsSync.copyFileSync,
+    remove: fsSync.rmSync,
+    writeDir: fsSync.mkdirSync,
+    unlink: fsSync.unlinkSync,
+    stat: fsSync.statSync,
+    writeFile: fsSync.writeFileSync
+}
+
+export const fsa = {
+    exists: async (path) => {
+        try { await fsAsync.access(path, constants.F_OK); return true }
+        catch { return false }
+    },
+    readFile: async (path) => await fsa.exists(path) ? await fsAsync.readFile(path) : null,
+    readText: async (path) => await fsa.exists(path) ? await fsAsync.readFile(path, 'utf8') : null,
+    readJSON: async (path) => {
+        try { return await fsa.exists(path) ? JSON.parse(await fsAsync.readFile(path, 'utf8')) : {} }
+        catch { return {} }
+    },
+    writeJSON: async (path, json) => await fsAsync.writeFile(path, JSON.stringify(json, null, 2)),
+    readDir: async (path, opts) => await fsa.exists(path) ? await fsAsync.readdir(path, opts) : [],
+    readDirVisible: async (path) => (await fsa.readDir(path, { withFileTypes: true }))
+        .filter(e => e.isDirectory() && !e.name.startsWith('.')).map(e => e.name),
+    isDir: async (path) => {
+        try { return (await fsAsync.stat(path)).isDirectory() }
+        catch { return false }
+    },
+    ensureDir: async (path) => { if (!await fsa.exists(path)) await fsAsync.mkdir(path, { recursive: true }) },
+    writeText: async (path, text) => await fsAsync.writeFile(path, text),
+    listFiles: async (path, ext = null) => (await fsa.readDir(path)).filter(f => !ext || f.endsWith(ext)),
+    safeUnlink: async (path) => { if (await fsa.exists(path)) await fsAsync.unlink(path) },
+    safeRemove: async (path) => { if (await fsa.exists(path)) await fsAsync.rm(path, { recursive: true, force: true }) },
+    copyFile: fsAsync.copyFile,
+    remove: fsAsync.rm,
+    writeDir: fsAsync.mkdir,
+    unlink: fsAsync.unlink,
+    stat: fsAsync.stat,
+    writeFile: fsAsync.writeFile
+}

package/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "@fullstackunicorn/filesystem",
+    "author": "lucanigido[](https://fullstackunicorn.dev/author/lucanigido)",
+    "version": "1.0.0",
+    "main": "index.js",
+    "type": "module",
+    "license": "MIT",
+    "private": false,
+    "description": "A simple sync/async file system wrapper for Node.js",
+    "keywords": ["filesystem", "fs", "node", "sync", "async"],
+    "repository": {
+        "type": "git",
+        "url": "https://gitlab.com/fullstackunicorn/filesystem.git"
+    },
+    "files": [
+        "index.js"
+    ],
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+    }
+}