Test

.devcontainer/devcontainer.json

@@ -0,0 +1,36 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
+{
+  "name": "FakerJs",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:22@sha256:2c54a060aadfb853e8d57377eb093b1593fca93864f67a32e7e977e4df0e4329",
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  "forwardPorts": [5173],
+  "portsAttributes": {
+    "5173": {
+      "label": "Docs"
+    }
+  },
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "npm install -g pnpm && pnpm install",
+
+  // Configure tool-specific properties.
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "dbaeumer.vscode-eslint",
+        "editorconfig.editorconfig",
+        "esbenp.prettier-vscode",
+        "redhat.vscode-yaml",
+        "github.vscode-pull-request-github"
+      ]
+    }
+  }
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

.editorconfig

@@ -9,5 +9,4 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.md]
-max_line_length = off
 trim_trailing_whitespace = false

.eslintrc.cjs

@@ -0,0 +1,197 @@
+// @ts-check
+const { defineConfig } = require('eslint-define-config');
+const { readGitignoreFiles } = require('eslint-gitignore');
+
+/// <reference types="@eslint-types/deprecation" />
+/// <reference types="@eslint-types/jsdoc" />
+/// <reference types="@eslint-types/prettier" />
+/// <reference types="@eslint-types/typescript-eslint" />
+/// <reference types="@eslint-types/unicorn" />
+
+module.exports = defineConfig({
+  ignorePatterns: [
+    ...readGitignoreFiles(),
+    '.eslintrc.cjs', // Skip self linting
+  ],
+  root: true,
+  env: {
+    browser: true,
+    node: true,
+  },
+  reportUnusedDisableDirectives: true,
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/strict-type-checked',
+    'plugin:prettier/recommended',
+    'plugin:deprecation/recommended',
+    'plugin:jsdoc/recommended-typescript-error',
+    'plugin:unicorn/recommended',
+  ],
+  parserOptions: {
+    project: ['./tsconfig.json'],
+    warnOnUnsupportedTypeScriptVersion: false,
+  },
+  rules: {
+    eqeqeq: ['error', 'always', { null: 'ignore' }],
+    'logical-assignment-operators': 'error',
+    'no-else-return': 'error',
+    'no-restricted-globals': ['error', 'Intl'],
+    'prefer-exponentiation-operator': 'error',
+    'prefer-template': 'error',
+
+    'unicorn/import-style': 'off', // subjective & doesn't do anything for us
+    'unicorn/no-array-callback-reference': 'off', // reduces readability
+    'unicorn/no-nested-ternary': 'off', // incompatible with prettier
+    'unicorn/no-null': 'off', // incompatible with TypeScript
+    'unicorn/no-zero-fractions': 'off', // deactivated to raise awareness of floating operations
+    'unicorn/number-literal-case': 'off', // incompatible with prettier
+    'unicorn/numeric-separators-style': 'off', // "magic numbers" may carry specific meaning
+    'unicorn/prefer-ternary': 'off', // ternaries aren't always better
+
+    // TODO @Shinigami92 2023-09-23: The following rules currently conflict with our code.
+    // 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/no-object-as-default-parameter': 'off',
+    'unicorn/prefer-export-from': 'off',
+    'unicorn/prefer-string-slice': 'off',
+    'unicorn/prevent-abbreviations': 'off',
+
+    '@typescript-eslint/array-type': [
+      'error',
+      { default: 'array-simple', readonly: 'generic' },
+    ],
+    '@typescript-eslint/consistent-type-exports': 'error',
+    '@typescript-eslint/consistent-type-imports': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': 'error',
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        format: ['PascalCase'],
+        selector: ['class', 'interface', 'typeAlias', 'enumMember'],
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+      },
+      {
+        format: ['PascalCase'],
+        selector: ['typeParameter'],
+        prefix: ['T'],
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+      },
+    ],
+    '@typescript-eslint/no-confusing-void-expression': [
+      'error',
+      {
+        ignoreArrowShorthand: true,
+      },
+    ],
+    '@typescript-eslint/no-inferrable-types': [
+      'error',
+      { ignoreParameters: true },
+    ],
+    '@typescript-eslint/no-unnecessary-condition': 'off', // requires `strictNullChecks` to be enabled
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/padding-line-between-statements': [
+      'error',
+      { blankLine: 'always', prev: 'block-like', next: '*' },
+    ],
+    '@typescript-eslint/prefer-regexp-exec': 'error',
+    '@typescript-eslint/restrict-plus-operands': [
+      'error',
+      {
+        allowAny: false,
+        allowBoolean: false,
+        allowNullish: false,
+        allowNumberAndString: true,
+        allowRegExp: false,
+      },
+    ],
+    '@typescript-eslint/restrict-template-expressions': [
+      'error',
+      { allowNumber: true, allowBoolean: true },
+    ],
+    '@typescript-eslint/switch-exhaustiveness-check': [
+      'error',
+      { requireDefaultForNonUnion: true },
+    ],
+    '@typescript-eslint/unbound-method': 'off',
+    '@typescript-eslint/unified-signatures': 'off', // incompatible with our api docs generation
+
+    'jsdoc/require-jsdoc': 'off', // Enabled only for src/**/*.ts
+    'jsdoc/require-returns': 'off',
+    'jsdoc/sort-tags': [
+      'error',
+      {
+        tagSequence: [
+          { tags: ['template'] },
+          { tags: ['internal'] },
+          { tags: ['param'] },
+          { tags: ['returns'] },
+          { tags: ['throws'] },
+          { tags: ['see'] },
+          { tags: ['example'] },
+          { tags: ['since'] },
+          { tags: ['default'] },
+          { tags: ['deprecated'] },
+        ],
+      },
+    ],
+    'jsdoc/tag-lines': 'off',
+  },
+  settings: {
+    jsdoc: {
+      mode: 'typescript',
+    },
+  },
+  overrides: [
+    {
+      files: ['src/**/*.ts'],
+      rules: {
+        'jsdoc/require-jsdoc': 'error',
+      },
+    },
+    {
+      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',
+          },
+        ],
+        'unicorn/text-encoding-identifier-case': 'off',
+      },
+    },
+    {
+      files: ['test/**/*.spec.ts'],
+      extends: ['plugin:vitest/recommended'],
+      rules: {
+        'deprecation/deprecation': 'off',
+
+        '@typescript-eslint/restrict-template-expressions': [
+          'error',
+          {
+            allowNumber: true,
+            allowBoolean: true,
+            allowAny: true,
+          },
+        ],
+
+        'vitest/expect-expect': 'off',
+        'vitest/no-alias-methods': 'error',
+        'vitest/prefer-each': 'error',
+        'vitest/prefer-to-have-length': 'error',
+        'vitest/valid-expect': ['error', { maxArgs: 2 }],
+      },
+    },
+  ],
+});

