Merge pull request #612 from devoxa/renovate/devoxa-eslint-config-4.x

Update dependency @devoxa/eslint-config from 3.0.11 to 4.0.0

Author: kodiakhq[bot]

eslint.config.cjs

@@ -0,0 +1,5 @@
+const config = require('@devoxa/eslint-config')
+
+module.exports = config({
+  ignoreFiles: ['.gitignore'],
+})

package.json

@@ -14,27 +14,24 @@
     "test": "jest",
     "format": "prettier --ignore-path='.gitignore' --list-different --write .",
     "format:check": "prettier --ignore-path='.gitignore' --check .",
-    "lint": "eslint --ignore-path='.gitignore' '{src,tests}/**/*.ts'",
+    "lint": "eslint '{src,tests}/**/*.ts'",
     "build": "rm -rf dist/ && tsc && chmod +x dist/src/bin.js",
     "preversion": "yarn build"
   },
-  "eslintConfig": {
-    "extends": "@devoxa"
-  },
   "prettier": "@devoxa/prettier-config",
   "dependencies": {
     "colors": "1.4.0",
     "commander": "12.1.0",
     "zod": "3.23.8"
   },
   "devDependencies": {
-    "@devoxa/eslint-config": "3.0.11",
+    "@devoxa/eslint-config": "4.0.0",
     "@devoxa/prettier-config": "2.0.3",
     "@swc/core": "1.10.0",
     "@swc/jest": "0.2.37",
     "@types/jest": "29.5.14",
     "@types/node": "20.9.5",
-    "eslint": "8.57.1",
+    "eslint": "9.16.0",
     "jest": "29.7.0",
     "prettier": "3.4.2",
     "typescript": "5.7.2"

src/bin.ts

@@ -14,6 +14,8 @@ const CONFIG_SCHEMA = z.object({
   prohibitedText: z.array(z.custom<RegExp>((value) => value instanceof RegExp)).default([]),
 })
 
+type Config = z.infer<typeof CONFIG_SCHEMA>
+
 program
   .name('i18next-test')
   .version(pkg.version)
@@ -31,8 +33,8 @@ program.on('--help', function () {
 program.parse(process.argv)
 run()
 
-function run() {
-  const config = loadConfig(program.opts().config)
+function run(): void {
+  const config = loadConfig(program.opts().config as string)
 
   let hasErrors = false
   for (const localeDirectory of fs.readdirSync(config.localePath)) {
@@ -63,11 +65,12 @@ function run() {
   }
 }
 
-function loadConfig(configPath: string) {
+function loadConfig(configPath: string): Config {
   let config = {}
 
   try {
-    config = require(path.resolve(configPath))
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    config = require(path.resolve(configPath)) as object
   } catch (err) {
     if (!(err instanceof Error)) throw err
 
@@ -90,7 +93,7 @@ function loadConfig(configPath: string) {
   }
 }
 
-function printErrors(errors: Array<string>, padding: string) {
+function printErrors(errors: Array<string>, padding: string): void {
   for (const error of errors) {
     const lines = error.split('\n')
 

src/index.ts

@@ -12,10 +12,10 @@ export interface TestLocaleFileOptions {
   prohibitedText: Array<RegExp>
 }
 
-export function testLocaleFile(options: TestLocaleFileOptions) {
+export function testLocaleFile(options: TestLocaleFileOptions): Array<string> {
   let localeMap: Record<string, string>
   try {
-    localeMap = JSON.parse(options.fileContent)
+    localeMap = JSON.parse(options.fileContent) as Record<string, string>
   } catch {
     return ['File content could not be parsed as locale JSON']
   }
@@ -28,20 +28,20 @@ export function testLocaleFile(options: TestLocaleFileOptions) {
 
   for (const key in localeMap) {
     if (options.namespace === options.defaultNamespace) {
-      errors.push(colors.cyan(`"${key}"`) + ` is missing an explicit namespace`)
+      errors.push(colors.cyan(`"${key}"`) + ' is missing an explicit namespace')
     }
 
     if (options.namespace.endsWith('_old')) {
-      errors.push(colors.cyan(`"${key}"`) + ` is tagged as removed from source code`)
+      errors.push(colors.cyan(`"${key}"`) + ' is tagged as removed from source code')
     }
 
     if (localeMap[key] === '') {
-      errors.push(colors.cyan(`"${key}"`) + ` does not have a translation`)
+      errors.push(colors.cyan(`"${key}"`) + ' does not have a translation')
     }
 
     const maybeSameWord = key.length < 24 && !key.includes(' ')
     if (options.locale !== options.defaultLocale && localeMap[key] === key && !maybeSameWord) {
-      errors.push(colors.cyan(`"${key}"`) + ` has a translation equal to the source language`)
+      errors.push(colors.cyan(`"${key}"`) + ' has a translation equal to the source language')
     }
 
     // We expect the count and name of the component markers to be exactly the same,
@@ -54,7 +54,7 @@ export function testLocaleFile(options: TestLocaleFileOptions) {
       JSON.stringify(sort(componentMarkersTranslation))
     ) {
       const message = [
-        colors.cyan(`"${key}"`) + ` has mismatching component markers in the translation`,
+        colors.cyan(`"${key}"`) + ' has mismatching component markers in the translation',
         colors.green('Expected: ') + JSON.stringify(sort(componentMarkersKey)),
         colors.red('Received: ') + JSON.stringify(sort(componentMarkersTranslation)),
       ].join('\n')
@@ -65,7 +65,7 @@ export function testLocaleFile(options: TestLocaleFileOptions) {
     // Check that opened component markers are closed in the correct order.
     if (!validComponentMarkerStructure(componentMarkersTranslation)) {
       const message = [
-        colors.cyan(`"${key}"`) + ` has invalid component marker structure in the translation`,
+        colors.cyan(`"${key}"`) + ' has invalid component marker structure in the translation',
         colors.red('Received: ') + JSON.stringify(componentMarkersTranslation),
       ].join('\n')
 
@@ -82,7 +82,7 @@ export function testLocaleFile(options: TestLocaleFileOptions) {
 
     if (hasUnknownMarker) {
       const message = [
-        colors.cyan(`"${key}"`) + ` has mismatching interpolation markers in the translation`,
+        colors.cyan(`"${key}"`) + ' has mismatching interpolation markers in the translation',
         colors.green('Expected: ') + JSON.stringify(sort(interpolationMarkersKey)),
         colors.red('Received: ') + JSON.stringify(sort(interpolationMarkersTranslation)),
       ].join('\n')
@@ -97,7 +97,7 @@ export function testLocaleFile(options: TestLocaleFileOptions) {
       const translationMatch = localeMap[key].match(prohibitedTextRegex)
       if (translationMatch) {
         const message = [
-          colors.cyan(`"${key}"`) + ` has prohibited text in the translation`,
+          colors.cyan(`"${key}"`) + ' has prohibited text in the translation',
           colors.red('Prohibited: ') + colorByMatch('red', localeMap[key], translationMatch),
         ].join('\n')
 
@@ -109,19 +109,19 @@ export function testLocaleFile(options: TestLocaleFileOptions) {
   return errors
 }
 
-function parseComponentMarkers(string: string) {
+function parseComponentMarkers(string: string): Array<string> {
   return Array.from(string.matchAll(/<.*?>/g)).map((x) => x[0])
 }
 
-function parseInterpolationMarkers(string: string) {
+function parseInterpolationMarkers(string: string): Array<string> {
   return Array.from(string.matchAll(/\{\{.*?\}\}/g)).map((x) => x[0])
 }
 
 function sort<T>(array: Array<T>): Array<T> {
   return [...array].sort()
 }
 
-function validComponentMarkerStructure(componentMarkers: Array<string>) {
+function validComponentMarkerStructure(componentMarkers: Array<string>): boolean {
   // Filter out self-closing tags since they don't require any structure
   componentMarkers = componentMarkers.filter((x) => !x.match(/<.*\/>/))
 
@@ -146,7 +146,7 @@ function validComponentMarkerStructure(componentMarkers: Array<string>) {
   return true
 }
 
-function colorByMatch(color: ColorsOption, string: string, match: RegExpMatchArray) {
+function colorByMatch(color: ColorsOption, string: string, match: RegExpMatchArray): string {
   const startIndex = match.index || 0
   const endIndex = startIndex + match[0].length
 

tests/index.spec.ts

@@ -1,9 +1,9 @@
 import { testLocaleFile } from '../src/index'
 
 jest.mock('colors/safe', () => ({
-  cyan: (x: string) => x,
-  green: (x: string) => x,
-  red: (x: string) => x,
+  cyan: (x: string): string => x,
+  green: (x: string): string => x,
+  red: (x: string): string => x,
 }))
 
 describe('i18next-test', () => {
@@ -35,7 +35,7 @@ describe('i18next-test', () => {
 
   test('errors when the locale file could not be parsed as JSON (1)', () => {
     const errors = testLocaleFile({
-      fileContent: `{`,
+      fileContent: '{',
       locale: 'de',
       defaultLocale: 'en',
       namespace: 'sign-in',
@@ -225,7 +225,7 @@ Received: ["{{countt2}}"]`,
     })
 
     expect(errors).toEqual([
-      `\"Sign in to the page\" has prohibited text in the translation
+      `"Sign in to the page" has prohibited text in the translation
 Prohibited: Log in to the page`,
     ])
   })
@@ -243,7 +243,7 @@ Prohibited: Log in to the page`,
       prohibitedText: [],
     })
 
-    expect(errors).toEqual([`"Sign in" is tagged as removed from source code`])
+    expect(errors).toEqual(['"Sign in" is tagged as removed from source code'])
   })
 
   test('errors for keys that are missing an explicit namespace', () => {
@@ -258,6 +258,6 @@ Prohibited: Log in to the page`,
       prohibitedText: [],
     })
 
-    expect(errors).toEqual([`"Sign in" is missing an explicit namespace`])
+    expect(errors).toEqual(['"Sign in" is missing an explicit namespace'])
   })
 })