1.2.0

Idrinth · Idrinth · commit 3ed57348c254 · 2024-04-03T16:42:50.000+02:00
diff --git a/README.md b/README.md
@@ -24,3 +24,21 @@ Options:
 Watching will watch one or more language folders and rebuild  the typescript files whenever the yaml files change.If you don't give it a root folder, it will assume the current working directory.
 
 - `ilfy watch rootfolder1 rootfolder2`
+
+## init
+
+Generates a configuration file with the current values for  the given folder or folders.
+
+## configuration
+
+use a `.idrinth-typesscript-language-from-yaml.yml` file in the root of your project to configure the tool with defaults that can be overwritten by the command line.
+
+```yaml
+hasNoTranslationsFile: false
+isSplit: false
+originDirectory: language
+isFailOnWarning: false
+targetDirectory: src/locales
+isStrictTypes: false
+isVerbatimModuleSyntax: false
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@idrinth/typescript-language-from-yaml",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Translates yaml files to ts for translation autocompletion, autocorrection and better developer support",
   "bin": {
     "itlfy": "bin/itlfy.js"
diff --git a/src/check.ts b/src/check.ts
@@ -8,60 +8,68 @@ import {
 } from 'yaml';
 import {
   EMPTY,
-  ORIGIN_DIRECTORY,
 } from './constants.js';
 import Logger from './logger.js';
 import loadKeys from './loadKeys.js';
-export default (logger: Logger, folder: string,) => {
-  if (! existsSync(`${ folder }/${ ORIGIN_DIRECTORY }`,)) {
-    logger.error(`folder ${ folder }/${ ORIGIN_DIRECTORY } doesn't exist`,);
-    return false;
-  }
-  logger.info(
-    `Checking translations in folder ${ folder }/${ ORIGIN_DIRECTORY }`,
-  );
-  logger.info('',);
-  const yamlFiles = readdirSync(`${ folder }/${ ORIGIN_DIRECTORY }`,)
-    .filter((file,) => file.endsWith('.yml',),);
-  const keys = {
-    en: [],
-  };
+import Config from "./config.js";
+export default (
+  logger: Logger,
+  config: Config,
+) => {
   let errors = 0;
-  yamlFiles.forEach((yamlFile,) => {
-    const lang = yamlFile.replace('.yml', '',);
-    keys[lang] = [];
-    const yamlPath = `${ folder }/${ ORIGIN_DIRECTORY }/${ yamlFile }`;
-
-    const content = readFileSync(yamlPath, 'utf8',);
-
-    try {
-      const data = parse(content,);
-      keys[lang] = loadKeys(data,);
-    } catch (e) {
-      logger.error(`Failed parsing ${ yamlPath }: ${ e }`,);
+  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;
     }
-  },);
-  let warnings = 0;
-  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) {
+    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 ++;
-        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.`,
-        );
+    },);
+    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('',);
   }
-  logger.info('',);
-  logger.info(`Found ${ errors } errors and ${ warnings } warnings.`,);
-  return errors === EMPTY;
+  return errors === EMPTY && (! config.isFailOnWarning || warnings === EMPTY);
 };
diff --git a/src/cli.ts b/src/cli.ts
@@ -2,52 +2,57 @@ import {
   EXIT_FAILURE,
   EXIT_SUCCESS,
   FIRST_ARGUMENT,
-  SECOND_ARGUMENT,
 } from './constants.js';
 import watch from './watch.js';
 import generate from './generate.js';
 import check from './check.js';
 import Logger from './logger.js';
+import Config from './config.js';
+import init from './init.js';
 
 // eslint-disable-next-line complexity
 export default async(args: string[], cwd: string,): Promise<number> => {
   const logger = new Logger();
+  const  config = new  Config(cwd, args,);
   switch (args[FIRST_ARGUMENT]) {
     case 'check':
       return check(
         logger,
-        args[SECOND_ARGUMENT] || cwd,
+        config,
       ) ? EXIT_SUCCESS : EXIT_FAILURE;
     case 'generate':
       generate(
         logger,
-        cwd,
-        args.includes('--split',),
-        args.includes('--verbatim-module-syntax',),
-        args.includes('--no-translations-file',),
-        args.includes('--strict-types',),
+        config,
+      );
+      return EXIT_SUCCESS;
+    case 'init':
+      init(
+        logger,
+        config,
       );
       return EXIT_SUCCESS;
     case 'watch':
       await watch(
         logger,
-        cwd,
-        args
-          .splice(SECOND_ARGUMENT,)
-          .map((arg,) => arg.split('=',),),
+        config,
       );
       return EXIT_SUCCESS;
     default:
       logger.info(
-        'itlfy check - checks the current working directory\'s yaml files.',
+        'itlfy check [...folder] - checks the watched folders\' yaml files.',
       );
       logger.info(
         'itlfy watch [...folder] - watches and rebuilds ' +
-        'the watched folder\'s language files on change.',
+        'the watched folders\' language files on change.',
+      );
+      logger.info(
+        'itlfy generate [...folder] - generates typescript files from ' +
+        'the watched folders\' files.',
       );
       logger.info(
-        'itlfy generate - generates typescript files from ' +
-        'the current working directory\'s yaml files.',
+        'itlfy init [...folder] - generates config files for the given' +
+        'directories.',
       );
       return EXIT_SUCCESS;
   }
diff --git a/src/config.ts b/src/config.ts
@@ -0,0 +1,78 @@
+import {
+  existsSync,
+  readFileSync,
+} from 'fs';
+import {
+  parse,
+} from 'yaml';
+import {
+  EMPTY,
+  SECOND_ARGUMENT
+} from "./constants.js";
+
+export default class Config {
+  public readonly originDirectory: string;
+  public readonly targetDirectory: string;
+  public readonly isVerbatimModuleSyntax: boolean;
+  public readonly hasNoTranslationsFile: boolean;
+  public readonly isFailOnWarning: boolean;
+  public readonly isStrictTypes: boolean;
+  public readonly isSplit: boolean;
+  public readonly folders: string[];
+  constructor(cwd: string, args: string[] = []) {
+    const file = `${ cwd }/.idrinth-typescript-from-yaml.yml`;
+    this.hasNoTranslationsFile = false;
+    this.isSplit = false;
+    this.originDirectory = 'language';
+    this.isFailOnWarning = false;
+    this.targetDirectory = 'src/locales';
+    this.isStrictTypes = false;
+    this.isVerbatimModuleSyntax = false;
+    if (existsSync(file,)) {
+      const data = parse(readFileSync(file, 'utf8'));
+      if (typeof data.hasNoTranslationsFile === 'boolean') {
+        this.hasNoTranslationsFile = data.hasNoTranslationsFile;
+      }
+      if (typeof data.isSplit === 'boolean') {
+        this.isSplit = data.isSplit;
+      }
+      if (typeof data.originDirectory === 'string') {
+        this.originDirectory = data.originDirectory;
+      }
+      if (typeof data.isFailOnWarning === 'boolean') {
+        this.isFailOnWarning = data.isFailOnWarning;
+      }
+      if (typeof data.targetDirectory === 'string') {
+        this.targetDirectory = data.targetDirectory;
+      }
+      if (typeof data.isStrictTypes === 'boolean') {
+        this.isStrictTypes = data.isStrictTypes;
+      }
+      if (typeof data.hasNoTranslationsFile === 'boolean') {
+        this.isVerbatimModuleSyntax = data.isVerbatimModuleSyntax;
+      }
+    }
+    if (args.includes('--no-translation-files',)) {
+      this.hasNoTranslationsFile = true;
+    }
+    if (args.includes('--split',)) {
+      this.isSplit = true;
+    }
+    if (args.includes('--fail-on-warning',)) {
+      this.isFailOnWarning = true;
+    }
+    if (args.includes('--strict-types',)) {
+      this.isStrictTypes = true;
+    }
+    if (args.includes('--verbatim-module-syntax',)) {
+      this.isVerbatimModuleSyntax = true;
+    }
+    this.folders = args
+      .splice(SECOND_ARGUMENT,)
+      .filter((arg,) => !  arg.startsWith('--'),)
+      .map((rel,) => `${ cwd }/${ rel }`);
+    if (this.folders.length === EMPTY) {
+      this.folders.push(cwd,);
+    }
+  }
+}
diff --git a/src/constants.ts b/src/constants.ts
@@ -1,6 +1,4 @@
 export const WAIT_DURATION = 100;
-export const ORIGIN_DIRECTORY = 'language';
-export const TARGET_DIR = 'src/locales';
 export const EXIT_SUCCESS = 0;
 export const EXIT_FAILURE = 1;
 export const FIRST_ARGUMENT = 2;
diff --git a/src/generate.ts b/src/generate.ts
diff --git a/src/init.ts b/src/init.ts
diff --git a/src/watch.ts b/src/watch.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@idrinth/typescript-language-from-yaml",`
`3`		`- "version": "1.1.0",`
	`3`	`+ "version": "1.2.0",`
`4`	`4`	`"description": "Translates yaml files to ts for translation autocompletion, autocorrection and better developer support",`
`5`	`5`	`"bin": {`
`6`	`6`	`"itlfy": "bin/itlfy.js"`