Add Symbol functions

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18, 20]
+        node-version: [18, 20, 21]
     steps:
       - uses: actions/checkout@v4
       - name: pnpm-setup

package.json

@@ -22,14 +22,13 @@
 	],
 	"devDependencies": {
 		"@faker-js/faker": "^8.4.1",
-		"@types/node": "^20.11.30",
+		"@types/node": "^20.12.7",
 		"@typescript-eslint/eslint-plugin": "latest",
 		"@typescript-eslint/parser": "latest",
-		"@vitest/coverage-v8": "^1.4.0",
-		"eslint": "^8.57.0",
+		"@vitest/coverage-v8": "^1.5.0",
 		"publint": "^0.2.7",
-		"typescript": "^5.4.3",
-		"vitest": "^1.4.0"
+		"typescript": "^5.4.5",
+		"vitest": "^1.5.0"
 	},
 	"repository": {
 		"type": "git",

packages/core/src/core/dir.spec.ts

@@ -203,4 +203,19 @@ describe('Test Directory Service', () => {
 
 
 	});
+
+	describe('test symbols', () => {
+		test('toPrimitive', () => {
+			const dir = new Directory(adapter, '/test/data');
+			expect(`${dir}`).toBe('/test/data');
+			expect(dir + '').toBe('/test/data');
+			expect(String(dir)).toBe('/test/data');
+			expect(+dir).toBeNaN();
+		});
+
+		test('toStringTag', () => {
+			const dir = new Directory(adapter, '/test/data');
+			expect(Object.prototype.toString.call(dir)).toBe('[object LoomDirectory]');
+		});
+	});
 });

packages/core/src/core/dir.ts

@@ -104,4 +104,12 @@ export class Directory {
 			return fileList;
 		}
 	}
+
+	[Symbol.toPrimitive](): string {
+		return this.path;
+	}
+
+	get [Symbol.toStringTag]() {
+		return 'LoomDirectory';
+	}
 }

packages/core/src/core/editor.spec.ts

@@ -10,7 +10,7 @@ import { beforeAll } from 'vitest';
 import { InMemoryAdapterHelper } from '@loom-io/test-utils';
 import { SourceAdapter } from '../definitions';
 
-function createEditor(adapter, testFile: string) {
+function createEditor(adapter, testFile: string): Promise<Editor> {
 	const dir = new Directory(adapter, dirname(testFile));
 	const file = new LoomFile(adapter, dir, basename(testFile));
 	return Editor.from(adapter, file);
@@ -93,6 +93,11 @@ I also have some ideas in my mind, but not sure if they are worth to invest time
 		reader.close();
 	});
 
+	test('close', async () => {
+		const reader = await createEditor(adapter, TEST_FILE_PATH);
+		expect(reader.close()).resolves.toBeUndefined();
+	});
+
 	test('from', async () => {
 		const dir = new Directory(adapter, dirname(TEST_FILE_PATH));
 		const file = new LoomFile(adapter, dir, basename(TEST_FILE_PATH));
@@ -477,4 +482,13 @@ I also have some ideas in my mind, but not sure if they are worth to invest time
 		});
 
 	});
+
+	describe('test symbols', () => {
+
+		test('toStringTag', async () => {
+			const editor = await createEditor(adapter, TEST_FILE_PATH);
+			expect(Object.prototype.toString.call(editor)).toBe('[object LoomEditor]');
+			editor.close();
+		});
+	});
 });

packages/core/src/core/editor.ts

@@ -26,7 +26,7 @@ export interface Writer {
 	close(): Promise<void>;
 }
 
-export class Editor implements Reader, Writer, ReaderInternal{
+export class Editor implements Reader, Writer, ReaderInternal, Disposable{
 
 	protected chunkSize: number = 1024;
 	protected lineInfo: TextItemList | undefined;
@@ -66,6 +66,18 @@ export class Editor implements Reader, Writer, ReaderInternal{
 		await this.file.close();
 	}
 
+	/**
+	 * Symbol to close automatically with using
+	 */
+	async [Symbol.asyncDispose]() {
+		await this.close();
+	}
+
+	[Symbol.dispose](): void {
+		throw new Error('Method not implemented.');
+	}
+
+
 	/**
 	 * Alias for searchFirst
 	 *
@@ -263,4 +275,8 @@ export class Editor implements Reader, Writer, ReaderInternal{
 		return new LineResult(last, bSeparator, this);
 	}
 
+	get [Symbol.toStringTag]() {
+		return 'LoomEditor';
+	}
+
 }

packages/core/src/core/file.spec.ts

@@ -300,6 +300,21 @@ describe('Test File Service', () => {
 	});
 
 
+	describe('Test Symbol', () => {
+		test('toPrimitive', () => {
+			const file = LoomFile.from( adapter, './test/data/test.json');
+			expect(`${file}`).toBe('test/data/test.json');
+			expect(file + '').toBe('test/data/test.json');
+			expect(String(file)).toBe('test/data/test.json');
+			expect(+file).toBeNaN();
+		});
+
+		test('toStringTag', () => {
+			const file = LoomFile.from( adapter, './test/data/test.json');
+			expect(Object.prototype.toString.call(file)).toBe('[object LoomFile]');
+		});
+	});
+
 
 });
 
@@ -343,6 +358,7 @@ describe('Test Error handling'	, () => {
 		await expect(file.text()).resolves.toBe('{test: true}');
 		await expect(file.json()).rejects.toThrow(FileConvertException);
 	});
+
 });
 
 

packages/core/src/core/file.ts

@@ -138,4 +138,12 @@ export class LoomFile {
 			LoomFile.converterPlugins.push(plugin);
 		}
 	}
+
+	[Symbol.toPrimitive](): string {
+		return this.path;
+	}
+
+	get [Symbol.toStringTag]() {
+		return 'LoomFile';
+	}
 }

packages/core/src/core/list.spec.ts

@@ -314,4 +314,12 @@ describe('Test List', () => {
 		});
 
 	});
+
+	describe('test symbols', () => {
+
+		test('toStringTag', () => {
+			const list = new List();
+			expect(Object.prototype.toString.call(list)).toBe('[object LoomList]');
+		});
+	});
 });

packages/core/src/core/list.ts

@@ -140,4 +140,8 @@ export class List<T extends ListTypes = ListTypes> {
 			}
 		}
 	}
+
+	get [Symbol.toStringTag]() {
+		return 'LoomList';
+	}
 }