Add function to get full path from filesystem adapter (#35)

* add function to get the full path

* check for same adapter by default

* add documentaton

* update version

Author: CordlessWool

adapters/in-memory/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@loom-io/in-memory-adapter",
-	"version": "0.12.1",
+	"version": "0.12.2",
 	"main": "dist/exports/lib.js",
 	"types": "dist/exports/lib.d.ts",
 	"author": "Cotton Coding",

adapters/minio/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@loom-io/minio-s3-adapter",
-	"version": "0.12.1",
+	"version": "0.12.2",
 	"main": "dist/exports/lib.js",
 	"types": "dist/exports/lib.d.ts",
 	"author": "Cotton Coding",

adapters/node-fs/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@loom-io/node-filesystem-adapter",
-	"version": "0.12.1",
+	"version": "0.12.2",
 	"main": "dist/exports/lib.js",
 	"types": "dist/exports/lib.d.ts",
 	"author": "Cotton Coding",

adapters/node-fs/src/exports/lib.spec.ts

@@ -0,0 +1,59 @@
+import { describe, test, expect } from "vitest";
+import { FilesystemAdapter } from "./lib";
+
+describe("FilesystemAdapter", () => {
+	test("should be able to create a new instance", () => {
+		const adapter = new FilesystemAdapter();
+		expect(adapter).toBeDefined();
+	});
+
+	test("fullPath should return the full path of a file", () => {
+		const adapter = new FilesystemAdapter("/root/dir");
+		const file = adapter.file("file.txt");
+		expect(adapter.getFullPath(file)).toBe("/root/dir/file.txt");
+	});
+
+	test("fullPath should return the full path of a directory", () => {
+		const adapter = new FilesystemAdapter("/etc/loom");
+		const dir = adapter.dir("dir");
+		expect(adapter.getFullPath(dir)).toBe("/etc/loom/dir");
+	});
+
+	test("fullPath should fail to other adapters", () => {
+		const adapter = new FilesystemAdapter("/etc/loom");
+		const adapter2 = new FilesystemAdapter("/etc/loom");
+		const dir2 = adapter2.dir("dir");
+		expect(() => adapter.getFullPath(dir2)).toThrowError();
+	});
+
+	test("fullPath should return the full path also from other adapter if flag is set", () => {
+		const adapter = new FilesystemAdapter("/etc/loom");
+		const adapter2 = new FilesystemAdapter("/etc/loom");
+		const dir2 = adapter2.dir("dir");
+		expect(adapter.getFullPath(dir2, true)).toBe("/etc/loom/dir");
+	});
+
+	test("fullPath should return the full path of a file (cwd)", () => {
+		const adapter = new FilesystemAdapter();
+		const file = adapter.file("file.txt");
+		expect(adapter.getFullPath(file)).toBe(process.cwd() + "/file.txt");
+	});
+
+	test("fullPath should return the full path of a directory (cwd)", () => {
+		const adapter = new FilesystemAdapter();
+		const dir = adapter.dir("dir");
+		expect(adapter.getFullPath(dir)).toBe(process.cwd() + "/dir");
+	});
+
+	test("file should return a new LoomFile instance", () => {
+		const adapter = new FilesystemAdapter();
+		const file = adapter.file("file.txt");
+		expect(file).toBeDefined();
+	});
+
+	test("dir should return a new Directory instance", () => {
+		const adapter = new FilesystemAdapter();
+		const dir = adapter.dir("dir");
+		expect(dir).toBeDefined();
+	});
+});

adapters/node-fs/src/exports/lib.ts

@@ -1,12 +1,16 @@
-import { PathLike } from 'node:fs';
-import { type LoomSourceAdapter } from '@loom-io/core';
-import { Adapter } from '../core/adapter.js';
-import { dirname, basename } from 'node:path';
-import { Directory, LoomFile } from '@loom-io/core/internal';
+import { PathLike } from "node:fs";
+import { type LoomSourceAdapter } from "@loom-io/core";
+import { Adapter } from "../core/adapter.js";
+import { dirname, basename } from "node:path";
+import { Directory, LoomFile } from "@loom-io/core/internal";
+
+import { resolve } from "node:path";
 
 export class FilesystemAdapter implements LoomSourceAdapter {
 	protected adapter: Adapter;
+	protected rootdir: PathLike;
 	constructor(rootdir: PathLike = process.cwd()) {
+		this.rootdir = rootdir;
 		this.adapter = new Adapter(rootdir);
 	}
 	file(path: string): LoomFile {
@@ -16,4 +20,11 @@ export class FilesystemAdapter implements LoomSourceAdapter {
 	dir(path: string): Directory {
 		return new Directory(this.adapter, path);
 	}
-}
+
+	getFullPath(dirOrFile: Directory | LoomFile, ignoreAdapter = false) {
+		if (!ignoreAdapter && this.adapter !== dirOrFile.adapter) {
+			throw new Error("The directory or file does not belong to this adapter");
+		}
+		return resolve(this.rootdir.toString(), dirOrFile.path);
+	}
+}

documentation/adapter/node-filesystem-adapter.md

@@ -33,3 +33,12 @@ const project = new FilesystemAdapter();
 const rootDir = root.dir("/");
 const projectDir = project("/");
 ```
+
+
+## Additional functionality
+
+### getFullPath
+
+By default, the root of each file is set to the current working directory or the specified installation path, and the path returned by the directory of the file object is a relative path to that directory. If the full path is needed, it can be generated by calling `adapter.getFullPath(dirOrFileObject)`. By default this function checks if it is from the same adapter and throws an error if not. Set the second param of the function to `true` to not check the adapter and ignore the path if it probably does not exist.
+
+

packages/combined-converter/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@loom-io/converter",
-	"version": "0.12.1",
+	"version": "0.12.2",
 	"main": "dist/exports/lib.js",
 	"types": "dist/exports/lib.d.ts",
 	"author": "Cotton Coding",

packages/core/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@loom-io/core",
-	"version": "0.12.1",
+	"version": "0.12.2",
 	"main": "dist/exports/lib.js",
 	"types": "dist/exports/lib.d.ts",
 	"author": "Cotton Coding",

plugins/front-matter-converter/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@loom-io/front-matter-converter",
-	"version": "0.12.1",
+	"version": "0.12.2",
 	"description": "Convert front matter yaml and json into json with loom-io",
 	"main": "dist/exports/lib.js",
 	"type": "module",

plugins/json-converter/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@loom-io/json-converter",
-	"version": "0.12.1",
+	"version": "0.12.2",
 	"description": "A plugin for @loom-io to convert json files to JSON",
 	"main": "dist/json-converter.js",
 	"module": "dist/json-converter.js",