feat: yaml loader

tada5hi · Jan 9, 2024 · e3b2f8d · e3b2f8d
1 parent e6a538b
commit e3b2f8d
Show file tree

Hide file tree

Showing 12 changed files with 156 additions and 63 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -3,9 +3,9 @@
         "@tada5hi/eslint-config-typescript"
     ],
     "parserOptions": {
-        "project": "./tsconfig.json"
+        "project": "./tsconfig.eslint.json"
     },
-    "ignorePatterns": ["**/dist/*", "**/*.d.ts", "**/test/*"],
+    "ignorePatterns": ["**/dist/*", "**/*.d.ts"],
     "globals": {
         "NodeJS": true
     },

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -74,6 +74,7 @@
         "ebec": "^2.3.0",
         "flat": "^5.0.2",
         "glob": "^10.3.10",
-        "jiti": "^1.21.0"
+        "jiti": "^1.21.0",
+        "yaml": "^2.3.4"
     }
 }
diff --git a/src/loader/built-in/yaml/index.ts b/src/loader/built-in/yaml/index.ts
@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export * from './module';
diff --git a/src/loader/built-in/yaml/module.ts b/src/loader/built-in/yaml/module.ts
@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2022-2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { parse } from 'yaml';
+import fs from 'node:fs';
+import { buildFilePath } from '../../../locator';
+import { handleException } from '../../../utils';
+import type { Loader } from '../../type';
+
+export class YAMLLoader implements Loader {
+    async execute(input: string) {
+        const filePath = buildFilePath(input);
+
+        try {
+            const file = await fs.promises.readFile(filePath, { encoding: 'utf-8' });
+            return parse(file);
+        } catch (e) {
+            return handleException(e);
+        }
+    }
+
+    executeSync(input: string) {
+        const filePath = buildFilePath(input);
+
+        try {
+            const file = fs.readFileSync(filePath, { encoding: 'utf-8' });
+            return parse(file);
+        } catch (e) {
+            return handleException(e);
+        }
+    }
+}
diff --git a/src/loader/constants.ts b/src/loader/constants.ts
@@ -9,4 +9,5 @@ export enum LoaderId {
     MODULE = 'module',
     JSON = 'json',
     CONF = 'conf',
+    YAML = 'yaml',
 }
diff --git a/src/loader/module.ts b/src/loader/module.ts
@@ -9,6 +9,7 @@ import path from 'node:path';
 import { buildFilePath, pathToLocatorInfo } from '../locator';
 import { isFilePath } from '../utils';
 import { ConfLoader, JSONLoader, ModuleLoader } from './built-in';
+import { YAMLLoader } from './built-in/yaml';
 import { LoaderId } from './constants';
 import type { Loader, Rule } from './type';
 
@@ -30,6 +31,9 @@ export class LoaderManager implements Loader {
             {
                 test: ['.json'], loader: LoaderId.JSON,
             },
+            {
+                test: ['.yml'], loader: LoaderId.YAML,
+            },
         ];
     }
 
@@ -118,6 +122,10 @@ export class LoaderManager implements Loader {
                 loader = new JSONLoader();
                 break;
             }
