@stacksjs/storage 0.38.3

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# Stacks Storage
+
+This package contains the Stacks File System source.
+
+## ☘️ Features
+
+- Easily create your own cloud storage
+- Driver-based architecture
+- Laravel-like Storage API
+- Drop-in Node.js module replacement
+
+## 🤖 Usage
+
+```bash
+pnpm i -D @stacksjs/storage
+```
+
+Now, you can use it in your project:
+
+```js
+import {
+  _dirname,
+  readJsonFile,
+  writeJsonFile,
+  readTextFile,
+  writeTextFile,
+  isFolder,
+  isFile,
+  hasFiles,
+  hasComponents,
+  hasFunctions,
+  copyFolder,
+  deleteFolder,
+  deleteFiles,
+  deleteEmptyFolders,
+  doesFolderExist,
+  fs, // fs-extra Node module
+  fileURLToPath,
+} from '@stacksjs/storage'
+
+// wip
+```
+
+To view the full documentation, please visit [https://stacksjs.dev/storage](https://stacksjs.dev/storage).
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
+
+## 💪🏼 Contributing
+
+Please see [CONTRIBUTING](../../.github/CONTRIBUTING.md) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Open Web Discord Server](https://discord.ow3.org)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+/// <reference types="node" />
+import { fileURLToPath } from 'node:url';
+import type { JsonFile, TextFile } from '@stacksjs/types';
+export declare const _dirname: any;
+/**
+ * Reads a JSON file and returns the parsed data.
+ */
+export declare function readJsonFile(name: string, cwd?: string): Promise<JsonFile>;
+/**
+ * Writes the given data to the specified JSON file.
+ */
+export declare function writeJsonFile(file: JsonFile): Promise<void>;
+/**
+ * Reads a text file and returns its contents.
+ */
+export declare function readTextFile(name: string, cwd?: string): Promise<TextFile>;
+/**
+ * Writes the given text to the specified file.
+ */
+export declare function writeTextFile(file: TextFile): Promise<void>;
+/**
+ * Determine whether a path is a folder.
+ */
+export declare function isFolder(path: string): boolean;
+/**
+ * Determine whether a path is a file.
+ */
+export declare function isFile(path: string): boolean;
+/**
+ * Determine whether a folder has any files in it.
+ */
+export declare function hasFiles(folder: string): boolean;
+export declare function hasComponents(): boolean;
+export declare function hasFunctions(): boolean;
+export declare function copyFolder(src: string, dest: string, exclude?: string[]): void;
+export declare function deleteFolder(path: string): Promise<void>;
+export declare function deleteFiles(dir: string, exclude?: string[]): void;
+export declare function deleteEmptyFolders(dir: string): void;
+export declare function doesFolderExist(path: string): any;
+export declare const filesystem: {
+    _dirname: any;
+    readJsonFile: typeof readJsonFile;
+    writeJsonFile: typeof writeJsonFile;
+    readTextFile: typeof readTextFile;
+    writeTextFile: typeof writeTextFile;
+    isFolder: typeof isFolder;
+    isFile: typeof isFile;
+    hasFiles: typeof hasFiles;
+    hasComponents: typeof hasComponents;
+    hasFunctions: typeof hasFunctions;
+    copyFolder: typeof copyFolder;
+    deleteFolder: typeof deleteFolder;
+    deleteFiles: typeof deleteFiles;
+    deleteEmptyFolders: typeof deleteEmptyFolders;
+    doesFolderExist: typeof doesFolderExist;
+    fs: any;
+    fileURLToPath: typeof fileURLToPath;
+};
+export default filesystem;

package/dist/index.mjs

@@ -0,0 +1,139 @@
+import { fileURLToPath } from "node:url";
+import fs from "fs-extra";
+import detectIndent from "detect-indent";
+import { detectNewline } from "detect-newline";
+import { componentsPath, dirname, functionsPath, join, projectPath } from "@stacksjs/path";
+import { contains } from "@stacksjs/arrays";
+export const _dirname = typeof __dirname !== "undefined" ? __dirname : dirname(fileURLToPath(import.meta.url));
+export async function readJsonFile(name, cwd) {
+  const file = await readTextFile(name, cwd);
+  const data = JSON.parse(file.data);
+  const indent = detectIndent(file.data).indent;
+  const newline = detectNewline(file.data);
+  return { ...file, data, indent, newline };
+}
+export async function writeJsonFile(file) {
+  let json = JSON.stringify(file.data, void 0, file.indent);
+  if (file.newline)
+    json += file.newline;
+  return writeTextFile({ ...file, data: json });
+}
+export function readTextFile(name, cwd) {
+  return new Promise((resolve, reject) => {
+    let filePath;
+    if (cwd)
+      filePath = join(cwd, name);
+    else
+      filePath = name;
+    fs.readFile(filePath, "utf8", (err, text) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve({
+          path: filePath,
+          data: text
+        });
+      }
+    });
+  });
+}
+export function writeTextFile(file) {
+  return new Promise((resolve, reject) => {
+    fs.writeFile(file.path, file.data, (err) => {
+      if (err)
+        reject(err);
+      else
+        resolve();
+    });
+  });
+}
+export function isFolder(path) {
+  try {
+    return fs.statSync(path).isDirectory();
+  } catch {
+    return false;
+  }
+}
+export function isFile(path) {
+  return fs.existsSync(projectPath(path));
+}
+export function hasFiles(folder) {
+  return fs.readdirSync(folder).length > 0;
+}
+export function hasComponents() {
+  return hasFiles(componentsPath());
+}
+export function hasFunctions() {
+  return hasFiles(functionsPath());
+}
+export function copyFolder(src, dest, exclude = []) {
+  if (!fs.existsSync(dest))
+    fs.mkdirSync(dest, { recursive: true });
+  if (fs.existsSync(src)) {
+    fs.readdirSync(src).forEach((file) => {
+      if (!contains(join(src, file), exclude)) {
+        const srcPath = join(src, file);
+        const destPath = join(dest, file);
+        if (fs.statSync(srcPath).isDirectory())
+          copyFolder(srcPath, destPath, exclude);
+        else
+          fs.copyFileSync(srcPath, destPath);
+      }
+    });
+  }
+}
+export async function deleteFolder(path) {
+  if (fs.statSync(path).isDirectory())
+    await fs.rmSync(path, { recursive: true, force: true });
+}
+export function deleteFiles(dir, exclude = []) {
+  if (fs.existsSync(dir)) {
+    fs.readdirSync(dir).forEach((file) => {
+      const p = join(dir, file);
+      if (fs.statSync(p).isDirectory()) {
+        if (fs.readdirSync(p).length === 0)
+          fs.rmSync(p, { recursive: true, force: true });
+        else
+          deleteFiles(p, exclude);
+      } else if (!contains(p, exclude)) {
+        fs.rmSync(p);
+      }
+    });
+  }
+}
+export function deleteEmptyFolders(dir) {
+  if (fs.existsSync(dir)) {
+    fs.readdirSync(dir).forEach((file) => {
+      const p = join(dir, file);
+      if (fs.statSync(p).isDirectory()) {
+        if (fs.readdirSync(p).length === 0)
+          fs.rmSync(p, { recursive: true, force: true });
+        else
+          deleteEmptyFolders(p);
+      }
+    });
+  }
+}
+export function doesFolderExist(path) {
+  return fs.existsSync(path);
+}
+export const filesystem = {
+  _dirname,
+  readJsonFile,
+  writeJsonFile,
+  readTextFile,
+  writeTextFile,
+  isFolder,
+  isFile,
+  hasFiles,
+  hasComponents,
+  hasFunctions,
+  copyFolder,
+  deleteFolder,
+  deleteFiles,
+  deleteEmptyFolders,
+  doesFolderExist,
+  fs,
+  fileURLToPath
+};
+export default filesystem;

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@stacksjs/storage",
+  "type": "module",
+  "version": "0.38.3",
+  "packageManager": "pnpm@7.15.0",
+  "description": "The Stacks file system.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/storage#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/storage"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "storage",
+    "fs",
+    "file system",
+    "api",
+    "collections",
+    "utilities",
+    "functions",
+    "stacks"
+  ],
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=v18.12.1",
+    "pnpm": ">=7.15.0"
+  },
+  "peerDependencies": {
+    "@stacksjs/arrays": "0.38.3",
+    "@stacksjs/types": "0.38.3",
+    "@stacksjs/utils": "0.38.3",
+    "fs-extra": "^10.1.0"
+  },
+  "devDependencies": {
+    "@stacksjs/path": "0.38.3",
+    "mkdist": "^0.4.0",
+    "typescript": "^4.8.4",
+    "unstorage": "^0.6.0"
+  },
+  "scripts": {
+    "build": "mkdist -d",
+    "dev": "mkdist -d",
+    "typecheck": "tsc --noEmit"
+  }
+}