feat!: support browser

Author: Novout

package.json

@@ -45,6 +45,7 @@
     "major": "pnpm build && generi log major"
   },
   "dependencies": {
+    "c12": "^3.3.1",
     "destr": "^2.0.5",
     "fs-extra": "^11.3.2",
     "pathe": "^2.0.3"

pnpm-lock.yaml

@@ -22,3 +22,7 @@ export const NULL_KEY = '__NULL_KEY__';
 
 export const MIMETYPE = 'text/nvton';
 export const EXTENSION = '.nvton';
+
+export const DEFAULT_CONFIG = {
+	foo: 'foo',
+};

src/constants.ts

@@ -1,14 +1,35 @@
+import { loadConfig } from 'c12';
 import { LexerKey, LexerResult, NvtonOptions } from './types';
-import { writeFile } from './utils';
+import { isBrowser, writeFile } from './utils';
+import { DEFAULT_CONFIG } from './constants';
 
 export class NVTON {
 	// TODO: unknown deep type
 	private data: Map<LexerKey, unknown>;
-	private options: NvtonOptions;
+	private options: NvtonOptions = DEFAULT_CONFIG;
 
-	constructor(lexeme: LexerResult) {
+	private async loadDefaultConfig(options?: NvtonOptions) {
+		try {
+			if (!isBrowser) {
+				// TODO: awaitable load fix config
+				const { config } = await loadConfig({
+					name: 'nvton',
+					rcFile: false,
+					envName: false,
+				});
+
+				this.options = options ?? config ?? DEFAULT_CONFIG;
+			} else {
+				this.options = options ?? DEFAULT_CONFIG;
+			}
+		} catch (e) {
+			this.options = options ?? DEFAULT_CONFIG;
+		}
+	}
+
+	constructor(lexeme: LexerResult, options?: NvtonOptions) {
 		this.data = new Map();
-		this.options = {};
+		this.loadDefaultConfig(options);
 		this.set(lexeme);
 	}
 
@@ -28,6 +49,10 @@ export class NVTON {
 	}
 
 	public write(path: string) {
+		if (isBrowser) {
+			throw new Error(`Browser setups don't support write function!`);
+		}
+
 		const filepath = path.endsWith('.nvton') ? path : `${path}.nvton`;
 		// TODO: format .nvton file
 		writeFile(filepath, '');

src/data.ts

@@ -1,12 +1,20 @@
-import { getFile } from './utils';
+import { getFile, isBrowser } from './utils';
 import { lex } from './lexer';
 import { NVTON } from './data';
 
 const get = (raw: string): NVTON => {
-	const resolved = (raw.endsWith('.nvton') ? getFile(raw) : raw)?.trim();
+	const isFilepath = raw.endsWith('.nvton');
 
-	if (!resolved && resolved !== '') {
-		throw new Error(`${raw} file not found!`);
+	if (isFilepath && isBrowser) {
+		throw new Error(
+			'get() function only support read files in node, bun or deno environments.'
+		);
+	}
+
+	const resolved = (isFilepath ? getFile(raw) : raw)?.trim();
+
+	if (!resolved) {
+		throw new Error(`${raw} file not found or datatype is wrong!`);
 	}
 
 	const data = lex(resolved);

src/pipeline.ts

@@ -20,3 +20,11 @@ export const getFile = (target: string): Maybe<string> => {
 
 	return readFileSync(path).toString('utf8') || undefined;
 };
+
+export const isBrowser: boolean =
+	typeof window !== 'undefined' && typeof window.document !== 'undefined';
+
+export const isNode: boolean =
+	typeof process !== 'undefined' &&
+	process.versions != null &&
+	process.versions.node != null;

src/utils.ts

@@ -8,6 +8,8 @@ describe('NVTON', () => {
 		expect(data.get('0')).toEqual(0);
 	});
 	it('expect error in read', () => {
-		expect(() => nvton('null.nvton')).toThrowError('null.nvton file not found!');
+		expect(() => nvton('null.nvton')).toThrowError(
+			'null.nvton file not found or datatype is wrong!'
+		);
 	});
 });

test/nvton.test.ts

@@ -8,7 +8,7 @@
     "strict": true,
     "resolveJsonModule": true,
     "esModuleInterop": true,
-    "lib": ["es2015"],
+    "lib": ["es2015", "dom"],
   },
   "include": ["src/**/*.ts"]
 }

tsconfig.json

@@ -3,6 +3,7 @@ import { defineConfig } from 'tsdown';
 export default defineConfig({
   entry: 'src/index.ts',
   format: ['esm', 'cjs'],
+  target: ['es2015', 'node18'],
   clean: true,
   dts: true
 })