@kawalir/extension-node 0.0.0 → 0.2.0

package/CHANGELOG.md

@@ -1 +1 @@
-Initial Publication
+Global Node modules

package/Core/Classes/FileSystem/File.ts

@@ -0,0 +1,9 @@
+import { FileFunctions as FF } from "@kawalir/extension-node/Core/Functions";
+
+export class File {
+  constructor(public path: string) {}
+
+  public testExistence = () => FF.File.testExistence(this.path);
+
+  public delete = () => FF.File.delete(this.path);
+}

package/Core/Classes/FileSystem/Folder.ts

@@ -0,0 +1,19 @@
+import { FileFunctions } from "@kawalir/extension-node/Core/Functions";
+import { TextFile } from "./TextFile";
+
+export class Folder {
+  constructor(public path: string) {}
+
+  public getFile = (name: string) => new TextFile(this.getPath(name));
+
+  public getSubFolder = (relativePath: string) =>
+    new Folder(this.getPath(relativePath));
+
+  public getPath = (relative: string) => Path.join(this.path, relative);
+
+  public ensure = () => FileFunctions.Folder.ensure(this.path);
+
+  public get parent(): Folder {
+    return new Folder(Path.dirname(this.path));
+  }
+}

package/Core/Classes/FileSystem/JsonFile.ts

@@ -0,0 +1,18 @@
+import { TextFile } from "./TextFile";
+import { File } from "./File";
+
+export class JsonFile<T> extends File {
+  private textFile: TextFile;
+  constructor(path: string) {
+    super(path);
+    this.textFile = new TextFile(path);
+  }
+
+  public write = (data: T, pretty: boolean = true) =>
+    this.textFile.write(JSON.stringify(data, null, pretty ? 2 : undefined));
+
+  public readOrNull = (): Nullable<T> =>
+    this.testExistence() ? this.read() : null;
+
+  public read = (): T => JSON.parse(this.textFile.read());
+}

package/Core/Classes/FileSystem/TextFile.ts

@@ -0,0 +1,10 @@
+import { FileFunctions as FF } from "@kawalir/extension-node/Core/Functions";
+import { File } from "./File";
+
+export class TextFile extends File {
+  public write = (content: string) => FF.File.write(this.path, content);
+
+  public readOrNull = (): StringOrNull => FF.File.readOrNull(this.path);
+
+  public read = (): string => FF.File.read(this.path);
+}

package/Core/Classes/FileSystem/index.ts

@@ -0,0 +1,3 @@
+export * from "./Folder";
+export * from "./JsonFile";
+export * from "./TextFile";

package/Core/Classes/index.ts

@@ -0,0 +1 @@
+export * from "./FileSystem";

package/Core/Functions/File/Basic/BasicFunctions.ts

@@ -0,0 +1,8 @@
+import { FileSystem as FS } from "@kawalir/extension-node/External";
+
+export class BasicFunctions {
+  public static testExistence = (
+    path: string,
+    test: (stats: FS.Stats) => boolean,
+  ) => FS.existsSync(path) && test(FS.lstatSync(path));
+}

package/Core/Functions/File/Basic/index.ts

@@ -0,0 +1 @@
+export * from "./BasicFunctions";

package/Core/Functions/File/File/FileFunctions.ts

@@ -0,0 +1,30 @@
+import { Path, FileSystem as FS } from "@kawalir/extension-node/External";
+import { FolderFunctions as FF } from "../Folder";
+import { BasicFunctions as BF } from "../Basic";
+
+type Content = string | NodeJS.ArrayBufferView;
+
+export class FileFunctions {
+  public static rewrite = (path: string, content: Content) => {
+    this.delete(path);
+    this.write(path, content);
+  };
+
+  public static write = (path: string, content: Content) => {
+    FF.ensureContaining(path);
+    FS.writeFileSync(path, content, "utf8");
+  };
+
+  public static delete = (path: string) =>
+    FS.rmSync(path, {
+      force: true,
+    });
+
+  public static readOrNull = (path: string): StringOrNull =>
+    this.testExistence(path) ? this.read(path) : null;
+
+  public static read = (path: string): string => FS.readFileSync(path, "utf-8");
+
+  public static testExistence = (path: string) =>
+    BF.testExistence(path, (e) => e.isFile());
+}

package/Core/Functions/File/File/index.ts

@@ -0,0 +1 @@
+export * from "./FileFunctions";

package/Core/Functions/File/FileFunctions.ts

@@ -0,0 +1,7 @@
+import { FileFunctions as FF } from "./File";
+import { FolderFunctions } from "./Folder";
+
+export class FileFunctions {
+  public static Folder = FolderFunctions;
+  public static File = FF;
+}

package/Core/Functions/File/Folder/FolderFunctions.ts

