prettier

Author: dem1fo

.github/workflows/test.yaml

@@ -1,16 +1,16 @@
 name: RunTests
 on:
   push:
-    branches: [ "main", "develop" ]
+    branches: ['main', 'develop']
   pull_request:
-    branches: [ "main" ]
+    branches: ['main']
     types: [opened, reopened, edited]
 
 jobs:
   RunTestSuite:
     name: Run Test Suite
     runs-on: ubuntu-latest
-    
+
     steps:
       - name: Checkout repo and submodules
         uses: actions/checkout@v4
@@ -26,28 +26,28 @@ jobs:
       - name: Run tests
         run: npm run test:ci
         env:
-          NODE_OPTIONS: "--experimental-vm-modules"
+          NODE_OPTIONS: '--experimental-vm-modules'
 
       - name: Publish Test Results
         uses: EnricoMi/[email protected]
         if: always()
         with:
           files: ./coverage/test-report/test-report.xml
-      
+
       - name: Publish Code Coverage
         uses: irongut/[email protected]
         with:
           filename: coverage/cobertura-coverage.xml
           badge: true
           format: markdown
           output: both
-      
+
       - name: Add Coverage PR Comment
         uses: marocchino/sticky-pull-request-comment@v2
         if: github.event_name == 'pull_request'
         with:
           recreate: true
           path: code-coverage-results.md
-      
+
       - name: Write to job Summary
         run: cat code-coverage-results.md >> $GITHUB_STEP_SUMMARY

.prettierrc

@@ -2,6 +2,6 @@
   "semi": true,
   "singleQuote": true,
   "trailingComma": "all",
-  "printWidth": 80,
+  "printWidth": 110,
   "tabWidth": 2
 }

README.md

@@ -24,16 +24,11 @@ const CONFIG_PATH = join(__dirname, './config.toml');
 
 const INPUT_PATH = join(__dirname, 'files', 'input_data.csv');
 const OUTPUT_PATH = join(__dirname, 'output', 'output.csv');
-const VALIDATION_ERRORS_PATH = join(
-  __dirname,
-  'output',
-  'validation_errors.csv',
-);
+const VALIDATION_ERRORS_PATH = join(__dirname, 'output', 'validation_errors.csv');
 
 // load configuration file
 const configLoadResult = loadConfig(CONFIG_PATH, REGION);
-if (!configLoadResult.success)
-  throw new Error('unable to load configuration file.');
+if (!configLoadResult.success) throw new Error('unable to load configuration file.');
 
 const config = configLoadResult.config;
 
@@ -46,9 +41,7 @@ const preprocessResult = await preprocessFile({
 });
 
 if (!preprocessResult.isValid)
-  throw new Error(
-    'Validation errors found in input file, review error file output.',
-  );
+  throw new Error('Validation errors found in input file, review error file output.');
 
 // validate the input file against all configured validation rules.
 const processFileResult = await processFile({

jest.ci.config.js

@@ -1,37 +1,37 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
 export default {
-    // [...]
-    extensionsToTreatAsEsm: ['.ts'],
-    moduleFileExtensions: ["ts", "js"],
-    moduleNameMapper: {
-        '^(\\.{1,2}/.*)\\.js$': '$1',
-    },
-    transformIgnorePatterns: ['^.+\\.js$'],
-    transform: {
-        // '^.+\\.[tj]sx?$' to process ts,js,tsx,jsx with `ts-jest`
-        // '^.+\\.m?[tj]sx?$' to process ts,js,tsx,jsx,mts,mjs,mtsx,mjsx with `ts-jest`
-        '^.+\\.tsx?$': [
-            'ts-jest',
-            {
-                useESM: true,
-            },
-        ],
-    },
-    // reporters
-    reporters: [
-        'default',
-        [
-            'jest-junit',
-            {
-                outputDirectory: './coverage/test-report',
-                outputName: 'test-report.xml',
-            },
-        ],
+  // [...]
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleFileExtensions: ['ts', 'js'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  transformIgnorePatterns: ['^.+\\.js$'],
+  transform: {
+    // '^.+\\.[tj]sx?$' to process ts,js,tsx,jsx with `ts-jest`
+    // '^.+\\.m?[tj]sx?$' to process ts,js,tsx,jsx,mts,mjs,mtsx,mjsx with `ts-jest`
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
     ],
-    // coverage directory
-    coverageDirectory: './coverage',
-    collectCoverage: true,
-    coverageReporters: ["cobertura", "lcov", "html"],
+  },
+  // reporters
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: './coverage/test-report',
+        outputName: 'test-report.xml',
+      },
+    ],
+  ],
+  // coverage directory
+  coverageDirectory: './coverage',
+  collectCoverage: true,
+  coverageReporters: ['cobertura', 'lcov', 'html'],
 
-    verbose: true,
-}
+  verbose: true,
+};

