diff options
| author | Shinigami <[email protected]> | 2025-07-04 19:32:41 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-07-04 17:32:41 +0000 |
| commit | 160960b79719e1298668a7ebba390b30b8de1080 (patch) | |
| tree | 5d5b215b045e48a7c7747d161931cf7ac7596e9d /docs | |
| parent | 4e422f72fa6065db906a01836a4e76540f0f9a18 (diff) | |
| download | faker-160960b79719e1298668a7ebba390b30b8de1080.tar.xz faker-160960b79719e1298668a7ebba390b30b8de1080.zip | |
feat!: esm only (#3540)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing/submit-a-pull-request.md | 2 | ||||
| -rw-r--r-- | docs/guide/index.md | 6 |
2 files changed, 6 insertions, 2 deletions
diff --git a/docs/contributing/submit-a-pull-request.md b/docs/contributing/submit-a-pull-request.md index df8f4cdf..949151e5 100644 --- a/docs/contributing/submit-a-pull-request.md +++ b/docs/contributing/submit-a-pull-request.md @@ -45,7 +45,7 @@ It is a shorthand for running the following scripts in order: - `pnpm run format` - runs [prettier](https://github.com/prettier/prettier) to format code - `pnpm run lint` - runs [ESLint](https://github.com/eslint/eslint) to enforce project code standards - `pnpm run build:clean` - removes artifacts from previous builds -- `pnpm run build:code` - builds the code, both CommonJS and ESM versions +- `pnpm run build:code` - builds the code - `pnpm run test:update-snapshots` - runs all tests with [vitest](https://github.com/vitest-dev/vitest), and updates any snapshots if needed - `pnpm run ts-check` - checks that there are no TypeScript errors in any files diff --git a/docs/guide/index.md b/docs/guide/index.md index ef0d6117..46b41fbc 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -15,7 +15,11 @@ This documentation only covers the JavaScript implementation of Faker. ## Environments -You can run Faker in the browser, or in Node.js. Faker v9.0 requires Node.js version 18 or above. Both ESM and CommonJS imports are available. +You can run Faker in the browser, or in Node.js. Faker v10.0 requires Node.js version 20 or above. + +::: tip Note +When using CJS, you need to use at least Node.js v20.19. See https://nodejs.org/api/modules.html#loading-ecmascript-modules-using-require +::: ## Installation |
