[ { "path": ".devcontainer/devcontainer.json", "content": "// For format details, see https://aka.ms/devcontainer.json. For config options, see the\n// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node\n{\n \"name\": \"FakerJs\",\n \"image\": \"mcr.microsoft.com/devcontainers/typescript-node:24@sha256:7870433befa3e1ed7a131e8360f13c105e52634f6f34dcfabb2cd7d6e3899f6f\",\n\n // Features to add to the dev container. More info: https://containers.dev/features.\n // \"features\": {},\n\n // Use 'forwardPorts' to make a list of ports inside the container available locally.\n \"forwardPorts\": [5173],\n \"portsAttributes\": {\n \"5173\": {\n \"label\": \"Docs\"\n }\n },\n\n // Use 'postCreateCommand' to run commands after the container is created.\n \"postCreateCommand\": \"npm install -g pnpm && pnpm install\",\n\n // Configure tool-specific properties.\n \"customizations\": {\n \"vscode\": {\n \"extensions\": [\n \"dbaeumer.vscode-eslint\",\n \"editorconfig.editorconfig\",\n \"esbenp.prettier-vscode\",\n \"redhat.vscode-yaml\",\n \"github.vscode-pull-request-github\"\n ]\n }\n }\n\n // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.\n // \"remoteUser\": \"root\"\n}\n" }, { "path": ".editorconfig", "content": "root = true\n\n[*]\nindent_style = space\nindent_size = 2\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\n\n[*.md]\ntrim_trailing_whitespace = false\n" }, { "path": ".gitattributes", "content": "* text eol=lf\n*.png binary\n" }, { "path": ".github/.codecov.yml", "content": "comment:\n layout: 'diff, flags, files'\n behavior: default\n require_changes: false\n require_base: false\n require_head: true\n\ncoverage:\n status:\n project:\n default:\n target: 95%\n threshold: 2%\n patch:\n default:\n target: 40%\n threshold: 1%\n" }, { "path": ".github/CODEOWNERS", "content": "# These owners will be the default owners for everything in the repo.\n# Unless a later match takes precedence, @faker-js/maintainers will\n# be requested for review when someone opens a pull request.\n* @faker-js/maintainers\n" }, { "path": ".github/FUNDING.yml", "content": "# These are supported funding model platforms\n\ngithub: # Replace with the open collective's name https://docs.opencollective.com/help/collectives/osc-verification/github-sponsors\npatreon: # Replace with a single Patreon username\nopen_collective: fakerjs\nko_fi: # Replace with a single Ko-fi username\ntidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel\ncommunity_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry\nliberapay: # Replace with a single Liberapay username\nissuehunt: # Replace with a single IssueHunt username\notechie: # Replace with a single Otechie username\ncustom: # Replace with a single custom sponsorship URL\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.yml", "content": "name: \"\\U0001F41E Bug report\"\ndescription: Report an issue\nlabels: ['s: pending triage', 'c: bug']\nbody:\n - type: markdown\n attributes:\n value: |\n Thanks for taking the time to fill out this bug report!\n\n If you are unsure whether your problem is a bug or not, you can check the following:\n\n - use our [Discord community](https://chat.fakerjs.dev)\n - open a new [discussion](https://github.com/faker-js/faker/discussions) and ask your question there\n - use [StackOverflow using the tag `faker-js`](https://stackoverflow.com/questions/tagged/faker-js)\n\n - type: checkboxes\n id: checkboxes\n attributes:\n label: Pre-Checks\n description: Before submitting the issue, please make sure you do the following\n options:\n - label: Follow our [Code of Conduct](https://github.com/faker-js/faker/blob/next/CODE_OF_CONDUCT.md).\n required: true\n - label: Read the [Contributing Guidelines](https://github.com/faker-js/faker/blob/next/CONTRIBUTING.md).\n required: true\n - label: Read the [docs](https://fakerjs.dev/guide).\n required: true\n - label: Check that there isn't [already an issue](https://github.com/faker-js/faker/issues) that reports the same bug to avoid creating a duplicate.\n required: true\n - label: Make sure this is a Faker issue and not related to a combination with another package.\n required: true\n - label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/faker-js/faker/discussions) or join our [Discord Chat Server](https://chat.fakerjs.dev).\n required: true\n - label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.\n required: true\n - label: I am willing to provide a PR.\n\n - type: textarea\n id: bug-description\n attributes:\n label: Describe the bug\n description: A clear and concise description of what the bug is.\n placeholder: I am doing ... What I expect is ... What actually happening is ...\n validations:\n required: true\n\n - type: textarea\n id: reproduction\n attributes:\n label: Minimal reproduction code\n description: |\n An URL to some git repository or gist that reproduces this issue. [Wtf is a minimum reproduction?](https://jmcdo29.github.io/wtf-is-a-minimum-reproduction)\n You can also provide a [Faker StackBlitz workspace](https://fakerjs.dev/new) with a reproduction.\n Alternatively you could write the code sample directly here with [markdown support.](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)\n placeholder: 'https://github.com/..., https://fakerjs.dev/new or ``` code ```'\n\n - type: textarea\n id: additional-context\n attributes:\n label: Additional Context\n description: |\n Anything else relevant? Please tell us here if you run Faker in a Web Browser.\n **Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in.\n\n - type: textarea\n id: environment-info\n attributes:\n label: Environment Info\n description: Output of `npx envinfo --system --npmPackages '@faker-js/*' --binaries --browsers`\n render: shell\n placeholder: |\n System:\n OS: _\n CPU: _\n Memory: _ / _\n Container: Yes/No\n Shell: _\n Binaries:\n Node: _ - /usr/bin/node\n Yarn: _ - /usr/bin/yarn\n npm: _ - /usr/bin/npm\n npmPackages:\n @faker-js/faker: _ => _\n validations:\n required: true\n\n - type: checkboxes\n id: module-system\n attributes:\n label: Which module system do you use?\n options:\n - label: CJS\n - label: ESM\n\n - type: dropdown\n id: package-manager\n attributes:\n label: Used Package Manager\n description: Select the used package manager\n options:\n - npm\n - yarn\n - pnpm\n - other\n validations:\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: Discord Chat\n url: https://chat.fakerjs.dev\n about: Ask questions and discuss with other users in real time.\n - name: Questions & Discussions\n url: https://github.com/faker-js/faker.js/discussions\n about: Use GitHub discussions for message-board style questions and discussions.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.yml", "content": "name: \"\\U0001F680 New feature proposal\"\ndescription: Propose a new feature\nlabels: ['s: pending triage', 'c: feature', 's: waiting for user interest']\nbody:\n - type: markdown\n attributes:\n value: Thanks for your interest in the project and taking the time to fill out this feature report!\n - type: textarea\n id: feature-description\n attributes:\n label: Clear and concise description of the problem\n description: 'As a developer using faker I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'\n validations:\n required: true\n - type: textarea\n id: suggested-solution\n attributes:\n label: Suggested solution\n description: 'In module [xy] we could provide following implementation...'\n validations:\n required: true\n - type: textarea\n id: alternative\n attributes:\n label: Alternative\n description: Clear and concise description of any alternative solutions or features you've considered.\n - type: textarea\n id: additional-context\n attributes:\n label: Additional context\n description: Any other context about the feature request here.\n" }, { "path": ".github/ISSUE_TEMPLATE/freestyle.md", "content": "---\nname: Freestyle Report\nabout: Create a report to help us improve\nlabels: 'pending triage' # This will automatically assign the 'pending triage' label\n---\n" }, { "path": ".github/commit-convention.md", "content": "## Git Commit Message Convention\n\n> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).\n\n#### TL;DR:\n\nMessages must be matched by the following [regex](https://github.com/faker-js/faker/blob/ec4efba989c0a997ab55152697cbefbad160f562/scripts/verifyCommit.ts#L12)\n\n#### Examples\n\nAppears under \"Features\" header, `dev` subheader:\n\n```\nfeat(dev): add 'comments' option\n```\n\nAppears under \"Bug Fixes\" header, `dev` subheader, with a link to issue #28:\n\n```\nfix(dev): fix dev error\n\nclose #28\n```\n\nAppears under \"Performance Improvements\" header, and under \"Breaking Changes\" with the breaking change explanation:\n\n```\nperf(build): remove 'foo' option\n\nBREAKING CHANGE: The 'foo' option has been removed.\n```\n\nThe following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the \"Reverts\" header.\n\n```\nrevert: feat(compiler): add 'comments' option\n\nThis reverts commit 667ecc1654a317a13331b17617d973392f415f02.\n```\n\n### Full Message Format\n\nA commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:\n\n```\n(): \n\n\n\n