jest.config.js

@@ -1,37 +1,37 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
 export default {
-    // [...]
-    extensionsToTreatAsEsm: ['.ts'],
-    moduleFileExtensions: ["ts", "js"],
-    moduleNameMapper: {
-        '^(\\.{1,2}/.*)\\.js$': '$1',
-    },
-    transformIgnorePatterns: ['^.+\\.js$'],
-    transform: {
-        // '^.+\\.[tj]sx?$' to process ts,js,tsx,jsx with `ts-jest`
-        // '^.+\\.m?[tj]sx?$' to process ts,js,tsx,jsx,mts,mjs,mtsx,mjsx with `ts-jest`
-        '^.+\\.tsx?$': [
-            'ts-jest',
-            {
-                useESM: true,
-            },
-        ],
-    },
-    // reporters
-    reporters: [
-        'default',
-        [
-            'jest-junit',
-            {
-                outputDirectory: './coverage/test-report',
-                outputName: 'test-report.xml',
-            },
-        ],
+  // [...]
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleFileExtensions: ['ts', 'js'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  transformIgnorePatterns: ['^.+\\.js$'],
+  transform: {
+    // '^.+\\.[tj]sx?$' to process ts,js,tsx,jsx with `ts-jest`
+    // '^.+\\.m?[tj]sx?$' to process ts,js,tsx,jsx,mts,mjs,mtsx,mjsx with `ts-jest`
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
     ],
-    // coverage directory
-    coverageDirectory: './coverage',
-    collectCoverage: true,
-    coverageReporters: ["cobertura", "lcov", "html"],
+  },
+  // reporters
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: './coverage/test-report',
+        outputName: 'test-report.xml',
+      },
+    ],
+  ],
+  // coverage directory
+  coverageDirectory: './coverage',
+  collectCoverage: true,
+  coverageReporters: ['cobertura', 'lcov', 'html'],
 
-    verbose: true,
-}
+  verbose: true,
+};

src/config/Config.ts

@@ -19,15 +19,15 @@ export namespace Config {
     static: string[];
     reference: string[];
   }
