fix: add a note to add generated file to eslintignore

LICENSE.md

@@ -1,9 +1,9 @@
-Copyright 
+Copyright
 
-(c) 2022, Toon van Strijp
+(c) 2023, Toon van Strijp
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/guides/type-safety.md

@@ -31,6 +31,8 @@ import { I18nModule } from 'nestjs-i18n';
 export class AppModule {}
 ```
 
+> The `typesOutputPath` should also be added to `eslintignore` to prevent linting errors.
+
 # Usage
 
 To use the types within your code import the `I18nTranslations` type from the generated file. Pass this type into the generic type properties of the `I18nContext` or `I18nService`.

samples/dto-validation/src/app.module.ts

@@ -1,7 +1,12 @@
 import { Module } from '@nestjs/common';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
-import { AcceptLanguageResolver, I18nModule, QueryResolver , HeaderResolver} from 'nestjs-i18n';
+import {
+ AcceptLanguageResolver,
+ I18nModule,
+ QueryResolver,
+ HeaderResolver,
+} from 'nestjs-i18n';
 import { join } from 'path';
 
 @Module({
@@ -15,10 +20,9 @@ import { join } from 'path';
  resolvers: [
  { use: QueryResolver, options: ['lang'] },
  AcceptLanguageResolver,
- new HeaderResolver(['x-lang'])
+ new HeaderResolver(['x-lang']),
  ],
  }),
-
  ],
  controllers: [AppController],
  providers: [AppService],

samples/dto-validation/src/app.service.ts

@@ -3,6 +3,6 @@ import { Injectable } from '@nestjs/common';
 @Injectable()
 export class AppService {
  getHello(): string {
- return "hello world";
+ return 'hello world';
  }
 }

samples/dto-validation/src/dtos/create-user.dto.ts

@@ -1,8 +1,4 @@
-
-import {
- IsEmail,
- IsNotEmpty,
-} from 'class-validator';
+import { IsEmail, IsNotEmpty } from 'class-validator';
 
 export class CreateUserDto {
  @IsNotEmpty({ message: 'validation.NOT_EMPTY' })
@@ -11,5 +7,4 @@ export class CreateUserDto {
 
  @IsNotEmpty({ message: 'validation.NOT_EMPTY' })
  password: string;
-
 }

samples/dto-validation/src/main.ts

@@ -4,12 +4,13 @@ import { I18nValidationExceptionFilter, I18nValidationPipe } from 'nestjs-i18n';
 
 async function bootstrap() {
  const app = await NestFactory.create(AppModule);
- app.useGlobalPipes(
- new I18nValidationPipe())
+ app.useGlobalPipes(new I18nValidationPipe());
 
- app.useGlobalFilters(new I18nValidationExceptionFilter({
- detailedErrors: false,
- }))
+ app.useGlobalFilters(
+ new I18nValidationExceptionFilter({
+ detailedErrors: false,
+ }),
+ );
 
  await app.listen(3000);
 }

samples/simple/src/app.module.ts

@@ -1,7 +1,12 @@
 import { Module } from '@nestjs/common';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
-import { AcceptLanguageResolver, I18nModule, QueryResolver , HeaderResolver} from 'nestjs-i18n';
+import {
+ AcceptLanguageResolver,
+ I18nModule,
+ QueryResolver,
+ HeaderResolver,
+} from 'nestjs-i18n';
 import { join } from 'path';
 
 @Module({
@@ -15,10 +20,9 @@ import { join } from 'path';
  resolvers: [
  { use: QueryResolver, options: ['lang'] },
  AcceptLanguageResolver,
- new HeaderResolver(['x-lang'])
+ new HeaderResolver(['x-lang']),
  ],
  }),
-
  ],
  controllers: [AppController],
  providers: [AppService],

samples/simple/src/app.service.ts

@@ -1,11 +1,10 @@
 import { Injectable } from '@nestjs/common';
 import { I18nContext, I18nService } from 'nestjs-i18n';
 
-
 @Injectable()
 export class AppService {
  constructor(private readonly i18n: I18nService) {}
  getHello(): string {
- return this.i18n.t('test.HELLO',{ lang:  I18nContext.current().lang });
+ return this.i18n.t('test.HELLO', { lang: I18nContext.current().lang });
  }
 }

samples/simple/src/main.ts

@@ -4,12 +4,13 @@ import { I18nValidationExceptionFilter, I18nValidationPipe } from 'nestjs-i18n';
 
 async function bootstrap() {
  const app = await NestFactory.create(AppModule);
- app.useGlobalPipes(
- new I18nValidationPipe())
+ app.useGlobalPipes(new I18nValidationPipe());
 
- app.useGlobalFilters(new I18nValidationExceptionFilter({
- detailedErrors: false,
- }))
+ app.useGlobalFilters(
+ new I18nValidationExceptionFilter({
+ detailedErrors: false,
+ }),
+ );
 
  await app.listen(3000);
 }

src/i18n.module.ts

@@ -33,11 +33,7 @@ import {
 import { I18nLanguageInterceptor } from './interceptors/i18n-language.interceptor';
 import { APP_INTERCEPTOR, HttpAdapterHost } from '@nestjs/core';
 import { getI18nResolverOptionsToken } from './decorators/i18n-resolver-options.decorator';
-import {
- isNestMiddleware,
- shouldResolve,
- usingFastify,
-} from './utils/util';
+import { isNestMiddleware, shouldResolve, usingFastify } from './utils/util';
 import { I18nTranslation } from './interfaces/i18n-translation.interface';
 import { I18nLoader } from './loaders/i18n.loader';
 import { Observable, BehaviorSubject, Subject, takeUntil } from 'rxjs';
@@ -47,6 +43,7 @@ import { I18nMiddleware } from './middlewares/i18n.middleware';
 import { mergeDeep } from './utils/merge';
 import * as fs from 'fs';
 import * as path from 'path';
+import * as chalk from 'chalk';
 
 export const logger = new Logger('I18nService');
 
@@ -92,46 +89,51 @@ export class I18nModule implements OnModuleInit, OnModuleDestroy, NestModule {
  };
  }
 
-
-
  if (!!this.i18nOptions.typesOutputPath) {
- try {
- const ts = await import('./utils/typescript');
-
- this.translations.pipe(takeUntil(this.unsubscribe)).subscribe(async (t) => {
- logger.log('Checking translation changes');
- const object = Object.keys(t).reduce(
- (result, key) => mergeDeep(result, t[key]),
- {},
- );
-
- const rawContent = await ts.createTypesFile(object);
-
- if (!rawContent) {
- return;
- }
-
- const outputFile = ts.annotateSourceCode(rawContent);
-
- fs.mkdirSync(path.dirname(this.i18nOptions.typesOutputPath), {
- recursive: true,
- });
- let currentFileContent = null;
- try {
- currentFileContent = fs.readFileSync(
- this.i18nOptions.typesOutputPath,
- 'utf8',
- );
- } catch (err) {
- logger.error(err);
- }
- if (currentFileContent != outputFile) {
- fs.writeFileSync(this.i18nOptions.typesOutputPath, outputFile);
- logger.log(`Types generated in: ${this.i18nOptions.typesOutputPath}`);
- } else {
- logger.log('No changes detected');
- }
- });
+ try {
+ const ts = await import('./utils/typescript');
+
+ this.translations
+ .pipe(takeUntil(this.unsubscribe))
+ .subscribe(async (t) => {
+ logger.log('Checking translation changes');
+ const object = Object.keys(t).reduce(
+ (result, key) => mergeDeep(result, t[key]),
+ {},
+ );
+
+ const rawContent = await ts.createTypesFile(object);
+
+ if (!rawContent) {
+ return;
+ }
+
+ const outputFile = ts.annotateSourceCode(rawContent);
+
+ fs.mkdirSync(path.dirname(this.i18nOptions.typesOutputPath), {
+ recursive: true,
+ });
+ let currentFileContent = null;
+ try {
+ currentFileContent = fs.readFileSync(
+ this.i18nOptions.typesOutputPath,
+ 'utf8',
+ );
+ } catch (err) {
+ logger.error(err);
+ }
+ if (currentFileContent != outputFile) {
+ fs.writeFileSync(this.i18nOptions.typesOutputPath, outputFile);
+ logger.log(
+ `Types generated in: ${this.i18nOptions.typesOutputPath}.
+ ${chalk.yellow(
+ `Please also add it to your eslintignore file to avoid linting errors`,
+ )}`,
+ );
+ } else {
+ logger.log('No changes detected');
+ }
+ });
  } catch (_) {
  // NOOP: typescript package not found
  }

src/loaders/i18n.json.loader.ts

@@ -11,15 +11,11 @@ export class I18nJsonLoader extends I18nAbstractLoader {
  };
  }
  formatData(data: any) {
-
- try{
- return JSON.parse(data);
- }
- catch(e){
- if(e instanceof SyntaxError){
- throw new Error(
- 'Invalid JSON file. Please check your JSON syntax.'
- );
+ try {
+ return JSON.parse(data);
+ } catch (e) {
+ if (e instanceof SyntaxError) {
+ throw new Error('Invalid JSON file. Please check your JSON syntax.');
  }
  throw e;
  }

src/loaders/i18n.yaml.loader.ts

@@ -5,7 +5,6 @@ import {
 import * as yaml from 'js-yaml';
 
 export class I18nYamlLoader extends I18nAbstractLoader {
-
  getDefaultOptions(): Partial<I18nAbstractLoaderOptions> {
  return {
  filePattern: '*.yml',
@@ -14,14 +13,11 @@ export class I18nYamlLoader extends I18nAbstractLoader {
  }
 
  formatData(data: any) {
- try{
- return yaml.load(data, { json: true });
- }
- catch(e){
- if(e instanceof yaml.YAMLException){
- throw new Error(
- 'Invalid YAML file. Please check your YAML syntax.'
- );
+ try {
+ return yaml.load(data, { json: true });
+ } catch (e) {
+ if (e instanceof yaml.YAMLException) {
+ throw new Error('Invalid YAML file. Please check your YAML syntax.');
  }
 
  throw e;

src/services/i18n.service.ts

@@ -28,7 +28,8 @@ export type TranslateOptions = {
 
 @Injectable()
 export class I18nService<K = Record<string, unknown>>
- implements I18nTranslator<K>, OnModuleDestroy {
+ implements I18nTranslator<K>, OnModuleDestroy
+{
  private supportedLanguages: string[];
  private translations: I18nTranslation;
  private pluralRules = new Map<string, Intl.PluralRules>();
@@ -106,8 +107,9 @@ export class I18nService<K = Record<string, unknown>>
  ) {
  if (lang !== this.i18nOptions.fallbackLanguage || !!defaultValue) {
  if (this.i18nOptions.logging) {
- const message = `Translation "${key as string
- }" in "${lang}" does not exist.`;
+ const message = `Translation "${
+ key as string
+ }" in "${lang}" does not exist.`;
  this.logger.error(message);
  }
 