.gitattributes

@@ -1 +1,2 @@
-* -crlf
+* text eol=lf
+*.png binary

.github/CODEOWNERS

@@ -1,20 +1,4 @@
 # These owners will be the default owners for everything in the repo.
 # Unless a later match takes precedence, @faker-js/maintainers will
 # be requested for review when someone opens a pull request.
-
-*                     @faker-js/maintainers
-
-# ================================================
-#  Docs owners ...
-# ================================================
-
-/docs/                @faker-js/maintainers-docs @faker-js/maintainers
-netlify.toml          @faker-js/maintainers-docs @faker-js/maintainers
-README.md             @faker-js/maintainers-docs @faker-js/maintainers
-CONTRIBUTING.md       @faker-js/maintainers-docs @faker-js/maintainers
-
-# ================================================
-#  CODEOWNERS owners ...
-# ================================================
-
-/.github/CODEOWNERS   @faker-js/maintainers
+* @faker-js/maintainers

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,6 +1,6 @@
 name: "\U0001F680 New feature proposal"
 description: Propose a new feature
-labels: ['s: pending triage'] # This will automatically assign the 's: pending triage' label
+labels: ['s: pending triage', 'c: feature', 's: waiting for user interest']
 body:
   - type: markdown
     attributes:

.github/pull_request_template.md

@@ -1,3 +1,5 @@
-<!-- Please first read https://github.com/faker-js/faker/blob/verify-semantic-pull-requests/CONTRIBUTING.md -->
+<!-- Please run `pnpm run preflight` before opening a Pull Request to ensure that your code fulfills the minimal requirements for our project. -->
 
-<!-- Help us by writing a correct PR title following this guide: https://github.com/faker-js/faker/blob/verify-semantic-pull-requests/CONTRIBUTING.md#committing -->
+<!-- Please first read https://github.com/faker-js/faker/blob/next/CONTRIBUTING.md -->
+
+<!-- Help us by writing a correct PR title following this guide: https://github.com/faker-js/faker/blob/next/CONTRIBUTING.md#committing -->