infra(unicorn): filename-case (#2492)

.eslintrc.js

@@ -46,7 +46,6 @@ module.exports = defineConfig({
     // Each rule should be checked whether it should be enabled/configured and the problems fixed, or stay disabled permanently.
     'unicorn/better-regex': 'off',
     'unicorn/consistent-function-scoping': 'off',
-    'unicorn/filename-case': 'off',
     'unicorn/import-style': 'off',
     'unicorn/no-array-callback-reference': 'off',
     'unicorn/no-array-reduce': 'off',
@@ -139,8 +138,26 @@ module.exports = defineConfig({
       },
     },
     {
-      files: ['src/locales/**/*.ts'],
+      files: ['src/locale/**/*.ts'],
       rules: {
+        'unicorn/filename-case': 'off', // our locale files have a custom naming scheme
+      },
+    },
+    {
+      files: ['src/definitions/**/*.ts', 'src/locales/**/*.ts'],
+      rules: {
+        'unicorn/filename-case': [
+          'error',
+          {
+            case: 'snakeCase',
+            // TODO @ST-DDT 2023-10-21: rename the definitions in v9
+            ignore: [
+              /chemicalElement\.ts$/,
+              /directoryPaths\.ts$/,
+              /mimeTypes\.ts$/,
+            ],
+          },
+        ],
         'unicorn/text-encoding-identifier-case': 'off',
       },
     },

package.json

@@ -63,7 +63,7 @@
     "build": "run-s build:clean build:code build:types",
     "generate": "run-s generate:locales generate:api-docs",
     "generate:api-docs": "tsx ./scripts/apidoc.ts",
-    "generate:locales": "tsx ./scripts/generateLocales.ts",
+    "generate:locales": "tsx ./scripts/generate-locales.ts",
     "docs:build": "run-s docs:prepare docs:build:run",
     "docs:build:run": "vitepress build docs",
     "docs:build:ci": "run-s build docs:build",

scripts/apidoc/fakerClass.ts → scripts/apidoc/faker-class.ts

@@ -1,11 +1,11 @@
 import type { DeclarationReflection, ProjectReflection } from 'typedoc';
 import { ReflectionKind } from 'typedoc';
 import type { Method } from '../../docs/.vitepress/components/api-docs/method';
-import { writeApiDocsModule } from './apiDocsWriter';
-import { analyzeModule, processModuleMethods } from './moduleMethods';
+import { analyzeModule, processModuleMethods } from './module-methods';
 import { analyzeSignature } from './signature';
 import { extractModuleFieldName, selectApiSignature } from './typedoc';
 import type { ModuleSummary } from './utils';
+import { writeApiDocsModule } from './writer';
 
 export async function processFakerClasses(
   project: ProjectReflection

scripts/apidoc/fakerUtilities.ts → scripts/apidoc/faker-utilities.ts

@@ -1,10 +1,10 @@
 import type { DeclarationReflection, ProjectReflection } from 'typedoc';
 import { ReflectionKind } from 'typedoc';
 import type { Method } from '../../docs/.vitepress/components/api-docs/method';
-import { writeApiDocsModule } from './apiDocsWriter';
-import { processMethods } from './moduleMethods';
+import { processMethods } from './module-methods';
 import { selectApiSignature } from './typedoc';
 import type { ModuleSummary } from './utils';
+import { writeApiDocsModule } from './writer';
 
 export async function processFakerUtilities(
   project: ProjectReflection

scripts/apidoc/generate.ts

@@ -1,15 +1,15 @@
 import { resolve } from 'node:path';
+import { processFakerClasses, processFakerRandomizer } from './faker-class';
+import { processFakerUtilities } from './faker-utilities';
+import { processModules } from './module-methods';
+import { loadProject } from './typedoc';
+import { pathOutputDir } from './utils';
 import {
   writeApiDiffIndex,
   writeApiPagesIndex,
   writeApiSearchIndex,
   writeSourceBaseUrl,
-} from './apiDocsWriter';
-import { processFakerClasses, processFakerRandomizer } from './fakerClass';
-import { processFakerUtilities } from './fakerUtilities';
-import { processModules } from './moduleMethods';
-import { loadProject } from './typedoc';
-import { pathOutputDir } from './utils';
+} from './writer';
 
 const pathOutputJson = resolve(pathOutputDir, 'typedoc.json');
 

scripts/apidoc/moduleMethods.ts → scripts/apidoc/module-methods.ts

@@ -4,7 +4,6 @@ import type {
   SignatureReflection,
 } from 'typedoc';
 import type { Method } from '../../docs/.vitepress/components/api-docs/method';
-import { writeApiDocsModule } from './apiDocsWriter';
 import { codeToHtml } from './markdown';
 import { analyzeSignature } from './signature';
 import {
@@ -18,6 +17,7 @@ import {
 } from './typedoc';
 import type { ModuleSummary } from './utils';
 import { adjustUrls } from './utils';
+import { writeApiDocsModule } from './writer';
 
 /**
  * Analyzes and writes the documentation for modules and their methods such as `faker.animal.cat()`.

scripts/apidoc/typedoc.ts

@@ -19,7 +19,7 @@ import {
   DefaultParameterAwareSerializer,
   parameterDefaultReader,
   patchProjectParameterDefaults,
-} from './parameterDefaults';
+} from './parameter-defaults';
 import { mapByName } from './utils';
 
 type CommentHolder = Pick<Reflection, 'comment'>;

src/modules/lorem/index.ts

@@ -1,6 +1,6 @@
 import type { Faker } from '../..';
 import { bindThisToMemberFunctions } from '../../internal/bind-this-to-member-functions';
-import { filterWordListByLength } from '../word/filterWordListByLength';
+import { filterWordListByLength } from '../word/filter-word-list-by-length';
 
 /**
  * Module to generate random texts and words.

src/modules/word/index.ts

@@ -1,7 +1,7 @@
 import type { Faker } from '../..';
 import { FakerError } from '../../errors/faker-error';
 import { bindThisToMemberFunctions } from '../../internal/bind-this-to-member-functions';
-import { filterWordListByLength } from './filterWordListByLength';
+import { filterWordListByLength } from './filter-word-list-by-length';
 
 /**
  * Module to return various types of words.

test/mersenne.spec.ts

@@ -1,7 +1,7 @@
 import { beforeAll, beforeEach, describe, expect, it } from 'vitest';
 import { generateMersenne32Randomizer } from '../src/internal/mersenne';
 import type { Randomizer } from '../src/randomizer';
-import { seededRuns } from './support/seededRuns';
+import { seededRuns } from './support/seeded-runs';
 import { times } from './support/times';
 
 const NON_SEEDED_BASED_RUN = 25;

test/modules/airline.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { Aircraft, faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/animal.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/color.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { CssFunction, CssSpace, faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/commerce.spec.ts

@@ -1,7 +1,7 @@
 import validator from 'validator';
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/company.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/database.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/datatype.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker, FakerError } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 25;

test/modules/date.spec.ts

@@ -1,6 +1,6 @@
 import { afterEach, describe, expect, it } from 'vitest';
 import { faker, fakerAZ, FakerError } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const converterMap = [

test/modules/finance_iban.spec.ts → test/modules/finance-iban.spec.ts

@@ -2,7 +2,7 @@ import validator from 'validator';
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
 import ibanLib from '../../src/modules/finance/iban';
-import { times } from './../support/times';
+import { times } from '../support/times';
 
 const NON_SEEDED_BASED_RUN = 25;
 

test/modules/finance.spec.ts

@@ -5,7 +5,7 @@ import { faker, fakerZH_CN } from '../../src';
 import { FakerError } from '../../src/errors/faker-error';
 import ibanLib from '../../src/modules/finance/iban';
 import { luhnCheck } from '../../src/modules/helpers/luhn-check';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/git.spec.ts

@@ -1,7 +1,7 @@
 import validator from 'validator';
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/hacker.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/helpers.spec.ts

@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest';
 import { faker, FakerError } from '../../src';
 import { luhnCheck } from '../../src/modules/helpers/luhn-check';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 import './../vitest-extensions';
 

test/modules/image.spec.ts

@@ -1,7 +1,7 @@
 import isDataURI from 'validator/lib/isDataURI';
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 
 describe('image', () => {
   seededTests(faker, 'image', (t) => {

test/modules/internet.spec.ts

@@ -1,7 +1,7 @@
 import validator from 'validator';
 import { describe, expect, it } from 'vitest';
 import { allFakers, faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/location.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker, fakerEN_CA, fakerEN_US, FakerError } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 function degreesToRadians(degrees: number) {

test/modules/lorem.spec.ts

@@ -1,7 +1,7 @@
 import validator from 'validator';
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/music.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/number.spec.ts

@@ -1,7 +1,7 @@
 import validator from 'validator';
 import { describe, expect, it } from 'vitest';
 import { faker, FakerError } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 
 describe('number', () => {
   seededTests(faker, 'number', (t) => {

test/modules/person.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker, fakerAZ, fakerMK, fakerUK, Sex } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/phone.spec.ts

@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
 import { luhnCheck } from '../../src/modules/helpers/luhn-check';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 25;

test/modules/random.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { Faker, faker, FakerError, fakerZH_CN } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/science.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/string.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker, FakerError } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/system.spec.ts

@@ -1,7 +1,7 @@
 import validator from 'validator';
 import { describe, expect, it } from 'vitest';
 import { faker, fakerSK } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/vehicle.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { seededTests } from './../support/seededRuns';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/modules/word.spec.ts

@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest';
 import { faker } from '../../src';
-import { filterWordListByLength } from '../../src/modules/word/filterWordListByLength';
-import { seededTests } from './../support/seededRuns';
+import { filterWordListByLength } from '../../src/modules/word/filter-word-list-by-length';
+import { seededTests } from '../support/seeded-runs';
 import { times } from './../support/times';
 
 const NON_SEEDED_BASED_RUN = 5;

test/scripts/apidoc/module.spec.ts

@@ -1,6 +1,6 @@
 import { beforeAll, describe, expect, it } from 'vitest';
 import { initMarkdownRenderer } from '../../../scripts/apidoc/markdown';
-import { analyzeModule } from '../../../scripts/apidoc/moduleMethods';
+import { analyzeModule } from '../../../scripts/apidoc/module-methods';
 import * as ModuleTests from './module.example';
 import { loadExampleModules } from './utils';