@@ -126,16 +128,16 @@ export class I18nService<K = Record<string, unknown>>
  }
 
  private getFallbackLanguage(lang: string) {
- let regionSepIndex =-1
+ let regionSepIndex = -1;
 
- if(lang.includes("-")){
+ if (lang.includes('-')) {
  regionSepIndex = lang.lastIndexOf('-');
  }
 
- if (lang.includes("_")) {
+ if (lang.includes('_')) {
  regionSepIndex = lang.lastIndexOf('_');
  }
- 
+
  return regionSepIndex !== -1
  ? lang.slice(0, regionSepIndex)
  : this.i18nOptions.fallbackLanguage;
@@ -270,14 +272,14 @@ export class I18nService<K = Record<string, unknown>>
  for (const nestedTranslation of nestedTranslations) {
  const result = rootTranslations
  ? (this.translateObject(
- nestedTranslation.key,
- rootTranslations,
- lang,
- {
- ...options,
- args: { parent: options.args, ...nestedTranslation.args },
- },
- ) as string) ?? ''
+  nestedTranslation.key,
+  rootTranslations,
+  lang,
+  {
+  ...options,
+  args: { parent: options.args, ...nestedTranslation.args },
+  },
+  ) as string) ?? ''
  : '';
  translation =
  translation.substring(0, nestedTranslation.index - offset) +