chore:migrate to esm (#87)

* wip

* fixed some tests

* fix: used async API from fs

* removed temporarily test coverage infra

---------

Co-authored-by: Pal, Sayan <[email protected]>

Author: Sayan751

.eslintrc.js .eslintrc.cjs

@@ -2,19 +2,22 @@
   "name": "@netatwork/odata-edm-generator",
   "version": "1.0.0-7",
   "description": "OData EDM generator",
-  "typings": "dist/types/decorators",
-  "main": "dist/cjs/api/decorators.js",
-  "module": "dist/esm/decorators.js",
+  "type": "module",
+  "exports": {
+    "import": "./dist/esm/api/decorators.js"
+  },
+  "typings": "dist/types/api/decorators",
   "bin": {
-    "gen-edm": "dist/cjs/cli/index.js"
+    "gen-edm": "dist/esm/cli/index.js"
   },
   "scripts": {
     "lint": "eslint . --ext .ts --cache",
     "prebuild": "rimraf dist && npm run lint",
-    "build": "tsc && tsc -p tsconfig.esm.json",
+    "build": "tsc",
     "dev": "tsc -w --preserveWatchOutput",
-    "test": "nyc --nycrc-path ./tests/nyc.config.js mocha --config ./tests/.mocharc.js",
-    "test:dev": "cross-env DEV=true nyc --nycrc-path ./tests/nyc.config.js mocha --config ./tests/.mocharc.js --bail"
+    "pretest": "tsc -p tests/tsconfig.json",
+    "test": "mocha --config ./tests/.mocharc.cjs",
+    "test:dev": "mocha --config ./tests/.mocharc.cjs --bail"
   },
   "repository": {
     "type": "git",
@@ -32,36 +35,34 @@
   },
   "homepage": "https://github.com/Netatwork-de/odata-edm-generator#readme",
   "devDependencies": {
-    "@commitlint/cli": "^18.4.3",
-    "@commitlint/config-conventional": "^18.6.0",
+    "@commitlint/cli": "^19.0.3",
+    "@commitlint/config-conventional": "^19.0.3",
     "@netatwork/mocha-utils": "^2.1.4",
-    "@types/chai": "^4.3.4",
-    "@types/diff": "^5.0.2",
+    "@types/chai": "^4.3.12",
+    "@types/diff": "^5.0.9",
     "@types/ejs": "^3.1.1",
     "@types/mocha": "^10.0.1",
     "@types/mock-fs": "^4.13.1",
-    "@types/node": "^20.4.1",
-    "@types/uuid": "^9.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
-    "chai": "^4.3.7",
+    "@types/node": "^20.11.25",
+    "@types/uuid": "^9.0.8",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "@typescript-eslint/parser": "^7.1.1",
+    "chai": "^5.1.0",
     "colorette": "^2.0.19",
     "conventional-changelog-cli": "^4.1.0",
     "cross-env": "^7.0.3",
-    "diff": "^5.1.0",
-    "eslint": "^8.44.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^46.4.3",
-    "eslint-plugin-mocha": "^10.1.0",
+    "diff": "^5.2.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^48.2.1",
+    "eslint-plugin-mocha": "^10.4.0",
     "husky": "^9.0.11",
     "mocha": "^10.2.0",
     "mock-fs": "^5.2.0",
-    "nyc": "^15.1.0",
     "rimraf": "^5.0.1",
-    "source-map-support": "^0.5.21",
     "standard-version": "^9.5.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6",
+    "typescript": "^5.4.2",
     "uuid": "^9.0.0"
   },
   "dependencies": {

package-lock.json

@@ -1,7 +1,9 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { existsSync, mkdirSync, statSync } from 'fs';
+import { promises as fs } from 'fs';
 import { isAbsolute, resolve } from 'path';
-import { EndpointConfiguration, Logger } from './shared';
+import { EndpointConfiguration, Logger } from './shared.js';
+import { exists as exists } from './file-system-helper.js';
+import { pathToFileURL } from 'url';
 
 export class Configuration {
 
@@ -14,7 +16,7 @@ export class Configuration {
     throw new Error('Configuration is not yet initialized.');
   }
 
-  public static createFromCLIArgs(args: string[]): Readonly<Configuration> {
+  public static async createFromCLIArgs(args: string[]): Promise<Readonly<Configuration>> {
     if (this._instance !== null) {
       throw new Error('Configuration is already initialized.');
     }
@@ -33,11 +35,12 @@ export class Configuration {
             throw new Error('When providing a configuration file, the --config needs to be the first CLI argument.');
           }
           const configPath = resolve(process.cwd(), args[i + 1]);
-          if (!existsSync(configPath) || !statSync(configPath).isFile()) {
+          if (!await exists(configPath) || !(await fs.stat(configPath)).isFile()) {
             throw new Error(`The config file "${configPath}" does not exist.`);
           }
-          // eslint-disable-next-line @typescript-eslint/no-var-requires
-          instance.applyConfiguration(require(configPath) as ConfigSchema);
+          let importedConfig = await import(pathToFileURL(configPath).href) as ConfigSchema & { default?: ConfigSchema };
+          importedConfig = importedConfig.default as ConfigSchema ?? importedConfig;
+          await instance.applyConfiguration(importedConfig);
           break;
         }
         case 'endpoint':
@@ -47,7 +50,7 @@ export class Configuration {
           instance.setEndpoints(JSON.parse(args[i + 1]) as string | EndpointConfiguration[]);
           break;
         case 'outputDir': {
-          instance.setOutputDir(args[i + 1], true);
+          await instance.setOutputDir(args[i + 1], true);
           break;
         }
         case 'quoteStyle':
@@ -78,8 +81,8 @@ export class Configuration {
 
   private constructor() { /* noop */ }
 
-  private applyConfiguration(config: ConfigSchema) {
-    this.setOutputDir(config.outputDir, false);
+  private async applyConfiguration(config: ConfigSchema) {
+    await this.setOutputDir(config.outputDir, false);
     this.setEndpointsFromConfig(config);
     this.setQuote(config.quoteStyle);
     this.setIndentation(config.indentSize);
@@ -110,12 +113,12 @@ export class Configuration {
     this.adjustOutputPaths();
   }
 
-  private setOutputDir(outputDir: string | undefined, throwError: boolean) {
+  private async setOutputDir(outputDir: string | undefined, throwError: boolean) {
     if (!outputDir) { return; }
     const absolutePath: string = resolve(process.cwd(), outputDir);
-    if (!existsSync(absolutePath)) {
-      mkdirSync(absolutePath, { recursive: true });
-    } else if (throwError && !statSync(absolutePath).isDirectory()) {
+    if (!await exists(absolutePath)) {
+      await fs.mkdir(absolutePath, { recursive: true });
+    } else if (throwError && !(await fs.stat(absolutePath)).isDirectory()) {
       throw new Error(`The output path "${absolutePath}" is not a directory.`);
     }
     this.outputDir = absolutePath;

package.json

@@ -0,0 +1,15 @@
+import { promises } from 'fs';
+
+/**
+ * Checks if a file or directory exists.
+ * @param path
+ * @returns `true` if the file or directory exists, `false` otherwise.
+ */
+export async function exists(path: string): Promise<boolean> {
+  try {
+    await promises.access(path);
+    return true;
+  } catch {
+    return false;
+  }
+}

src/cli/configuration.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { existsSync, writeFileSync, mkdirSync } from 'fs';
+import { promises as fs } from 'fs';
 import { EOL } from 'os';
 import { dirname } from 'path';
 // eslint-disable-next-line @typescript-eslint/no-shadow
@@ -16,8 +16,9 @@ import {
   propertyComparator,
   PropertyInfo,
   ComplexTypeInfoSet,
-} from './shared';
-import { EdmTemplate, EndpointTemplate } from './templates';
+} from './shared.js';
+import { EdmTemplate, EndpointTemplate } from './templates.js';
+import { exists } from './file-system-helper.js';
 
 // interface ImportInfo { ns: string; type: string; }
 
@@ -94,7 +95,7 @@ export class $Generator {
   private readonly endpointTemplate = new EndpointTemplate();
   private readonly edmTemplate = new EdmTemplate();
 
-  public generateEdm(metadata: string, endpoints: Endpoint[], configuration: EndpointConfiguration): void {
+  public async generateEdm(metadata: string, endpoints: Endpoint[], configuration: EndpointConfiguration): Promise<void> {
     const parsed = new DOMParser()
       .parseFromString(metadata, 'application/xml')
       .documentElement;
@@ -104,17 +105,17 @@ export class $Generator {
     }
     const edmInfo = this.generateCodeContent(parsed, endpoints, configuration);
     if (edmInfo !== null) {
-      this.generateEdmFile(edmInfo);
+      await this.generateEdmFile(edmInfo);
     }
   }
 
-  public generateEndpointsFile(endpoints: Endpoint[], configuration: EndpointConfiguration): void {
+  public async generateEndpointsFile(endpoints: Endpoint[], configuration: EndpointConfiguration): Promise<void> {
     const path = getEndpointsPath(configuration);
     const dirName = dirname(path);
-    if (!existsSync(dirName)) {
-      mkdirSync(dirName, { recursive: true });
+    if (!await exists(dirName)) {
+      await fs.mkdir(dirName, { recursive: true });
     }
-    writeFileSync(path, this.endpointTemplate.render(endpoints));
+    await fs.writeFile(path, this.endpointTemplate.render(endpoints));
   }
 
   private generateStringEnum(acc: EnumInfo[], enumType: Element, ignored: string[]): EnumInfo[] {
@@ -177,17 +178,17 @@ export class $Generator {
     return new EdmInfo(schema.getAttribute('Namespace')!, /* imports, */ entities, $complexTypes, enums, configuration);
   }
 
-  private generateEdmFile(edmInfo: EdmInfo) {
+  private async generateEdmFile(edmInfo: EdmInfo) {
     const filePath = edmInfo.filePath;
 
     const dirName = dirname(filePath);
-    if (!existsSync(dirName)) {
-      mkdirSync(dirName, { recursive: true });
+    if (!await exists(dirName)) {
+      await fs.mkdir(dirName, { recursive: true });
     }
 
     const template = this.edmTemplate;
     const content = template.render(edmInfo);
-    writeFileSync(filePath, content);
+    await fs.writeFile(filePath, content);
   }
 
   private generateEntityInfo(

src/cli/file-system-helper.ts

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
 import * as https from 'https';
-import { Configuration } from './configuration';
-import { $Generator } from './generator';
-import { Endpoint, Logger } from './shared';
+import { Configuration } from './configuration.js';
+import { $Generator } from './generator.js';
+import { Endpoint, Logger } from './shared.js';
 
 function getData(url: string) {
   return new Promise<string>((resolve, reject) => {
@@ -45,16 +45,16 @@ Options:
 
   let generator: $Generator | null = null;
   try {
-    const configuration = Configuration.createFromCLIArgs(args);
+    const configuration = await Configuration.createFromCLIArgs(args);
     generator = new $Generator();
     for (const ep of configuration.endpoints) {
       const baseEndpoint = ep.url;
       const { value: endpoints } = JSON.parse(await getData(baseEndpoint)) as { value: Endpoint[] };
 
-      generator.generateEndpointsFile(endpoints, ep);
+      await generator.generateEndpointsFile(endpoints, ep);
       Logger.info(`generated endpoints for ${baseEndpoint}.`);
 
-      generator.generateEdm(await getData(`${baseEndpoint}/$metadata`), endpoints, ep);
+      await generator.generateEdm(await getData(`${baseEndpoint}/$metadata`), endpoints, ep);
       Logger.info(`generated EDM for ${baseEndpoint}.`);
     }
   } finally {

src/cli/generator.ts

@@ -1,5 +1,5 @@
 import { dirname, join, relative } from 'path';
-import { Configuration } from './configuration';
+import { Configuration } from './configuration.js';
 
 export interface Endpoint {
   name: string;

src/cli/index.ts

@@ -1,6 +1,6 @@
 import { Eta } from 'eta';
-import { Configuration } from './configuration';
-import { EdmInfo, Endpoint } from './shared';
+import { Configuration } from './configuration.js';
+import { EdmInfo, Endpoint } from './shared.js';
 
 const defaultEndpointsTemplate = `/**
  * This is a generated file. Please don't change this manually.

src/cli/shared.ts

@@ -2,7 +2,7 @@ const path = require('path');
 
 module.exports = {
   extends: [
-    '../.eslintrc.js',
+    '../.eslintrc.cjs',
     'plugin:mocha/recommended'
   ],
   plugins: [

src/cli/templates.ts

@@ -0,0 +1,5 @@
+module.exports = {
+  spec: './tests/.artifacts/dist/tests/**/*.spec.js',
+  reporter: '@netatwork/mocha-utils/dist/JunitSpecReporter.js',
+  reporterOptions: ['mochaFile=./tests/.artifacts/results.xml'],
+};

tests/.eslintrc.js tests/.eslintrc.cjs

@@ -1,8 +1,8 @@
 import { assert } from 'chai';
 import mockFs from 'mock-fs';
 import { join } from 'path';
-import { Configuration } from '../src/cli/configuration';
-import { EndpointConfiguration } from '../src/cli/shared';
+import { Configuration } from '../src/cli/configuration.js';
+import { EndpointConfiguration } from '../src/cli/shared.js';
 
 describe('configuration', function () {
   class TestData {
@@ -55,14 +55,14 @@ describe('configuration', function () {
   }
 
   for (const data of getTestData()) {
-    it(`createFromCLIArgs works correctly - ${data.toString()}`, function () {
+    it(`createFromCLIArgs works correctly - ${data.toString()}`, async function () {
       try {
         const expectedOutputPath = data.expected.outputDir;
         mockFs({
           ...(expectedOutputPath ? { [expectedOutputPath]: {} } : {})
         }, { createCwd: true });
 
-        const actual = Configuration.createFromCLIArgs(data.args);
+        const actual = await Configuration.createFromCLIArgs(data.args);
         assert.deepStrictEqual(JSON.parse(JSON.stringify(actual)), data.expected);
       } finally {
         Configuration.dispose();

tests/.mocharc.cjs

@@ -1,4 +1,4 @@
-import { Endpoint } from '../src/cli/shared';
+import { Endpoint } from '../src/cli/shared.js';
 
 export const standardEndpoints: Endpoint[] = [
   { name: 'People', kind: 'EntitySet', url: 'People' },