+            case LoaderId.YAML: {
+                loader = new YAMLLoader();
+                break;
+            }
             /* istanbul ignore next */
             default: {
                 const pluginPath = this.normalizePath(id);

diff --git a/test/data/file.yml b/test/data/file.yml
@@ -0,0 +1,6 @@
+YAML:
+    - A human-readable data serialization language
+    - https://en.wikipedia.org/wiki/YAML
+yaml:
+    - A complete JavaScript implementation
+    - https://www.npmjs.com/package/yaml
diff --git a/test/unit/loader.spec.ts b/test/unit/loader.spec.ts
@@ -5,19 +5,19 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-import path from "node:path";
+import path from 'node:path';
 import {
+    LoaderManager,
+    getModuleExport,
     load,
     loadSync,
-    getModuleExport,
-    LoaderManager
-} from "../../src";
-import {LoaderId} from "../../src/loader/constants";
+} from '../../src';
+import { LoaderId } from '../../src/loader/constants';
 
 const basePath = path.join(__dirname, '..', 'data');
 
 describe('src/loader/**', () => {
-    it('should load .conf file', async() => {
+    it('should load .conf file', async () => {
         const filePath = path.join(basePath, 'file.conf');
 
         const loaderContent = await load(filePath) as Record<string, any>;
@@ -28,7 +28,7 @@ describe('src/loader/**', () => {
         expect(loaderContent.bar.b).toEqual('boz');
     });
 
-    it('should load .conf file sync', async() => {
+    it('should load .conf file sync', async () => {
         const filePath = path.join(basePath, 'file.conf');
 
         const loaderContent = loadSync(filePath) as Record<string, any>;
@@ -37,7 +37,25 @@ describe('src/loader/**', () => {
         expect(loaderContent.bar).toBeDefined();
         expect(loaderContent.bar.a).toEqual('baz');
         expect(loaderContent.bar.b).toEqual('boz');
-    })
+    });
+
+    it('should load .yml file', async () => {
+        const filePath = path.join(basePath, 'file.yml');
+
+        const loaderContent = await load(filePath) as Record<string, any>;
+        expect(loaderContent).toBeDefined();
+        expect(loaderContent.YAML).toBeDefined();
+        expect(loaderContent.yaml).toBeDefined();
+    });
+
+    it('should load .yml file sync', () => {
+        const filePath = path.join(basePath, 'file.yml');
+
+        const loaderContent = loadSync(filePath) as Record<string, any>;
+        expect(loaderContent).toBeDefined();
+        expect(loaderContent.YAML).toBeDefined();
+        expect(loaderContent.yaml).toBeDefined();
+    });
 
     it('should load .mjs file', async () => {
         const filePath = path.join(basePath, 'file.mjs');
@@ -52,7 +70,7 @@ describe('src/loader/**', () => {
         const loaderContent = loadSync(filePath) as Record<string, any>;
         expect(loaderContent).toBeDefined();
         expect(loaderContent.foo).toEqual('bar');
-    })
+    });
 
     it('should load .mjs file with default export', async () => {
         const filePath = path.join(basePath, 'file-default.mjs');
@@ -78,7 +96,7 @@ describe('src/loader/**', () => {
         expect(loaderContent.foo).toEqual('bar');
     });
 
-    it('should load .js file sync',  () => {
+    it('should load .js file sync', () => {
         const filePath = path.join(basePath, 'file.js');
 
         const loaderContent = loadSync(filePath) as Record<string, any>;
@@ -87,16 +105,15 @@ describe('src/loader/**', () => {
         expect(loaderContent.foo).toEqual('bar');
     });
 
-
     it('should load .js file with named export', async () => {
         const filePath = path.join(basePath, 'file.js');
 
         let loaderContent = await load(filePath) as Record<string, any>;
         loaderContent = getModuleExport(loaderContent);
         expect(loaderContent).toBeDefined();
         expect(loaderContent.key).toEqual('default');
-        expect(loaderContent.value).toEqual({foo: 'bar'});
-    })
+        expect(loaderContent.value).toEqual({ foo: 'bar' });
+    });
 
     it('should load .js file with named export sync', () => {
         const filePath = path.join(basePath, 'file.js');
@@ -105,13 +122,13 @@ describe('src/loader/**', () => {
         loaderContent = getModuleExport(loaderContent);
         expect(loaderContent).toBeDefined();
         expect(loaderContent.key).toEqual('default');
-        expect(loaderContent.value).toEqual({foo: 'bar'});
+        expect(loaderContent.value).toEqual({ foo: 'bar' });
     });
 
     it('should load .ts file', async () => {
         const filePath = path.join(basePath, 'file-ts.ts');
 
-        let loaderContent = await load(filePath) as Record<string, any>;
+        const loaderContent = await load(filePath) as Record<string, any>;
         expect(loaderContent).toBeDefined();
         expect(loaderContent.bar).toEqual('baz');
     });
@@ -123,34 +140,32 @@ describe('src/loader/**', () => {
         loaderContent = getModuleExport(loaderContent);
         expect(loaderContent).toBeDefined();
         expect(loaderContent.key).toEqual('default');
-        expect(loaderContent.value).toEqual({bar: 'baz'});
+        expect(loaderContent.value).toEqual({ bar: 'baz' });
     });
 
-    it('should load .ts file sync',  () => {
+    it('should load .ts file sync', () => {
         const filePath = path.join(basePath, 'file-ts.ts');
 
-        let loaderContent = loadSync(filePath) as Record<string, any>;
+        const loaderContent = loadSync(filePath) as Record<string, any>;
         expect(loaderContent).toBeDefined();
         expect(loaderContent.bar).toEqual('baz');
     });
 
-    it('should load .ts file with named export sync',  () => {
+    it('should load .ts file with named export sync', () => {
         const filePath = path.join(basePath, 'file-ts.ts');
 
         let loaderContent = loadSync(filePath) as Record<string, any>;
         loaderContent = getModuleExport(loaderContent);
         expect(loaderContent).toBeDefined();
         expect(loaderContent.key).toEqual('default');
-        expect(loaderContent.value).toEqual({bar: 'baz'});
+        expect(loaderContent.value).toEqual({ bar: 'baz' });
     });
 
     it('should filter .ts file', async () => {
         const filePath = path.join(basePath, 'file-many-ts.ts');
 
         let loaderContent = await load(filePath) as Record<string, any>;
-        loaderContent = await getModuleExport(loaderContent, (key) => {
-            return key === 'bar';
-        }) as Record<string, any>;
+        loaderContent = await getModuleExport(loaderContent, (key) => key === 'bar') as Record<string, any>;
 
         expect(loaderContent).toBeDefined();
         expect(loaderContent.key).toEqual('bar');
@@ -161,26 +176,24 @@ describe('src/loader/**', () => {
         const filePath = path.join(basePath, 'file-many-ts.ts');
 
         let loaderContent = loadSync(filePath) as Record<string, any>;
-        loaderContent = getModuleExport(loaderContent, (key) => {
-            return key === 'bar';
-        }) as Record<string, any>;
+        loaderContent = getModuleExport(loaderContent, (key) => key === 'bar') as Record<string, any>;
         expect(loaderContent).toBeDefined();
         expect(loaderContent.key).toEqual('bar');
         expect(loaderContent.value).toEqual('baz');
-    })
+    });
 
-    it('should load .json file',  async () => {
+    it('should load .json file', async () => {
         const filePath = path.join(basePath, 'file.json');
 
-        let loaderContent : Record<string, any> = await load(filePath) as Record<string, any>;
+        const loaderContent : Record<string, any> = await load(filePath) as Record<string, any>;
         expect(loaderContent).toBeDefined();
         expect(loaderContent.foo).toEqual('bar');
     });
 
-    it('should load .json file sync',  () => {
+    it('should load .json file sync', () => {
         const filePath = path.join(basePath, 'file.json');
 
-        let loaderContent = loadSync(filePath) as Record<string, any>;
+        const loaderContent = loadSync(filePath) as Record<string, any>;
         expect(loaderContent).toBeDefined();
         expect(loaderContent.foo).toEqual('bar');
     });
@@ -209,13 +222,13 @@ describe('src/loader/**', () => {
             },
             executeSync(input: string) {
                 return input;
-            }
-        })
+            },
+        });
     });
 
     it('should use module loader as fallback', () => {
         const manager = new LoaderManager();
         const loader = manager.findLoader('foo');
         expect(loader).toEqual(LoaderId.MODULE);
-    })
+    });
 });