@@ -0,0 +1,22 @@
+import { BasicFunctions as BF } from "../Basic";
+
+export class FolderFunctions {
+  public static ensureContaining = (path: string) =>
+    this.ensure(Path.dirname(path));
+
+  public static ensure = (path: string) => {
+    if (this.testExistence(path)) {
+      return;
+    }
+    this.create(path);
+  };
+
+  public static create = (path: string) => {
+    FileSystem.mkdirSync(path, {
+      recursive: true,
+    });
+  };
+
+  public static testExistence = (path: string) =>
+    BF.testExistence(path, (stats) => stats.isDirectory());
+}

package/Core/Functions/File/Folder/index.ts

@@ -0,0 +1 @@
+export * from "./FolderFunctions";

package/Core/Functions/File/index.ts

@@ -0,0 +1 @@
+export * from "./FileFunctions";

package/Core/Functions/index.ts

@@ -0,0 +1 @@
+export * from "./File";

package/External/index.ts

@@ -0,0 +1,5 @@
+export * as ReadLine from "readline/promises";
+export * as FileSystem from "fs";
+
+import * as Path from "path";
+export { Path };

package/Global/Classes/GlobalClasses.d.ts

@@ -1,3 +1,14 @@
-declare global {}
+import * as CORE from "@kawalir/extension-node/Core";
+
+declare global {
+  interface TextFile extends CORE.TextFile {}
+  var TextFile: typeof CORE.TextFile;
+
+  interface JsonFile<T> extends CORE.JsonFile<T> {}
+  var JsonFile: typeof CORE.JsonFile;
+
+  interface Folder extends CORE.Folder {}
+  var Folder: typeof CORE.Folder;
+}
 
 export {};

package/Global/Classes/index.ts

@@ -0,0 +1,5 @@
+import * as CORE from "@kawalir/extension-node/Core";
+
+globalThis.TextFile = CORE.TextFile;
+globalThis.JsonFile = CORE.JsonFile;
+globalThis.Folder = CORE.Folder;

package/Global/Modules/GlobalModules.d.ts

@@ -0,0 +1,8 @@
+import * as EXT from "@kawalir/extension-node/External";
+
+declare global {
+  var Path: typeof EXT.Path;
+  var FileSystem: typeof EXT.FileSystem;
+}
+
+export {};

package/Global/Modules/index.ts

@@ -0,0 +1,4 @@
+import * as EXT from "@kawalir/extension-node/External";
+
+globalThis.Path = EXT.Path;
+globalThis.FileSystem = EXT.FileSystem;

package/Global/index.ts

@@ -1,2 +1,3 @@
+import "./Modules";
 import "./Classes";
 import "./Methods";

package/index.d.ts

@@ -1,2 +1,3 @@
 //? [Global]
-/// <reference path="Global/Classes/GlobalClasses.d.ts" />
+/// <reference path="Global/Classes/GlobalClasses.d.ts" />
+/// <reference path="Global/Modules/GlobalModules.d.ts" />

package/index.ts

@@ -1,3 +1,4 @@
-export * from "./Core";
-
+import "@kawalir/extension";
 import "./Global";
+
+export * from "./Core";

package/package.json

@@ -7,16 +7,17 @@
     "Node",
     "Node Extension"
   ],
-  "version": "0.0.0",
+  "version": "0.2.0",
   "author": "Denis Mijatovic",
   "license": "MIT",
   "type": "commonjs",
   "main": "index.ts",
   "types": "index.d.ts",
   "files": [
-    "Structures",
-    "Core",
     "Global",
+    "Core",
+    "Structures",
+    "External",
     "index.ts",
     "index.d.ts",
     "tsconfig.json",
@@ -30,5 +31,11 @@
     "patch": "npm run script Publish patch",
     "script": "cd Scripts && npm start",
     "test": "cd Test && npm start"
+  },
+  "devDependencies": {
+    "@types/node": "^25.3.0"
+  },
+  "dependencies": {
+    "@kawalir/extension": "^0.8.0"
   }
 }

package/tsconfig.json

@@ -9,11 +9,8 @@
     // See also https://aka.ms/tsconfig/module
     "module": "nodenext",
     "target": "esnext",
-    "types": [],
-    // For nodejs:
-    // "lib": ["esnext"],
-    // "types": ["node"],
-    // and npm install -D @types/node
+    "lib": ["esnext"],
+    "types": ["node", "@kawalir/extension"],
 
     // Other Outputs
     "sourceMap": true,
@@ -47,5 +44,5 @@
       "@kawalir/extension-node/*": ["./*"]
     }
   },
-  "include": ["Structures", "Core", "Global"]
+  "include": ["External", "Structures", "Core", "Global"]
 }