Fix eslint issues (#1)

* 1.3.1

* 1.3.1

Author: Idrinth

.eslintrc.yml

@@ -4,6 +4,8 @@ extends:
 ignorePatterns:
 - node_modules
 root: true
+env:
+  node: true
 parser: "@typescript-eslint/parser"
 rules:
   no-await-in-loop: error

.github/workflows/eslint.yml

@@ -0,0 +1,24 @@
+name: ESLINT
+on:
+  pull_request:
+    branches:
+      - the-one
+  push:
+    branches:
+      - the-one
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: latest
+          cache: 'npm'
+          cache-dependency-path: |
+            package-lock.json
+      - name: Install
+        run: npm ci
+      - name: Check
+        run: npm run lint

package.json

@@ -1,22 +1,26 @@
 {
-  "name": "@idrinth/typescript-language-from-yaml",
-  "version": "1.3.0",
+  "name": "@idrinth-api-bench/typescript-language-from-yaml",
+  "version": "1.3.1",
   "description": "Translates yaml files to ts for translation autocompletion, autocorrection and better developer support",
   "bin": {
     "itlfy": "bin/itlfy.js"
   },
   "type": "module",
   "scripts": {
-    "lint": "eslint .",
+    "lint": "eslint . --ext ts",
     "lint-fix": "eslint . --fix",
     "tsc": "tsc -p tsconfig.json",
     "prepublishOnly": "npm run tsc",
     "clear": "node tools/clear-js-files-from-src.js",
     "postpublish": "npm run clear"
   },
+  "homepage": "https://idrinth-api-ben.ch",
+  "bugs": {
+    "url": "https://github.com/idrinth-api-bench/api-bench"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/idrinth/typescript-language-from-yaml"
+    "url": "https://github.com/idrinth-api-bench/typescript-language-from-yaml"
   },
   "keywords": [
     "transslation",

src/build-translation-file.ts

@@ -0,0 +1,16 @@
+import toTypescriptObject from './to-typescript-object.js';
+import Config from './config.js';
+
+export default (config: Config, data: object,) => {
+  const head = (() => {
+    if (! config.isStrictTypes) {
+      return 'const lang = ';
+    }
+    if (! config.isVerbatimModuleSyntax) {
+      return 'import langType from \'./type.js\';\nconst lang: langType = ';
+    }
+    return 'import {\n  lang as langType,\n} from \'./type.js\';' +
+      '\nconst lang: langType = ';
+  })();
+  return `/* eslint max-len:0 */\n${ head }${ toTypescriptObject(data,) };\n\nexport default lang;\n`;
+};

src/check-folder.ts

@@ -0,0 +1,72 @@
+import Config from './config.js';
+import {
+  existsSync, readFileSync,
+} from 'fs';
+import {
+  parse,
+} from 'yaml';
+import loadKeys from './loadKeys.js';
+import Logger from './logger.js';
+import findYamlFiles from './find-yaml-files.js';
+
+// eslint-disable-next-line complexity
+export default (folder: string, logger: Logger,) => {
+  let errors = 0;
+  let warnings = 0;
+  const localConfig = new Config(`${ folder }`,);
+  const input = `${ folder }/${ localConfig.originDirectory }`;
+  if (! existsSync(input,)) {
+    logger.error(`folder ${ input } doesn't exist`,);
+    errors ++;
+    return {
+      errors,
+      warnings,
+    };
+  }
+  logger.info(
+    `Checking translations in folder ${ input }`,
+  );
+  logger.info('',);
+  const yamlFiles = findYamlFiles(folder, localConfig,);
+  const keys = {
+    en: [],
+  };
+  yamlFiles.forEach((yamlFile,) => {
+    keys[yamlFile.language] = [];
+
+    const content = readFileSync(yamlFile.input, 'utf8',);
+
+    try {
+      const data = parse(content,);
+      keys[yamlFile.language] = loadKeys(data,);
+    } catch (e) {
+      logger.error(`Failed parsing ${ yamlFile.input }: ${ e }`,);
+      errors ++;
+    }
+  },);
+  for (const lang of Object.keys(keys,)) {
+    if (lang !== 'en') {
+      const tooMany = keys[lang].filter((key,) => ! keys.en.includes(key,),);
+      const missing = keys.en.filter((key,) => ! keys[lang].includes(key,),);
+      for (const key of tooMany) {
+        errors ++;
+        logger.error(
+          `ERROR: ${ lang } defines ${ key }, that doesn't exist in english.`,
+        );
+      }
+      for (const key of missing) {
+        warnings ++;
+        logger.warn(
+          `WARN: ${ lang } lacks ${ key }, that is defined in english.`,
+        );
+      }
+    }
+  }
+  logger.info('',);
+  logger.info(`Found ${ errors } errors and ${ warnings } warnings.`,);
+  logger.info('',);
+  return {
+    errors,
+    warnings,
+  };
+};

src/check.ts

@@ -1,75 +1,19 @@
-import {
-  existsSync,
-  readdirSync,
-  readFileSync,
-} from 'fs';
-import {
-  parse,
-} from 'yaml';
 import {
   EMPTY,
 } from './constants.js';
 import Logger from './logger.js';
-import loadKeys from './loadKeys.js';
 import Config from './config.js';
+import checkFolder from './check-folder.js';
 export default (
   logger: Logger,
   config: Config,
 ) => {
   let errors = 0;
   let warnings = 0;
   for (const folder of config.folders) {
-    const localConfig = new Config(`${ folder }`,);
-    if (! existsSync(`${ folder }/${ localConfig.originDirectory }`,)) {
-      logger.error(`folder ${ folder }/${ localConfig.originDirectory } doesn't exist`,);
-      errors ++;
-      continue;
-    }
-    logger.info(
-      `Checking translations in folder ${ folder }/${ localConfig.originDirectory }`,
-    );
-    logger.info('',);
-    const yamlFiles = readdirSync(`${ folder }/${ localConfig.originDirectory }`,)
-      .filter((file,) => file.endsWith('.yml',),);
-    const keys = {
-      en: [],
-    };
-    yamlFiles.forEach((yamlFile,) => {
-      const lang = yamlFile.replace('.yml', '',);
-      keys[lang] = [];
-      const yamlPath = `${ folder }/${ localConfig.originDirectory }/${ yamlFile }`;
-
-      const content = readFileSync(yamlPath, 'utf8',);
-
-      try {
-        const data = parse(content,);
-        keys[lang] = loadKeys(data,);
-      } catch (e) {
-        logger.error(`Failed parsing ${ yamlPath }: ${ e }`,);
-        errors ++;
-      }
-    },);
-    for (const lang of Object.keys(keys,)) {
-      if (lang !== 'en') {
-        const tooMany = keys[lang].filter((key,) => ! keys.en.includes(key,),);
-        const missing = keys.en.filter((key,) => ! keys[lang].includes(key,),);
-        for (const key of tooMany) {
-          errors ++;
-          logger.error(
-            `ERROR: ${ lang } defines ${ key }, that doesn't exist in english.`,
-          );
-        }
-        for (const key of missing) {
-          warnings ++;
-          logger.warn(
-            `WARN: ${ lang } lacks ${ key }, that is defined in english.`,
-          );
-        }
-      }
-    }
-    logger.info('',);
-    logger.info(`Found ${ errors } errors and ${ warnings } warnings.`,);
-    logger.info('',);
+    const partial = checkFolder(folder, logger,);
+    errors += partial.errors;
+    warnings += partial.warnings;
   }
   return errors === EMPTY && (! config.isFailOnWarning || warnings === EMPTY);
 };

src/config.ts

@@ -28,6 +28,7 @@ export default class Config {
 
   public readonly folders: string[];
 
+  // eslint-disable-next-line complexity
   constructor(cwd: string, args: string[] = [],) {
     const file = `${ cwd }/${ CONFIG_FILE }`;
     this.hasNoTranslationsFile = false;

src/find-yaml-files.ts

@@ -0,0 +1,14 @@
+import {
+  readdirSync,
+} from 'fs';
+import Config from './config.js';
+
+export default (folder: string, config: Config,) => readdirSync(
+  `${ folder }/${ config.originDirectory }`,
+  'utf8',
+)
+  .filter((file,) => file.endsWith('.yml',) || file.endsWith('.yaml',),)
+  .map((file,) => ({
+    language: file.replace(/\.ya?ml$/u, '',),
+    input: `${ folder }/${ config.originDirectory }/${ file }`,
+  }),);