-  export type StringBasedSalt = { source: 'STRING'; value: string }
+  export type StringBasedSalt = { source: 'STRING'; value: string };
   export type FileBasedSalt = {
     source: 'FILE';
     validator_regex?: string;
     value: {
       win32?: string;
       darwin?: string;
       linux?: string;
-    }
+    };
   };
   export interface Options {
     isBackup?: boolean;
@@ -46,9 +46,9 @@ export namespace Config {
     algorithm: {
       columns: AlgorithmColumns;
       hash: {
-        strategy: 'SHA256'
+        strategy: 'SHA256';
       };
-      salt: StringBasedSalt | FileBasedSalt
+      salt: StringBasedSalt | FileBasedSalt;
     };
     destination: ColumnMap;
     destination_map: ColumnMap;

src/config/appConfig.ts

@@ -38,10 +38,7 @@ export function loadAppConfig(configPath: string) {
   log('Loading Application config from', configPath);
 
   // attempt to read the file
-  const configData = attemptToReadTOMLData<AppConfigData>(
-    configPath,
-    APP_CONFIG_ENCODING,
-  );
+  const configData = attemptToReadTOMLData<AppConfigData>(configPath, APP_CONFIG_ENCODING);
 
   // if cannot be read we assume default application configuration
   if (!configData) {

src/config/configStore.ts

@@ -22,11 +22,7 @@ import Debug from 'debug';
 const log = Debug('CID:ConfigStore');
 
 import { loadConfig, CONFIG_FILE_ENCODING } from './loadConfig.js';
-import {
-  loadAppConfig,
-  saveAppConfig,
-  DEFAULT_APP_CONFIG,
-} from './appConfig.js';
+import { loadAppConfig, saveAppConfig, DEFAULT_APP_CONFIG } from './appConfig.js';
 
 import type { AppConfigData, Config } from './Config.js';
 
@@ -109,10 +105,7 @@ export class ConfigStore {
     this.appConfig = loadAppConfig(this.getAppConfigFilePath());
 
     // attempt to load the default app config
-    const userConfigLoad = loadConfig(
-      this.getConfigFilePath(),
-      this.getRegion(),
-    );
+    const userConfigLoad = loadConfig(this.getConfigFilePath(), this.getRegion());
 
     // if the load succesds we have a valid config -- use it as a
     // user-provided one
@@ -122,15 +115,10 @@ export class ConfigStore {
       return;
     }
 
-    console.log(
-      'User config validation not successful - attempting to load backup config',
-    );
+    console.log('User config validation not successful - attempting to load backup config');
     // if the default config load failed use the backup default
     // from the app distribution
-    const backupConfigLoad = loadConfig(
-      this.getBackupConfigFilePath(),
-      this.getRegion(),
-    );
+    const backupConfigLoad = loadConfig(this.getBackupConfigFilePath(), this.getRegion());
 
     // if the load succesds we have a valid config -- use it as
     // a config-from-backup
@@ -190,9 +178,7 @@ export class ConfigStore {
   // This method does not save the backup as the user config, only deletes the user config file
   removeUserConfig() {
     // attempt to load the backup config
-    console.log(
-      '[removeUserConfig] Attempting to remove user configuration and replace with backup.',
-    );
+    console.log('[removeUserConfig] Attempting to remove user configuration and replace with backup.');
 
     // if the current config is already a backup config don't do anything
     if (this.isCurrentConfigBackup()) {
@@ -202,10 +188,7 @@ export class ConfigStore {
     }
 
     console.log('[removeUserConfig] Trying to load backup config file');
-    const backupConfigLoad = loadConfig(
-      this.getBackupConfigFilePath(),
-      this.getRegion(),
-    );
+    const backupConfigLoad = loadConfig(this.getBackupConfigFilePath(), this.getRegion());
 
     // if failed return the error message (do not delete the user config yet)
     if (!backupConfigLoad.success) {
@@ -220,9 +203,7 @@ export class ConfigStore {
     }
 
     // if successful use the loaded backup configuration
-    console.log(
-      '[removeUserConfig] Backup config validation success - using it as config',
-    );
+    console.log('[removeUserConfig] Backup config validation success - using it as config');
     backupConfigLoad.config.isBackup = true;
     this.useBackupConfig(backupConfigLoad.config);
 
@@ -284,11 +265,7 @@ export class ConfigStore {
   }
 
   _currentSignature() {
-    if (
-      this.data &&
-      this.data.signature &&
-      this.data.signature.config_signature
-    ) {
+    if (this.data && this.data.signature && this.data.signature.config_signature) {
       return this.data.signature.config_signature;
     }
     return 'INVALID CONFIG, NO SIGNATURE';
@@ -310,6 +287,6 @@ export class ConfigStore {
 }
 
 export function makeConfigStore(storeConfig: ConfigStorePaths) {
-  if (!storeConfig) throw new Error(`ConfigStore params MUST be provided.`)
+  if (!storeConfig) throw new Error(`ConfigStore params MUST be provided.`);
   return new ConfigStore(storeConfig);
 }