docs: create doc for v29.4 #4929
Conversation
WalkthroughThis update introduces a comprehensive set of documentation for version 29.4, including getting started guides, configuration options, migration instructions, troubleshooting, and advanced usage for Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
User->>Docs: Access version 29.4 documentation
Docs->>User: Provide guides (installation, options, migration, ESM, troubleshooting, etc.)
User->>Docs: Follow configuration/setup examples
Docs->>User: Return code snippets, explanations, and diagrams
Poem
Warning Review ran into problems🔥 ProblemsCheck-run timed out after 90 seconds. Some checks/pipelines were still in progress when the timeout was reached. Consider increasing the reviews.tools.github-checks.timeout_ms value in your CodeRabbit configuration to allow more time for checks to complete. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (49)
website/docs/getting-started/installation.md (1)
45-46: Add a concretecreate-jestexample snippet.Readers may not know the exact command syntax. A short example keeps the flow consistent with the previous
ts-jestsnippets.You can also use the `create-jest` command (prefixed with either `npx` or `yarn` depending on what you're using) to have more options related to Jest. +```npm tab +npx create-jest +``` +```Yarn tab +yarn create jest +``` However, answer `no` to the Jest question about whether or not to enable TypeScript. Instead, add the line: `preset: "ts-jest"` to the `jest.config.js` file afterwards.website/versioned_docs/version-29.4/guides/using-with-monorepo.md (1)
6-9: Consider adding a minimal configuration example for clarity.The text tells users to rely on Jest’s
projectsfeature, but a short JSON snippet (showing two package paths and thepreset: "ts-jest"line) would make the guide self-contained and actionable.website/versioned_docs/version-29.4/migration.md (1)
6-26: Minor tone & clarity tweaks for migration steps.
- “codes” → “code” is more idiomatic.
- Spell out that
config:migrateonly targets Jest config differences, not TypeScript compiler options, to set expectations.-You can use the `config:migrate` tool of `ts-jest` CLI if you're coming from an older version to help you migrate your Jest configuration. +You can use the `config:migrate` command from the `ts-jest` CLI to update your Jest configuration when upgrading from an older version. +Note: this tool only updates Jest-specific settings; it leaves your `tsconfig.json` unchanged.website/versioned_docs/version-29.4/getting-started/options/useESM.md (1)
5-8: Grammar: use singular “code”.-The `useESM` option allows `ts-jest` to transform codes to ESM syntax **if possible**. - -The default value is **false**, `ts-jest` will transform codes to `CommonJS` syntax. +The `useESM` option allows `ts-jest` to transform code to ESM syntax **when possible**. + +By default (**false**), `ts-jest` transforms code to `CommonJS` syntax.website/versioned_docs/version-29.4/getting-started/options/compiler.md (1)
5-5: Use the official “Node.js” spelling
NodeJS→Node.jsis the canonical spelling in official docs and avoids markdown-style/grammar linter warnings.-... load the NodeJS module holding the TypeScript compiler. +... load the Node.js module holding the TypeScript compiler.website/versioned_docs/version-29.4/debugging.md (3)
7-8: Add missing determiner“The output of the logger will be in ts-jest.log the current working directory.”
Without “the”, the sentence reads awkwardly.-The output of the logger will be in **ts-jest.log** in current working directory. +The output of the logger will be in **ts-jest.log** in the current working directory.
12-16: Replace emphasis with proper headings and specify code-block languageMarkdown-lint flags
**Linux/MacOS**as “emphasis used instead of heading”, and the fenced block lacks a language.
Consider:-**Linux/MacOS** - -``` +### Linux / macOS + +```bash export TS_JEST_LOG=ts-jest.logAlso adjust “MacOS” → “macOS” per Apple’s styling.
18-26: Apply the same heading & language fixes to Windows examples-**Windows** - -```Command Prompt tab +### Windows (Command Prompt) + +```cmd set TS_JEST_LOG=ts-jest.log-```PowerShell tab +```powershell $env:TS_JEST_LOG = 'ts-jest.log'</blockquote></details> <details> <summary>website/versioned_docs/version-29.4/guides/hybrid-node-module.md (1)</summary><blockquote> `11-13`: **Minor wording & article fixes** “At the moment” is verbose and lints as style; “Currently” is shorter. Missing article before “TypeScript API”. ```diff -At the moment, `ts-jest` uses TypeScript API to transpile code so the emitted `js` code depends on the `TypeScript` version used. +Currently, `ts-jest` uses the TypeScript API to transpile code, so the emitted JavaScript depends on the TypeScript version used.website/versioned_docs/version-29.4/getting-started/version-checking.md (3)
12-14: Grammar improvements & clarity
- Add “the” before “native”.
- “One uses incompatible versions” → “Users running incompatible versions”.
- “opt-out” → “opt out”.
-The version checking is **DEPRECATED** in favor of native `peerDependencies` checking mechanism in `package.json`. +The version checking feature is **DEPRECATED** in favor of the native `peerDependencies` checking mechanism in `package.json`. -By default, `ts-jest` supports a range of versions for `jest`/`typescript`. One uses incompatible versions will receive a warning -message while running tests. This warning message can be opt-out by setting environment variable `TS_JEST_DISABLE_VER_CHECKER`: +By default, `ts-jest` supports a range of versions for `jest` and `typescript`. Users running incompatible versions will receive a +warning while running tests. This warning can be opted out of by setting the environment variable `TS_JEST_DISABLE_VER_CHECKER`:
15-19: Heading & fenced-block languageAs with other docs, swap the emphasis for a heading and add a language tag:
-**Linux/MacOS** - -``` +### Linux / macOS + +```bash export TS_JEST_DISABLE_VER_CHECKER=trueAlso “MacOS” → “macOS”.
21-25: Apply same fix for Windows section-**Windows** - -``` +### Windows + +```cmd set TS_JEST_DISABLE_VER_CHECKER=truewebsite/versioned_docs/version-29.4/introduction.md (1)
10-10: Add a comma after “TypeScript” for readability-It supports all features of TypeScript including type-checking. +It supports all features of TypeScript, including type-checking.website/versioned_docs/version-29.4/getting-started/installation.md (2)
16-16: Insert a comma after the closing quote of the error message-Tip: If you get an error with the following `npm` commands such as `npx: command not found`, you can replace … +Tip: If you get an error with the following `npm` commands, such as `npx: command not found`, you can replace …
46-46: Trim verbosity & prefer “afterward”-However, answer `no` to the Jest question about whether or not to enable TypeScript. Instead, add the line: `preset: "ts-jest"` to the `jest.config.js` file afterwards. +However, answer `no` to the Jest question of whether to enable TypeScript. Then add `preset: "ts-jest"` to `jest.config.js` afterward.website/versioned_docs/version-29.4/getting-started/options/astTransformers.md (1)
5-8: Tighten wording & fix verb form-`ts-jest` by default does hoisting for a few `jest` methods via a TypeScript AST transformer. One can also create custom -TypeScript AST transformers and provide them to `ts-jest` to include into compilation process. - -The option is `astTransformers` and it allows ones to specify which 3 types of TypeScript AST transformers to use with `ts-jest`: +`ts-jest` automatically hoists a few `jest` methods through its own TypeScript AST transformer. +You can supply additional custom transformers for the compilation process via the `astTransformers` option, which supports three categories:website/versioned_docs/version-29.4/getting-started/options/stringifyContentPathRegex.md (2)
6-7: Minor grammar tweaks-It's a regular expression pattern used to match the path of file to be transformed. -If it matches, the file will be exported as a module exporting its content. +It is a regular-expression pattern that matches the path of **the** file to be transformed. +When the pattern matches, the file is exported as a module whose default export is the file’s raw content.
11-11: Add missing articles for clarity-Whatever file(s) you want to match with `stringifyContentPathRegex` pattern, you must ensure the Jest `transform` option pointing to `ts-jest` matches them. +For any file(s) you intend to match with the `stringifyContentPathRegex` pattern, ensure that the Jest `transform` entry pointing to `ts-jest` also matches those files.website/versioned_docs/version-29.4/guides/mock-es6-class.md (1)
6-9: Fix possessive typo & insert commas after conjunctive adverbs-TypeScript is transpiling your ts file and your module is likely being imported using ES2015s import. -`const soundPlayer = require('./sound-player')`. Therefore creating an instance of the class that was exported as -a default will look like this: `new soundPlayer.default()`. However if you are mocking the class as suggested by the documentation. +TypeScript transpiles your `.ts` file, and the module is likely imported using ES2015’s `import`. +`const soundPlayer = require('./sound-player')`. Therefore, creating an instance of the class that was exported as +a default will look like this: `new soundPlayer.default()`. However, if you mock the class as suggested in the documentation,website/versioned_docs/version-29.4/getting-started/options/tsconfig.md (2)
5-10: Add the missing comma after “By default” and tighten the wordingCurrent phrasing trips the reader. A minimal tweak restores flow and correct punctuation.
-By default `ts-jest` will try to find a `tsconfig.json` in your project. If it cannot find one, it will use the default TypeScript [compiler options][]; except, `ES2015` is used as `target` instead of `ES5`. +By default, `ts-jest` tries to find a `tsconfig.json` in your project. If none is found, it falls back to the default TypeScript [compiler options][], except that `ES2015` is used as the `target` instead of `ES5`.
15-31: Optional: hint users about<rootDir>for cross-platform safetyMany projects run Jest from a sub-directory (e.g.
packages/foo). Prefixing the example with<rootDir>/avoids surprises.- tsconfig: 'tsconfig.test.json', + tsconfig: '<rootDir>/tsconfig.test.json',website/versioned_docs/version-29.4/getting-started/paths-mapping.md (1)
6-6: Use “set up” (verb) instead of “setup” (noun)-...option in your Jest config is setup accordingly. +...option in your Jest config is set up accordingly.website/versioned_docs/version-29.4/processing.md (1)
6-6: Missing comma after “library”-_These are internal technical documents. If you're not a contributor to `ts-jest`, but simply trying to use the library you'll find nothing of value here_ +_These are internal technical documents. If you're not a contributor to `ts-jest`, but simply trying to use the library, you'll find nothing of value here_website/versioned_docs/version-29.4/guides/troubleshooting.md (2)
18-20: Minor grammar polish for smoother reading-Check if `rootDir` is referenced correctly. If not add this on your existing jest configuration. +Check that `rootDir` is referenced correctly; if not, add it to your existing Jest configuration.
60-60: Fix possessive “it’s” and typo “you” → “your”-Check github folder names if its identical to you local folder names. +Check GitHub folder names; ensure they’re identical to your local folder names.website/versioned_docs/version-29.4/getting-started/options/babelConfig.md (3)
5-5: Correct verb agreement in introductory sentence
your code rely→your code relies-`ts-jest` by default does **NOT** use Babel. But you may want to use it, especially if your code rely on Babel plugins to make some transformations. `ts-jest` can call the BabelJest processor once TypeScript has transformed the source into JavaScript. +`ts-jest` by default does **NOT** use Babel. But you may want to enable it—especially if your code relies on Babel plugins for additional transformations. `ts-jest` can call the `babel-jest` processor once TypeScript has emitted JavaScript.
7-8: Tighten wording & fix plural / article issuesThe phrase “pretty much” is informal, and “is … values” should be “are … values”.
-The option is `babelConfig` and it works pretty much as the `tsconfig` option, except that it is disabled by default. Here is the possible values it can take: +The `babelConfig` option works similarly to `tsconfig`, except that it is disabled by default. These are the possible values it accepts:
39-40: Remove superfluous back-slash in<rootDir>tokenBack-slash escapes the angle bracket and renders literally. The canonical token is
<rootDir>.-The path should be relative to the current working directory where you start Jest from. You can also use `\<rootDir>` in the path, or use an absolute path (this last one is strongly not recommended). +The path should be relative to the working directory where you start Jest. You can also use `<rootDir>` in the path; using an absolute path is **strongly discouraged**.website/versioned_docs/version-29.4/getting-started/options.md (1)
10-10: Add missing article for readability
using custom transform config→using a custom \transform` config`-If you are using custom `transform` config, please remove `preset` from your Jest config to avoid issues that Jest doesn't transform files correctly. +If you are using a custom `transform` config, remove the `preset` from your Jest configuration to avoid incorrect file transformations.website/versioned_docs/version-29.4/babel7-or-ts.md (2)
12-13: Pluralise “limitation”
the limitation of it→its limitations-While `@babel/preset-typescript` is a great preset, you must know the limitation of it. +While `@babel/preset-typescript` is a great preset, you should be aware of its limitations.
16-17: Prefer neutral wording over “big PRO”“Big PRO” is colloquial; “main advantage” is clearer.
-This is the big **PRO** of using TypeScript vs Babel, you have type-checking out of the box. +The main **advantage** of using TypeScript instead of Babel is built-in type-checking.website/versioned_docs/version-29.4/getting-started/options/isolatedModules.md (3)
11-14: Add comma after introductory clause and clarify wordingIntroduce a comma after “By default,” and adjust phrasing.
-By default `ts-jest` uses TypeScript compiler in the context of a project (yours), with full type-checking and features. +By default, `ts-jest` uses the TypeScript compiler in the context of your project, providing full type-checking and language features.
43-45: Rephrase performance sentence“comes with a cost of performance comparing to” → “is slower than”
-Using `isolatedModules: false` comes with a cost of performance comparing to `isolatedModules: true`. +Using `isolatedModules: false` is slower than `isolatedModules: true`.
58-60: Replace “amount of files” with “number of files” & hyphenate “trade-off”-Limiting the amount of files loaded via `include` can greatly boost performance when running tests. However, the trade off -is `ts-jest` might not recognize all files which are intended to use with `jest`. +Limiting the number of files loaded via `include` can greatly boost performance when running tests. However, the trade-off +is that `ts-jest` might not recognise every file intended for use with Jest.website/versioned_docs/version-29.4/guides/esm-support.md (2)
8-10: Drop redundant “of” in “take into account of”-Jest will take into account of the following things when working with ESM: +Jest takes the following factors into account when working with ESM:
56-60: Remove duplicated word “with with”-Execute Jest with with `--experimental-vm-modules` flag for `NodeJs` +Execute Jest with the `--experimental-vm-modules` flag for Node.jswebsite/versioned_docs/version-29.4/getting-started/options/diagnostics.md (5)
12-14: Add a comma after the introductory phrase
“By default all diagnostics are enabled” → “By default, all diagnostics are enabled”.
18-18: Replace the clipped term “config.”
Recommend: “Each configuration key is optional”.
21-24: Tighten wording in default-codes paragraph
Current wording is hard to parse and missing a comma after “By default”. Consider:-By default here are the ones ignored: +By default, the following codes are ignored:
58-58: Subject-verb agreement
“files ends” → “files end”.
110-110: Use “these values” instead of “this values”.website/versioned_docs/version-29.4/contributing.md (5)
8-8: Split the run-on sentence
Two independent clauses joined by a comma. Suggest:-Please note we have a code of conduct, please follow it in all your interactions with the project. +Please note we have a code of conduct. Please follow it in all your interactions with the project.
12-12: Insert missing article
“have latestmainbranch merged” → “have the latestmainbranch merged”.
14-14: Remove unnecessary comma before “so that”
…“with the one before the review so that we can see intermediate modifications.”
17-17: Add comma after non-restrictive clause
“…trying to use the library, you’ll find …”.
23-23: Insert article
“…preparation of the E2E test directory…”.website/versioned_docs/version-29.4/getting-started/presets.md (3)
145-147: “an ESM”, not “a ESM”
Use the article “an” before “ESM”.
68-68: Remove trailing colons from headings
Markdown-lint (MD026) flags headings ending with “:”. Drop the colon to conform to style guidelines.Also applies to: 127-127, 185-185, 245-245, 304-304, 361-361, 420-420, 477-477, 538-538, 597-597, 658-658, 717-717
738-738: Insert comma for readability
Add a comma after “major release”, e.g., “major release, and users are…”.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
website/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (28)
website/docs/getting-started/installation.md(1 hunks)website/versioned_docs/version-29.4/babel7-or-ts.md(1 hunks)website/versioned_docs/version-29.4/contributing.md(1 hunks)website/versioned_docs/version-29.4/debugging.md(1 hunks)website/versioned_docs/version-29.4/getting-started/installation.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/astTransformers.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/babelConfig.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/compiler.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/diagnostics.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/isolatedModules.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/stringifyContentPathRegex.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/tsconfig.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/useESM.md(1 hunks)website/versioned_docs/version-29.4/getting-started/paths-mapping.md(1 hunks)website/versioned_docs/version-29.4/getting-started/presets.md(1 hunks)website/versioned_docs/version-29.4/getting-started/version-checking.md(1 hunks)website/versioned_docs/version-29.4/guides/esm-support.md(1 hunks)website/versioned_docs/version-29.4/guides/hybrid-node-module.md(1 hunks)website/versioned_docs/version-29.4/guides/mock-es6-class.md(1 hunks)website/versioned_docs/version-29.4/guides/react-native.md(1 hunks)website/versioned_docs/version-29.4/guides/troubleshooting.md(1 hunks)website/versioned_docs/version-29.4/guides/using-with-monorepo.md(1 hunks)website/versioned_docs/version-29.4/introduction.md(1 hunks)website/versioned_docs/version-29.4/migration.md(1 hunks)website/versioned_docs/version-29.4/processing.md(1 hunks)website/versioned_sidebars/version-29.4-sidebars.json(1 hunks)website/versions.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
website/versioned_docs/version-29.4/getting-started/options/compiler.md
[uncategorized] ~5-~5: The official spelling of this programming framework is “Node.js”.
Context: ...r to be used. It'll be used to load the NodeJS module holding the TypeScript compiler....
(NODE_JS)
website/versioned_docs/version-29.4/getting-started/installation.md
[uncategorized] ~16-~16: Possible missing comma found.
Context: ...u get an error with the following npm commands such as npx: command not found, you c...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~16-~16: Possible typo: you repeated a word.
Context: ... found, you can replace npx XXXwithnode node_modules/.bin/XXX` from the root of your...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~46-~46: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ... answer no to the Jest question about whether or not to enable TypeScript. Instead, add the ...
(WHETHER)
[locale-violation] ~46-~46: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ..."ts-jest"to thejest.config.js` file afterwards. #### Customizing For customizing jes...
(AFTERWARDS_US)
website/versioned_docs/version-29.4/guides/hybrid-node-module.md
[style] ~10-~10: For conciseness, consider replacing this expression with an adverb.
Context: ...emitted code looks like. :::important At the moment, ts-jest uses TypeScript API to trans...
(AT_THE_MOMENT)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...mportant At the moment, ts-jest uses TypeScript API to transpile code so the emitted `j...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~11-~11: Possible missing comma found.
Context: ...-jestuses TypeScript API to transpile code so the emittedjs` code depends on the...
(AI_HYDRA_LEO_MISSING_COMMA)
website/versioned_docs/version-29.4/debugging.md
[uncategorized] ~7-~7: You might be missing the article “the” here.
Context: ...he logger will be in ts-jest.log in current working directory. The debug logger co...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~12-~12: The operating system from Apple is written “macOS”.
Context: ...TypeScript config is used etc. Linux/MacOS ``` export TS_JEST_LOG=ts-jest.log `...
(MAC_OS)
website/versioned_docs/version-29.4/getting-started/options/tsconfig.md
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ...o be specified instead of a file path. By default ts-jest will try to find a `tsconfig....
(BY_DEFAULT_COMMA)
[uncategorized] ~65-~65: Did you mean: “By default,”?
Context: ...stConfig ``` #### Disable auto-lookup By default ts-jest will try to find a `tsconfig....
(BY_DEFAULT_COMMA)
[uncategorized] ~66-~66: You might be missing the article “the” here.
Context: ... may not want to use it at all and keep TypeScript default options. You can achieve this b...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/introduction.md
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...ypeScript. It supports all features of TypeScript including type-checking. [Read more abo...
(AI_HYDRA_LEO_MISSING_COMMA)
website/versioned_docs/version-29.4/getting-started/version-checking.md
[uncategorized] ~8-~8: You might be missing the article “the” here.
Context: ... checking is DEPRECATED in favor of native peerDependencies checking mechanism i...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ...rning message can be opt-out by setting environment variable TS_JEST_DISABLE_VER_CHECKER:...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~15-~15: The operating system from Apple is written “macOS”.
Context: ...TS_JEST_DISABLE_VER_CHECKER: Linux/MacOS ``` export TS_JEST_DISABLE_VER_CHECK...
(MAC_OS)
website/versioned_docs/version-29.4/guides/esm-support.md
[style] ~8-~8: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...SM Support --- :::important Jest will take into account of the following things when working wi...
(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...s/en/ecmascript-modules) - The value of module option in tsconfig file is eithe...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~34-~34: You might be missing the article “the” here.
Context: ... ## Configure Jest runtime :::warning Jest runtime currently has a few issues rela...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~35-~35: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e currently has a few issues related to support ESM: - Not taking into account of `typ...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[style] ~37-~37: ‘taking into account’ might be wordy. Consider a shorter alternative.
Context: ...w issues related to support ESM: - Not taking into account of type: "module" field in `package.j...
(EN_WORDINESS_PREMIUM_TAKING_INTO_ACCOUNT)
[duplication] ~56-~56: Possible typo: you repeated a word.
Context: ...tall -D ts-node ``` ::: Execute Jest with with --experimental-vm-modules flag for `N...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~135-~135: You might be missing the article “the” here.
Context: ... ESM files from node_modules with default jest-resolve which usually works for ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~187-~187: You might be missing the article “the” here.
Context: ...ve .mjs/.mts extensions To work with .mts extension, besides the requirement...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/getting-started/options/astTransformers.md
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...T transformers option --- ts-jest by default does hoisting for a few jest methods ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~5-~5: After the auxiliary verb ‘do’, use the base form of a verb. Did you mean “hoist”?
Context: ...s option --- ts-jest by default does hoisting for a few jest methods via a TypeScri...
(AUXILIARY_DO_WITH_INCORRECT_VERB_FORM)
[uncategorized] ~6-~6: You might be missing the article “the” here.
Context: ...ovide them to ts-jest to include into compilation process. The option is `astTransformer...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~8-~8: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...tion is astTransformers and it allows ones to specify which 3 types of TypeScript ...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ranspiled syntax. - afterDeclarations means your transformers get run during d.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
website/versioned_docs/version-29.4/babel7-or-ts.md
[uncategorized] ~6-~6: A comma might be missing here.
Context: ...tle: Babel7 or TypeScript --- In Sept. 2018 Babel7 got released with an interesting...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
website/versioned_docs/version-29.4/getting-started/options/isolatedModules.md
[uncategorized] ~7-~7: You might be missing the article “the” here.
Context: ...in the next major release. Please useisolatedModulesoption intsconfig.jso...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~10-~10: Did you mean: “By default,”?
Context: ...ption in tsconfig.json instead. ::: By default ts-jest uses TypeScript compiler in t...
(BY_DEFAULT_COMMA)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...nstead. ::: By default ts-jest uses TypeScript compiler in the context of a project (y...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~15-~15: You might be missing the article “the” here.
Context: ...defaults to false) does. You'll lose type-checking ability and some features such...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~15-~15: Try using a more formal synonym here to elevate your writing.
Context: ...ch as const enum, but in the case you plan on using Jest with the cache disabled (`jest --n...
(PLAN_ON_INTEND)
[uncategorized] ~43-~43: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...falsecomes with a cost of performance comparing toisolatedModules: true`. There is a ...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~45-~45: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...which is used byts-jest. The least amount of files which are provided in include...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~58-~58: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...les/*"] } ``` ## Caveats Limiting the amount of files loaded via include can great...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~58-~58: When ‘trade-off’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...rmance when running tests. However, the trade off is ts-jest might not recognize all fi...
(VERB_NOUN_CONFUSION)
[uncategorized] ~59-~59: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...cognize all files which are intended to use with jest. One can run into issues wi...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~63-~63: You might be missing the article “a” here.
Context: ...lob patterns in include, to gain both performance boost and avoid breaking behaviors.
(AI_EN_LECTOR_MISSING_DETERMINER_A)
website/versioned_docs/version-29.4/getting-started/options.md
[uncategorized] ~10-~10: You might be missing the article “a” here.
Context: ...roduction :::caution If you are using custom transform config, please remove `pres...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~14-~14: You might be missing the article “the” here.
Context: ...estspecific options can be defined in Jesttransformconfig object in thepacka...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~31-~31: You might be missing the article “a” here.
Context: ...lt config ``` :::important When using TypeScript Jest config file, Jest will use `ts-nod...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
website/versioned_docs/version-29.4/getting-started/paths-mapping.md
[grammar] ~6-~6: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...aystring) option in your Jest config is setup accordingly. ts-jest provides a help...
(BE_VB_OR_NN)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...tra options as 2nd argument: - prefix: append prefix to each of mapped config ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: You might be missing the article “an” here.
Context: ...son, TypeScript enforces users to have explicit jsextension when importing ats` ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[style] ~71-~71: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...mapping. So you have to make sure those are able to map the paths themselves. ##### Global...
(BE_ABLE_TO)
website/versioned_docs/version-29.4/getting-started/options/babelConfig.md
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...: Babel Config option --- ts-jest by default does NOT use Babel. But you may wan...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~5-~5: “Code” is a singular noun. It appears that the verb form is incorrect.
Context: ...want to use it, especially if your code rely on Babel plugins to make some transform...
(PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT)
[style] ~7-~7: The phrase ‘pretty much’ can be informal. To strengthen your writing, consider removing it or replacing it with an adverb.
Context: ...he option is babelConfig and it works pretty much as the tsconfig option, except that i...
(PRETTY_MUCH)
[uncategorized] ~7-~7: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...pt that it is disabled by default. Here is the possible values it can take: - `fa...
(AI_HYDRA_LEO_CPT_IS_ARE)
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... possible values it can take: - false: the default, disables the use of Babel ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...s to babel-jest processor. - { ... }: inline [Babel options](https://babeljs....
(UNLIKELY_OPENING_PUNCTUATION)
website/versioned_docs/version-29.4/getting-started/options/stringifyContentPathRegex.md
[uncategorized] ~6-~6: You might be missing the article “the” here.
Context: ...ssion pattern used to match the path of file to be transformed. If it matches, the f...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...Whatever file(s) you want to match with stringifyContentPathRegex pattern, you ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...e extension(s) of this/those file(s) to moduleFileExtensions Jest option. ### ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/guides/mock-es6-class.md
[uncategorized] ~7-~7: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...undPlayer = require('./sound-player')`. Therefore creating an instance of the class that ...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~8-~8: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ...like this: new soundPlayer.default(). However if you are mocking the class as suggest...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~39-~39: You might be missing the article “the” here.
Context: ...from './oauth', replace defaultwith imported module name,OAuth2` in this example: ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/contributing.md
[uncategorized] ~8-~8: Possible missing comma found.
Context: ...ository before making a change. Please note we have a code of conduct, please follo...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ...the tests are passing and that you have latest main branch merged in. 2. Update the ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[typographical] ~14-~14: The conjunction “so that” does not have a comma in front.
Context: ...r commits with the one before the review, so that we can see intermediate modifications. ...
(SO_THAT_UNNECESSARY_COMMA)
[uncategorized] ~17-~17: A comma might be missing here.
Context: ...ts-jest, but simply trying to use the library you'll find nothing of value here_ ## ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~23-~23: You might be missing the article “the” here.
Context: ...ting ### Preparing The preparation of E2E test directory is done in `scripts/e2e....
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/guides/troubleshooting.md
[style] ~7-~7: The word “also” tends to be overused. Consider using a formal alternative to strengthen your wording.
Context: ...ssues. Use this guide to resolve them. Please also check Jest [troubleshooting guide](http...
(PLEASE_ALSO_CHECK)
[uncategorized] ~18-~18: A comma might be missing here.
Context: ...f rootDir is referenced correctly. If not add this on your existing jest configur...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~18-~18: The preposition “to” seems more likely in this position.
Context: ...s referenced correctly. If not add this on your existing jest configuration. ```t...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~31-~31: The preposition “in” seems more likely in this position than the preposition “on”.
Context: ...heck if module directories are included on your jest configuration. If not add thi...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_ON_IN)
[uncategorized] ~31-~31: A comma might be missing here.
Context: ...included on your jest configuration. If not add this on your existing jest configur...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~31-~31: The preposition “to” seems more likely in this position.
Context: ...our jest configuration. If not add this on your existing jest configuration. ```t...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~45-~45: You might be missing the article “the” here.
Context: ... export default config ``` - Check if module name is properly mapped and can be refe...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~60-~60: Did you mean “it's” (contraction of ‘it is’)?
Context: ...fig ``` - Check github folder names if its identical to you local folder names. So...
(ITS_PREMIUM)
[uncategorized] ~60-~60: “you” seems less likely than “your” (belonging to you).
Context: ...github folder names if its identical to you local folder names. Sometimes github ne...
(AI_HYDRA_LEO_CP_YOU_YOUR)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...etimes github never updates your folder names even if you rename it locally. If this ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~60-~60: A comma might be missing here.
Context: ... even if you rename it locally. If this happens rename your folders via github or use t...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~66-~66: You might be missing the article “an” here.
Context: ...y ### PROBLEM SyntaxError: Cannot use import statement outside a module ### SOLUTIO...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[formatting] ~80-~80: Consider inserting a comma after an introductory phrase for better readability.
Context: ...les/some-module/lib"; | ^ ``` In this case some-module is the problem and need...
(IN_THAT_CASE_COMMA)
[uncategorized] ~82-~82: Possible missing comma found.
Context: ...the following line to the configuration file it will tell Jest which modules shouldn...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~98-~98: Possible missing comma found.
Context: ...module** will be transformed. For more information see [here](https://stackoverflow.com/qu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~134-~134: Possible missing comma found.
Context: ....ts$': 'ts-jest', }, }; ``` For more information see [here](https://github.com/kulshekha...
(AI_HYDRA_LEO_MISSING_COMMA)
website/versioned_docs/version-29.4/processing.md
[uncategorized] ~6-~6: A comma might be missing here.
Context: ...ts-jest, but simply trying to use the library you'll find nothing of value here_ ## ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
website/versioned_docs/version-29.4/getting-started/options/diagnostics.md
[uncategorized] ~11-~11: Did you mean: “By default,”?
Context: ...and your test. ### Disabling/enabling By default all diagnostics are enabled. This is th...
(BY_DEFAULT_COMMA)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...nfig. key is optional: - warnOnly: If specified and true, diagnostics wi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~21-~21: Loose punctuation mark.
Context: ...efault: disabled). - ignoreCodes: List of TypeScript error codes to ignor...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~21-~21: Possible missing article found.
Context: ...st of TypeScript error codes to ignore. Complete list can be found [there](https://githu...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~21-~21: Did you mean: “By default,”?
Context: .../src/compiler/diagnosticMessages.json). By default here are the ones ignored: - 6059: ...
(BY_DEFAULT_COMMA)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...o contain all source files._ - 18002: _The 'files' list in config file is emp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: You might be missing the article “the” here.
Context: ...les._ - 18002: The 'files' list in config file is empty. (it is strongly recomme...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~24-~24: You might be missing the article “the” here.
Context: ...) - 18003: No inputs were found in config file. - exclude: If specified, d...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...e found in config file._ - exclude: If specified, diagnostics of source fil...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: You might be missing the article “the” here.
Context: ... ignored. This works a bit similar to tsconfig option [exclude](https://www.t...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~27-~27: You might be missing the article “the” here.
Context: ... exclude will also exclude files from compilation process. - pretty: Enables/disabl...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...from compilation process. - pretty: Enables/disables colorful and pretty ou...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~58-~58: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...iles only Assuming all your test files ends with .spec.ts or .test.ts, using th...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[grammar] ~110-~110: Did you mean “these”?
Context: ...json). The ignoreCodes option accepts this values: 1. A single number (example:...
(THIS_TOOLS)
website/versioned_docs/version-29.4/getting-started/presets.md
[misspelling] ~379-~379: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...eateJsWithTsEsmPreset(options)` Create a ESM configuration to process JavaScript...
(EN_A_VS_AN)
[misspelling] ~615-~615: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...eJsWithBabelEsmPreset(options)` Create a ESM configuration to process JavaScript...
(EN_A_VS_AN)
[uncategorized] ~738-~738: Possible missing comma found.
Context: ...esets will be removed in the next major release and users are HIGHLY RECOMMENDED to...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
website/versioned_docs/version-29.4/debugging.md
12-12: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
14-14: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
18-18: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
website/versioned_docs/version-29.4/getting-started/version-checking.md
15-15: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
17-17: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
21-21: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
23-23: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
website/versioned_docs/version-29.4/guides/esm-support.md
68-68: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
127-127: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
185-185: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
website/versioned_docs/version-29.4/getting-started/presets.md
68-68: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
127-127: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
185-185: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
245-245: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
304-304: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
361-361: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
420-420: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
477-477: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
538-538: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
597-597: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
658-658: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
717-717: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (8)
website/versions.json (1)
2-3: Versions list remains correctly ordered—no action needed.
"29.4"is inserted at the top; ordering stays descending, which matches Docusaurus expectations.website/versioned_sidebars/version-29.4-sidebars.json (1)
46-48: Verify doc ID matches filenameJust a heads-up: the standalone entry
debuggingmust correspond toid: debuggingin the doc’s front-matter (and reside at the expected path). Looks correct, but please double-check to avoid broken sidebar links.website/versioned_docs/version-29.4/introduction.md (1)
5-5:slug: /may shadow the root docPlacing this versioned introduction at the site root can override (or clash with) the main docs homepage in Docusaurus. Unless that is intentional, consider changing it to something like
slug: /introor dropping the slug entirely to keep the auto-generated path.website/versioned_docs/version-29.4/getting-started/paths-mapping.md (1)
55-58: ClarifymodulePathsprefix to avoid Jest lookup failures
modulePathsexpects absolute paths. SupplyingcompilerOptions.baseUrlunmodified can break when the file is in a nested workspace. Consider:- modulePaths: [compilerOptions.baseUrl], + modulePaths: [`<rootDir>/${compilerOptions.baseUrl}`],Ensure examples still run after this change in a monorepo layout.
website/versioned_docs/version-29.4/guides/react-native.md (1)
45-54: Confirm availability ofcreateJsWithBabelPresetin public APIDouble-check that
createJsWithBabelPresetis exported in 29.4; otherwise the sample won’t compile. If it’s internal, swap for the documented preset (ts-jest/presets/js-with-babel) instead.website/versioned_docs/version-29.4/getting-started/options.md (1)
40-48: Ensure anchor consistency forisolatedModulesThe reference label
[isolatedmodules]is lowercase whereas the linked document file isisolatedModules.md. Markdown link targets are case-sensitive on some file systems; consider harmonising to avoid broken links.website/versioned_docs/version-29.4/getting-started/options/diagnostics.md (2)
25-27: Double-checkexcludesemantics
excluderemoves diagnostics for matching files, but the doc later uses a negated glob (!**/*.(spec|test).ts) to enable diagnostics only for tests. Please verify this example actually works withts-jest; users might mis-configure and silently suppress all diagnostics.
71-73: Suspicious glob pattern
Using a leading!inside the array means “exclude everything except …” only if the matcher supports extglob negation. Confirm this is the intended behaviour; if not, use the positive pattern['**/*.(spec|test).ts'].
ahnpnl
force-pushed
the
docs/bump-doc-version
branch
from
9460597 to
fad0fc7
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
website/versioned_docs/version-29.2/getting-started/presets.md (1)
59-63: Incorrect regex escape sequence
'^.+.tsx?$'matches any two characters; the.should be escaped.- '^.+.tsx?$': ['ts-jest', TsJestTransformerOptions] + '^.+\\.tsx?$': ['ts-jest', TsJestTransformerOptions]
♻️ Duplicate comments (1)
website/versioned_docs/version-29.4/getting-started/presets.md (1)
129-134: Legacy example still calls the wrong factory & has the “optionsa” typo
Same issue flagged previously – the example should callcreateDefaultLegacyPresetand useoptions.
🧹 Nitpick comments (53)
website/versioned_docs/version-29.4/guides/mock-es6-class.md (2)
6-8: Polish opening paragraph for clarity & punctuationA few minor wording and punctuation tweaks improve readability and address the issues flagged by LanguageTool.
-TypeScript is transpiling your ts file and your module is likely being imported using ES2015s import. -`const soundPlayer = require('./sound-player')`. Therefore creating an instance of the class that was exported as -a default will look like this: `new soundPlayer.default()`. However if you are mocking the class as suggested by the documentation. +TypeScript transpiles your `.ts` file, and the module is likely imported using the ES2015 import syntax. +`const soundPlayer = require('./sound-player')`. Therefore, creating an instance of the class that was exported as +a default will look like this: `new soundPlayer.default()`. However, if you are mocking the class as suggested by the documentation,
39-41: Add missing article & tighten wording-For named imports, like `import { OAuth2 } from './oauth'`, replace `default` with imported module name, `OAuth2` in this example: +For named imports, such as `import { OAuth2 } from './oauth'`, replace `default` with the imported module name (`OAuth2` in this example):website/versioned_docs/version-29.4/getting-started/version-checking.md (3)
8-8: Polish the deprecation sentence for clarity & article usageMinor language tweaks improve readability and fix the missing article “the”.
-The version checking is **DEPRECATED** in favor of native `peerDependencies` checking mechanism in `package.json`. +Version checking is **DEPRECATED** in favor of the native `peerDependencies` checking mechanism in `package.json`.
12-13: Fix grammar and awkward phrasing in the compatibility-warning paragraphThe current wording is ungrammatical and slightly confusing.
-By default, `ts-jest` supports a range of versions for `jest`/`typescript`. One uses incompatible versions will receive a warning -message while running tests. This warning message can be opt-out by setting environment variable `TS_JEST_DISABLE_VER_CHECKER`: +By default, `ts-jest` supports a range of versions for `jest` and `typescript`. Using incompatible versions will result in a warning +message when running tests. You can opt out of this warning by setting the environment variable `TS_JEST_DISABLE_VER_CHECKER`:
15-25: Replace bold styling with sub-headings & add fenced-code languagesUsing emphasis as headings violates MD036; adding code-block languages fixes MD040 and improves highlighting.
-**Linux/MacOS** - -``` -export TS_JEST_DISABLE_VER_CHECKER=true -``` - -**Windows** - -``` -set TS_JEST_DISABLE_VER_CHECKER=true -``` +#### Linux/macOS + +```bash +export TS_JEST_DISABLE_VER_CHECKER=true +``` + +#### Windows + +```powershell +set TS_JEST_DISABLE_VER_CHECKER=true +```website/versioned_docs/version-29.4/debugging.md (3)
7-8: Missing definite articleInsert “the” before current working directory for grammatical correctness.
- The output of the logger will be in **ts-jest.log** in current working directory. + The output of the logger will be in **ts-jest.log** in **the** current working directory.
12-16: Treat platform names as headings and add a language to the fenced blockUsing emphasis as a heading breaks MD036 and hurts accessibility. Prefer a proper heading and specify the shell language.
-**Linux/MacOS** - -``` -export TS_JEST_LOG=ts-jest.log -``` +### Linux / macOS + +```bash +export TS_JEST_LOG=ts-jest.log +```
18-26: Standardise Windows examples & fence languagesUse level-3 headings like above and tag command blocks with the appropriate language for syntax highlighting.
-**Windows** - -```Command Prompt tab -set TS_JEST_LOG=ts-jest.log -``` - -```PowerShell tab -$env:TS_JEST_LOG = 'ts-jest.log' -``` +### Windows (Command Prompt) + +```cmd +set TS_JEST_LOG=ts-jest.log +``` + +### Windows (PowerShell) + +```powershell +$env:TS_JEST_LOG = 'ts-jest.log' +```website/versioned_docs/version-29.4/getting-started/options/tsconfig.md (2)
7-9: Comma after “By default” for readability-By default `ts-jest` will try to find a `tsconfig.json` in your project. +By default, `ts-jest` will try to find a `tsconfig.json` in your project.Repeat the same change on line 65.
65-66: Insert missing article-...and keep TypeScript default options. +...and keep the TypeScript default options.website/versioned_docs/version-29.4/processing.md (1)
6-6: Add a clarifying comma-_These are internal technical documents. If you're not a contributor to `ts-jest`, but simply trying to use the library you'll find nothing of value here_ +_These are internal technical documents. If you're not a contributor to `ts-jest`, but simply trying to use the library, you'll find nothing of value here_website/versioned_docs/version-29.4/contributing.md (3)
6-9: Comma before “please” for smoother flow-Please note we have a code of conduct, please follow it in all your interactions with the project. +Please note we have a code of conduct; please follow it in all your interactions with the project.
12-14: Insert missing article-Ensure the tests are passing and that you have latest `main` branch merged in. +Ensure the tests are passing and that you have the latest `main` branch merged in.
14-15: Remove superfluous comma before “so that”-DO NOT squash your commits with the one before the review, so that we can see intermediate modifications. +DO NOT squash your commits with the one before the review so that we can see intermediate modifications.website/versioned_docs/version-29.2/getting-started/presets.md (1)
128-130: Typo: stray character “a”- //...optionsa + //...optionswebsite/versioned_docs/version-29.4/getting-started/options/compiler.md (2)
5-8: Use the correct “Node.js” spellingMinor wording nit – “NodeJS” should be written as “Node.js” in official docs.
- It’ll be used to load the NodeJS module holding the TypeScript compiler. + It’ll be used to load the Node.js module that provides the TypeScript compiler.
10-11: Clarify compatibility requirementConsider tightening the wording to avoid ambiguity.
- make sure its API is the same as the original TypeScript, at least for what `ts-jest` is using. + ensure its public API remains compatible with the original TypeScript for the subset that `ts-jest` consumes.website/versioned_docs/version-29.4/guides/hybrid-node-module.md (2)
6-9: Capitalize “CommonJS” consistentlyThe module format is conventionally written “CommonJS”.
- There will be a few differences from traditional `CommonJs`, + There will be a few differences from traditional `CommonJS`,
15-15: Tone down emphasis and improve phrasingAll-caps “WON'T” is a bit shouty for docs. Prefer plain language.
- e.g. `dynamic import` **WON'T** be transformed into `Promise` and `require`. + e.g. a `dynamic import` call will not be transformed into a `Promise`-based `require`.website/versioned_docs/version-29.4/introduction.md (2)
10-10: Insert missing comma for readability- It supports all features of TypeScript including type-checking. + It supports all features of TypeScript, including type-checking.
14-15: Re-phrase version-downgrade noteThe current sentence is long and hard to parse. Consider splitting and clarifying.
-We are not doing semantic versioning and `23.10` is a re-write, run `npm i -D ts-jest@"<23.10.0"` to go back to the previous version +`ts-jest` does not follow strict semantic versioning. Version `23.10` was a full rewrite. If you need the legacy implementation, install it with +```bash +npm i -D ts-jest@"<23.10.0" +```website/versioned_docs/version-29.4/getting-started/installation.md (3)
16-18: Remove duplicated word and fix comma splice- you can replace `npx XXX` with `node node_modules/.bin/XXX` from the root of your project. + you can replace `npx XXX` with `node node_modules/.bin/XXX`, executed from your project root.
45-47: Prefer “whether” over “whether or not”, swap to American English “afterward”- answer `no` to the Jest question about whether or not to enable TypeScript. Instead, add the line: `preset: "ts-jest"` to the `jest.config.js` file afterwards. + answer `no` when Jest asks whether to enable TypeScript. Then add `preset: "ts-jest"` to `jest.config.js` afterward.
50-51: Update outdated Jest docs linkThe current URL still points to the v26 path. Jest ≥29 uses
/docs/configuration.
Please update the link to avoid a redirect.website/versioned_docs/version-29.4/getting-started/options/astTransformers.md (3)
5-6: Grammar: use base verb form and add article- `ts-jest` by default does hoisting for a few `jest` methods via a TypeScript AST transformer. + `ts-jest` by default performs hoisting for several `jest` methods via a TypeScript AST transformer.- and provide them to `ts-jest` to include into compilation process. + and provide them to `ts-jest` to include in the compilation process.
8-10: Tighten wording & number style- it allows ones to specify which 3 types of TypeScript AST transformers to use with `ts-jest`: + it lets you specify three categories of TypeScript AST transformers to use with `ts-jest`:
76-79: Singular/plural agreement- To write a custom TypeScript AST transformers, one can take a look at + To write a custom TypeScript AST transformer, you can look atwebsite/versioned_docs/version-29.4/getting-started/options/stringifyContentPathRegex.md (3)
5-7: Refine wording & missing determinersA couple of small grammar glitches make the opening paragraph harder to read.
-The `stringifyContentPathRegex` option has been kept for backward compatibility of `__HTML_TRANSFORM__` -It's a regular expression pattern used to match the path of file to be transformed. +The `stringifyContentPathRegex` option is retained for backward compatibility with the `__HTML_TRANSFORM__` feature. +It is a regular-expression pattern used to match the paths of files to be transformed.
11-12: Insert missing article for clarity-**CAUTION**: Whatever file(s) you want to match with `stringifyContentPathRegex` pattern, you must ensure the Jest `transform` option pointing to `ts-jest` matches them. +**CAUTION**: For any file(s) you want to match with **the** `stringifyContentPathRegex` pattern, you must ensure the Jest `transform` option pointing to `ts-jest` matches them.
15-17: Rephrase for readabilityThe sentence is long and slightly confusing.
-In the `jest.config.js` version, you could do as in the `package.json` version of the config, but extending from the preset will ensure more compatibility without any changes when updating. +When using a dedicated `jest.config.js` (or `.ts`) file you can replicate the same settings you would place in `package.json`, but extending from the preset provides better forward-compatibility and usually requires no changes when upgrading.website/versioned_docs/version-29.4/getting-started/paths-mapping.md (3)
6-6: Use “set up” (verb) instead of “setup” (noun)-...option in your Jest config is setup accordingly. +...option in your Jest config is set up accordingly.
56-58: Guard against missingbaseUrlIf
compilerOptions.baseUrlis absent,modulePaths: [compilerOptions.baseUrl]will injectundefinedand break resolution. Consider adding a defensive null-check (or dropmodulePathsentirely whenbaseUrlis not defined).- modulePaths: [compilerOptions.baseUrl], // <-- This will be set to 'baseUrl' value + ...(compilerOptions.baseUrl && { modulePaths: [compilerOptions.baseUrl] }),
71-73: Tiny grammar fixes-Files used for [`globalSetup`](...) or [`globalTeardown`](...) are not directly processes by `jest`, so those do not use the ... +Files used for [`globalSetup`](...) or [`globalTeardown`](...) are not processed directly by Jest, so they do not use the ...website/versioned_docs/version-29.4/getting-started/options/babelConfig.md (2)
5-8: Subject-verb agreement & tone-`ts-jest` by default does **NOT** use Babel. But you may want to use it, especially if your code rely on Babel plugins to make some transformations. `ts-jest` can call the BabelJest processor once TypeScript has transformed the source into JavaScript. +`ts-jest` does **not** use Babel by default, yet you may need it when your code relies on Babel plugins for additional transformations. After TypeScript compiles the source to JavaScript, `ts-jest` can delegate the file to `babel-jest`. - -The option is `babelConfig` and it works pretty much as the `tsconfig` option, except that it is disabled by default. Here is the possible values it can take: +The `babelConfig` option behaves similarly to `tsconfig`, except it is disabled by default. Here are the possible values:
39-41: Remove unnecessary back-slash before<rootDir>The escaped back-slash renders literally in the docs.
-The path should be relative to the current working directory where you start Jest from. You can also use `\<rootDir>` in the path, or use an absolute path (this last one is strongly not recommended). +The path should be relative to the current working directory where you start Jest. You can also use `<rootDir>` in the path, or an absolute path (the latter is strongly discouraged).website/versioned_docs/version-29.4/guides/troubleshooting.md (5)
14-15: Placeholder error message looks unfinished
""placeholders won’t help users recognise the real error. Consider inserting an actual sample, e.g.-Cannot find module "" from "" +Cannot find module '<your-module>' from '<test-file>'
18-20: Comma & preposition tweaks-Check if `rootDir` is referenced correctly. If not add this on your existing jest configuration. +Check whether `rootDir` is referenced correctly; if not, add it to your existing Jest configuration.
31-33: Use “in” instead of “on”-Check if module directories are included on your jest configuration. +Check whether the required module directories are included in your Jest configuration.
60-61: Fix possessive & typo-Check github folder names if its identical to you local folder names. +Check GitHub folder names; if they are not identical to your local folder names,
70-73: Grammar & apostrophe in “Jest's”-One of the node modules hasn't the correct syntax for Jests execution step. It needs to +One of the node modules does not have the correct syntax for Jest's execution step and needs to be transformed first.website/versioned_docs/version-29.4/getting-started/options.md (3)
10-11: Insert missing article-If you are using custom `transform` config, please remove `preset` from your Jest config +If you are using a custom `transform` config, please remove `preset` from your Jest config
14-15: Add “the” beforetransform-All `ts-jest` specific options can be defined in Jest `transform` config object ... +All `ts-jest`-specific options can be defined in the Jest `transform` config object ...
31-33: Minor article insertion-When using TypeScript Jest config file, Jest will use `ts-node` to compile the config file. +When using a TypeScript Jest config file, Jest will use `ts-node` to compile the config file.website/versioned_docs/version-29.4/babel7-or-ts.md (2)
6-8: Missing comma & spacing around “Babel 7”
“In Sept. 2018 Babel7 got released …” → “In Sept. 2018, Babel 7 was released …”
This tiny tweak improves readability and matches the official spacing of “Babel 7”.-In Sept. 2018 Babel7 got released with an interesting preset: `@babel/preset-typescript`. +In Sept. 2018, Babel 7 was released with an interesting preset: `@babel/preset-typescript`.
10-16: Heading-level jump (MD001)
## Limitationsis followed by#### No type-checking(h2 → h4). Increment by one level to keep the hierarchy intact.-#### No type-checking +### No type-checkingRepeat for the subsequent
####headings in this section.website/versioned_docs/version-29.4/getting-started/options/isolatedModules.md (2)
5-9: Minor wording fixes
- “use
isolatedModulesoption” → “use theisolatedModulesoption”.- “By default
ts-jestuses” → “By default,ts-jestuses”.
Tiny grammar tweaks that make the paragraph flow better.-Please use `isolatedModules` option in `tsconfig.json` instead. +Please use the `isolatedModules` option in `tsconfig.json` instead. -By default `ts-jest` uses +By default, `ts-jest` uses
43-46: “amount of files” → “number of files”
Use “number” for countable nouns.-The least amount of files which are provided in `include`, the more performance the test run can gain. +The fewer files provided in `include`, the more performance the test run can gain.website/versioned_docs/version-29.4/guides/esm-support.md (2)
8-11: Wordiness & grammar
“take into account of” → “take into account”.
Also add the missing article before tsconfig:-Jest will take into account of the following things when working with ESM: +Jest will take into account the following factors when working with ESM:
56-62: Double word typo – “with with”-Execute Jest with with `--experimental-vm-modules` flag for `NodeJs` +Execute Jest with the `--experimental-vm-modules` flag for Node.jswebsite/versioned_docs/version-29.4/getting-started/options/diagnostics.md (2)
58-60: Subject/verb agreement
“all your test files ends” → “all your test files end”.-Assuming all your test files ends with `.spec.ts` or `.test.ts`, using the following config will enable error reporting only for those files: +Assuming all your test files end with `.spec.ts` or `.test.ts`, the following config enables error reporting only for those files:
110-114: “this values” → “these values”-The `ignoreCodes` option accepts this values: +The `ignoreCodes` option accepts these values:website/versioned_docs/version-29.4/getting-started/presets.md (2)
61-65: Missing escape in glob pattern
'^.+.tsx?$'treats “.” as “any character”. Escape the dot to match file extensions precisely.- '^.+.tsx?$': ['ts-jest', TsJestTransformerOptions] + '^.+\\.tsx?$': ['ts-jest', TsJestTransformerOptions]
379-381: Indefinite article – “a ESM” → “an ESM”-Create a ESM configuration to process +Create an ESM configuration to processApply the same fix for the Babel-ESM section (lines 615-617).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
website/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (35)
website/docs/getting-started/installation.md(1 hunks)website/docs/getting-started/presets.md(1 hunks)website/docs/guides/react-native.md(1 hunks)website/versioned_docs/version-29.0/guides/react-native.md(1 hunks)website/versioned_docs/version-29.2/getting-started/presets.md(13 hunks)website/versioned_docs/version-29.2/guides/react-native.md(2 hunks)website/versioned_docs/version-29.3/getting-started/presets.md(1 hunks)website/versioned_docs/version-29.3/guides/react-native.md(1 hunks)website/versioned_docs/version-29.4/babel7-or-ts.md(1 hunks)website/versioned_docs/version-29.4/contributing.md(1 hunks)website/versioned_docs/version-29.4/debugging.md(1 hunks)website/versioned_docs/version-29.4/getting-started/installation.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/astTransformers.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/babelConfig.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/compiler.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/diagnostics.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/isolatedModules.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/stringifyContentPathRegex.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/tsconfig.md(1 hunks)website/versioned_docs/version-29.4/getting-started/options/useESM.md(1 hunks)website/versioned_docs/version-29.4/getting-started/paths-mapping.md(1 hunks)website/versioned_docs/version-29.4/getting-started/presets.md(1 hunks)website/versioned_docs/version-29.4/getting-started/version-checking.md(1 hunks)website/versioned_docs/version-29.4/guides/esm-support.md(1 hunks)website/versioned_docs/version-29.4/guides/hybrid-node-module.md(1 hunks)website/versioned_docs/version-29.4/guides/mock-es6-class.md(1 hunks)website/versioned_docs/version-29.4/guides/react-native.md(1 hunks)website/versioned_docs/version-29.4/guides/troubleshooting.md(1 hunks)website/versioned_docs/version-29.4/guides/using-with-monorepo.md(1 hunks)website/versioned_docs/version-29.4/introduction.md(1 hunks)website/versioned_docs/version-29.4/migration.md(1 hunks)website/versioned_docs/version-29.4/processing.md(1 hunks)website/versioned_sidebars/version-29.4-sidebars.json(1 hunks)website/versions.json(1 hunks)
✅ Files skipped from review due to trivial changes (8)
- website/versioned_docs/version-29.3/getting-started/presets.md
- website/docs/guides/react-native.md
- website/docs/getting-started/presets.md
- website/versioned_docs/version-29.3/guides/react-native.md
- website/versioned_docs/version-29.0/guides/react-native.md
- website/versioned_docs/version-29.4/migration.md
- website/versioned_docs/version-29.4/guides/using-with-monorepo.md
- website/versioned_docs/version-29.2/guides/react-native.md
🚧 Files skipped from review as they are similar to previous changes (5)
- website/versions.json
- website/docs/getting-started/installation.md
- website/versioned_sidebars/version-29.4-sidebars.json
- website/versioned_docs/version-29.4/getting-started/options/useESM.md
- website/versioned_docs/version-29.4/guides/react-native.md
🧰 Additional context used
🪛 LanguageTool
website/versioned_docs/version-29.4/getting-started/presets.md
[misspelling] ~379-~379: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...eateJsWithTsEsmPreset(options)` Create a ESM configuration to process JavaScript...
(EN_A_VS_AN)
[misspelling] ~615-~615: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...eJsWithBabelEsmPreset(options)` Create a ESM configuration to process JavaScript...
(EN_A_VS_AN)
[uncategorized] ~738-~738: Possible missing comma found.
Context: ...esets will be removed in the next major release and users are HIGHLY RECOMMENDED to...
(AI_HYDRA_LEO_MISSING_COMMA)
website/versioned_docs/version-29.4/babel7-or-ts.md
[uncategorized] ~6-~6: A comma might be missing here.
Context: ...tle: Babel7 or TypeScript --- In Sept. 2018 Babel7 got released with an interesting...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
website/versioned_docs/version-29.4/contributing.md
[uncategorized] ~8-~8: Possible missing comma found.
Context: ...ository before making a change. Please note we have a code of conduct, please follo...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ...the tests are passing and that you have latest main branch merged in. 2. Update the ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[typographical] ~14-~14: The conjunction “so that” does not have a comma in front.
Context: ...r commits with the one before the review, so that we can see intermediate modifications. ...
(SO_THAT_UNNECESSARY_COMMA)
[uncategorized] ~17-~17: A comma might be missing here.
Context: ...ts-jest, but simply trying to use the library you'll find nothing of value here_ ## ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~23-~23: You might be missing the article “the” here.
Context: ...ting ### Preparing The preparation of E2E test directory is done in `scripts/e2e....
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/debugging.md
[uncategorized] ~7-~7: You might be missing the article “the” here.
Context: ...he logger will be in ts-jest.log in current working directory. The debug logger co...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~12-~12: The operating system from Apple is written “macOS”.
Context: ...TypeScript config is used etc. Linux/MacOS ``` export TS_JEST_LOG=ts-jest.log `...
(MAC_OS)
website/versioned_docs/version-29.4/getting-started/installation.md
[uncategorized] ~16-~16: Possible missing comma found.
Context: ...u get an error with the following npm commands such as npx: command not found, you c...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~16-~16: Possible typo: you repeated a word.
Context: ... found, you can replace npx XXXwithnode node_modules/.bin/XXX` from the root of your...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~46-~46: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ... answer no to the Jest question about whether or not to enable TypeScript. Instead, add the ...
(WHETHER)
[locale-violation] ~46-~46: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ..."ts-jest"to thejest.config.js` file afterwards. #### Customizing For customizing jes...
(AFTERWARDS_US)
website/versioned_docs/version-29.4/getting-started/options.md
[uncategorized] ~10-~10: You might be missing the article “a” here.
Context: ...roduction :::caution If you are using custom transform config, please remove `pres...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~14-~14: You might be missing the article “the” here.
Context: ...estspecific options can be defined in Jesttransformconfig object in thepacka...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~31-~31: You might be missing the article “a” here.
Context: ...lt config ``` :::important When using TypeScript Jest config file, Jest will use `ts-nod...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
website/versioned_docs/version-29.4/getting-started/options/astTransformers.md
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...T transformers option --- ts-jest by default does hoisting for a few jest methods ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~5-~5: After the auxiliary verb ‘do’, use the base form of a verb. Did you mean “hoist”?
Context: ...s option --- ts-jest by default does hoisting for a few jest methods via a TypeScri...
(AUXILIARY_DO_WITH_INCORRECT_VERB_FORM)
[uncategorized] ~6-~6: You might be missing the article “the” here.
Context: ...ovide them to ts-jest to include into compilation process. The option is `astTransformer...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~8-~8: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...tion is astTransformers and it allows ones to specify which 3 types of TypeScript ...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[style] ~13-~13: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ranspiled syntax. - afterDeclarations means your transformers get run during d.ts...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
website/versioned_docs/version-29.4/getting-started/options/babelConfig.md
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...: Babel Config option --- ts-jest by default does NOT use Babel. But you may wan...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~5-~5: “Code” is a singular noun. It appears that the verb form is incorrect.
Context: ...want to use it, especially if your code rely on Babel plugins to make some transform...
(PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT)
[style] ~7-~7: The phrase ‘pretty much’ can be informal. To strengthen your writing, consider removing it or replacing it with an adverb.
Context: ...he option is babelConfig and it works pretty much as the tsconfig option, except that i...
(PRETTY_MUCH)
[uncategorized] ~7-~7: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...pt that it is disabled by default. Here is the possible values it can take: - `fa...
(AI_HYDRA_LEO_CPT_IS_ARE)
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... possible values it can take: - false: the default, disables the use of Babel ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...s to babel-jest processor. - { ... }: inline [Babel options](https://babeljs....
(UNLIKELY_OPENING_PUNCTUATION)
website/versioned_docs/version-29.4/getting-started/options/compiler.md
[uncategorized] ~5-~5: The official spelling of this programming framework is “Node.js”.
Context: ...r to be used. It'll be used to load the NodeJS module holding the TypeScript compiler....
(NODE_JS)
website/versioned_docs/version-29.4/getting-started/options/diagnostics.md
[uncategorized] ~11-~11: Did you mean: “By default,”?
Context: ...and your test. ### Disabling/enabling By default all diagnostics are enabled. This is th...
(BY_DEFAULT_COMMA)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...nfig. key is optional: - warnOnly: If specified and true, diagnostics wi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~21-~21: Loose punctuation mark.
Context: ...efault: disabled). - ignoreCodes: List of TypeScript error codes to ignor...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~21-~21: Possible missing article found.
Context: ...st of TypeScript error codes to ignore. Complete list can be found [there](https://githu...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~21-~21: Did you mean: “By default,”?
Context: .../src/compiler/diagnosticMessages.json). By default here are the ones ignored: - 6059: ...
(BY_DEFAULT_COMMA)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...o contain all source files._ - 18002: _The 'files' list in config file is emp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: You might be missing the article “the” here.
Context: ...les._ - 18002: The 'files' list in config file is empty. (it is strongly recomme...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~24-~24: You might be missing the article “the” here.
Context: ...) - 18003: No inputs were found in config file. - exclude: If specified, d...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...e found in config file._ - exclude: If specified, diagnostics of source fil...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: You might be missing the article “the” here.
Context: ... ignored. This works a bit similar to tsconfig option [exclude](https://www.t...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~27-~27: You might be missing the article “the” here.
Context: ... exclude will also exclude files from compilation process. - pretty: Enables/disabl...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...from compilation process. - pretty: Enables/disables colorful and pretty ou...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~58-~58: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...iles only Assuming all your test files ends with .spec.ts or .test.ts, using th...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[grammar] ~110-~110: Did you mean “these”?
Context: ...json). The ignoreCodes option accepts this values: 1. A single number (example:...
(THIS_TOOLS)
website/versioned_docs/version-29.4/getting-started/options/isolatedModules.md
[uncategorized] ~7-~7: You might be missing the article “the” here.
Context: ...in the next major release. Please useisolatedModulesoption intsconfig.jso...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~10-~10: Did you mean: “By default,”?
Context: ...ption in tsconfig.json instead. ::: By default ts-jest uses TypeScript compiler in t...
(BY_DEFAULT_COMMA)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...nstead. ::: By default ts-jest uses TypeScript compiler in the context of a project (y...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~15-~15: You might be missing the article “the” here.
Context: ...defaults to false) does. You'll lose type-checking ability and some features such...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~15-~15: Try using a more formal synonym here to elevate your writing.
Context: ...ch as const enum, but in the case you plan on using Jest with the cache disabled (`jest --n...
(PLAN_ON_INTEND)
[uncategorized] ~43-~43: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...falsecomes with a cost of performance comparing toisolatedModules: true`. There is a ...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~45-~45: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...which is used byts-jest. The least amount of files which are provided in include...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~58-~58: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...les/*"] } ``` ## Caveats Limiting the amount of files loaded via include can great...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~58-~58: When ‘trade-off’ is used as a noun or modifier, it needs to be hyphenated.
Context: ...rmance when running tests. However, the trade off is ts-jest might not recognize all fi...
(VERB_NOUN_CONFUSION)
[uncategorized] ~59-~59: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...cognize all files which are intended to use with jest. One can run into issues wi...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~63-~63: You might be missing the article “a” here.
Context: ...lob patterns in include, to gain both performance boost and avoid breaking behaviors.
(AI_EN_LECTOR_MISSING_DETERMINER_A)
website/versioned_docs/version-29.4/getting-started/options/stringifyContentPathRegex.md
[uncategorized] ~6-~6: You might be missing the article “the” here.
Context: ...ssion pattern used to match the path of file to be transformed. If it matches, the f...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...Whatever file(s) you want to match with stringifyContentPathRegex pattern, you ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...e extension(s) of this/those file(s) to moduleFileExtensions Jest option. ### ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/getting-started/options/tsconfig.md
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ...o be specified instead of a file path. By default ts-jest will try to find a `tsconfig....
(BY_DEFAULT_COMMA)
[uncategorized] ~65-~65: Did you mean: “By default,”?
Context: ...stConfig ``` #### Disable auto-lookup By default ts-jest will try to find a `tsconfig....
(BY_DEFAULT_COMMA)
[uncategorized] ~66-~66: You might be missing the article “the” here.
Context: ... may not want to use it at all and keep TypeScript default options. You can achieve this b...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/getting-started/paths-mapping.md
[grammar] ~6-~6: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...aystring) option in your Jest config is setup accordingly. ts-jest provides a help...
(BE_VB_OR_NN)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...tra options as 2nd argument: - prefix: append prefix to each of mapped config ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: You might be missing the article “an” here.
Context: ...son, TypeScript enforces users to have explicit jsextension when importing ats` ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[style] ~71-~71: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...mapping. So you have to make sure those are able to map the paths themselves. ##### Global...
(BE_ABLE_TO)
website/versioned_docs/version-29.4/getting-started/version-checking.md
[uncategorized] ~8-~8: You might be missing the article “the” here.
Context: ... checking is DEPRECATED in favor of native peerDependencies checking mechanism i...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ...rning message can be opt-out by setting environment variable TS_JEST_DISABLE_VER_CHECKER:...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~15-~15: The operating system from Apple is written “macOS”.
Context: ...TS_JEST_DISABLE_VER_CHECKER: Linux/MacOS ``` export TS_JEST_DISABLE_VER_CHECK...
(MAC_OS)
website/versioned_docs/version-29.4/guides/esm-support.md
[style] ~8-~8: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...SM Support --- :::important Jest will take into account of the following things when working wi...
(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...s/en/ecmascript-modules) - The value of module option in tsconfig file is eithe...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~34-~34: You might be missing the article “the” here.
Context: ... ## Configure Jest runtime :::warning Jest runtime currently has a few issues rela...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~35-~35: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e currently has a few issues related to support ESM: - Not taking into account of `typ...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[style] ~37-~37: ‘taking into account’ might be wordy. Consider a shorter alternative.
Context: ...w issues related to support ESM: - Not taking into account of type: "module" field in `package.j...
(EN_WORDINESS_PREMIUM_TAKING_INTO_ACCOUNT)
[duplication] ~56-~56: Possible typo: you repeated a word.
Context: ...tall -D ts-node ``` ::: Execute Jest with with --experimental-vm-modules flag for `N...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~135-~135: You might be missing the article “the” here.
Context: ... ESM files from node_modules with default jest-resolve which usually works for ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~187-~187: You might be missing the article “the” here.
Context: ...ve .mjs/.mts extensions To work with .mts extension, besides the requirement...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/guides/hybrid-node-module.md
[style] ~10-~10: For conciseness, consider replacing this expression with an adverb.
Context: ...emitted code looks like. :::important At the moment, ts-jest uses TypeScript API to trans...
(AT_THE_MOMENT)
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...mportant At the moment, ts-jest uses TypeScript API to transpile code so the emitted `j...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~11-~11: Possible missing comma found.
Context: ...-jestuses TypeScript API to transpile code so the emittedjs` code depends on the...
(AI_HYDRA_LEO_MISSING_COMMA)
website/versioned_docs/version-29.4/guides/mock-es6-class.md
[uncategorized] ~7-~7: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...undPlayer = require('./sound-player')`. Therefore creating an instance of the class that ...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~8-~8: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ...like this: new soundPlayer.default(). However if you are mocking the class as suggest...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~39-~39: You might be missing the article “the” here.
Context: ...from './oauth', replace defaultwith imported module name,OAuth2` in this example: ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
website/versioned_docs/version-29.4/guides/troubleshooting.md
[style] ~7-~7: The word “also” tends to be overused. Consider using a formal alternative to strengthen your wording.
Context: ...ssues. Use this guide to resolve them. Please also check Jest [troubleshooting guide](http...
(PLEASE_ALSO_CHECK)
[uncategorized] ~18-~18: A comma might be missing here.
Context: ...f rootDir is referenced correctly. If not add this on your existing jest configur...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~18-~18: The preposition “to” seems more likely in this position.
Context: ...s referenced correctly. If not add this on your existing jest configuration. ```t...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~31-~31: The preposition “in” seems more likely in this position than the preposition “on”.
Context: ...heck if module directories are included on your jest configuration. If not add thi...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_ON_IN)
[uncategorized] ~31-~31: A comma might be missing here.
Context: ...included on your jest configuration. If not add this on your existing jest configur...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~31-~31: The preposition “to” seems more likely in this position.
Context: ...our jest configuration. If not add this on your existing jest configuration. ```t...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~45-~45: You might be missing the article “the” here.
Context: ... export default config ``` - Check if module name is properly mapped and can be refe...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~60-~60: Did you mean “it's” (contraction of ‘it is’)?
Context: ...fig ``` - Check github folder names if its identical to you local folder names. So...
(ITS_PREMIUM)
[uncategorized] ~60-~60: “you” seems less likely than “your” (belonging to you).
Context: ...github folder names if its identical to you local folder names. Sometimes github ne...
(AI_HYDRA_LEO_CP_YOU_YOUR)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...etimes github never updates your folder names even if you rename it locally. If this ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~60-~60: A comma might be missing here.
Context: ... even if you rename it locally. If this happens rename your folders via github or use t...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~66-~66: You might be missing the article “an” here.
Context: ...y ### PROBLEM SyntaxError: Cannot use import statement outside a module ### SOLUTIO...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[formatting] ~80-~80: Consider inserting a comma after an introductory phrase for better readability.
Context: ...les/some-module/lib"; | ^ ``` In this case some-module is the problem and need...
(IN_THAT_CASE_COMMA)
[uncategorized] ~82-~82: Possible missing comma found.
Context: ...the following line to the configuration file it will tell Jest which modules shouldn...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~98-~98: Possible missing comma found.
Context: ...module** will be transformed. For more information see [here](https://stackoverflow.com/qu...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~134-~134: Possible missing comma found.
Context: ....ts$': 'ts-jest', }, }; ``` For more information see [here](https://github.com/kulshekha...
(AI_HYDRA_LEO_MISSING_COMMA)
website/versioned_docs/version-29.4/introduction.md
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...ypeScript. It supports all features of TypeScript including type-checking. [Read more abo...
(AI_HYDRA_LEO_MISSING_COMMA)
website/versioned_docs/version-29.4/processing.md
[uncategorized] ~6-~6: A comma might be missing here.
Context: ...ts-jest, but simply trying to use the library you'll find nothing of value here_ ## ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
website/versioned_docs/version-29.4/getting-started/presets.md
68-68: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
127-127: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
185-185: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
245-245: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
304-304: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
361-361: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
420-420: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
477-477: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
538-538: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
597-597: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
658-658: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
717-717: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
website/versioned_docs/version-29.4/babel7-or-ts.md
14-14: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
website/versioned_docs/version-29.4/debugging.md
12-12: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
14-14: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
18-18: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
website/versioned_docs/version-29.4/getting-started/version-checking.md
15-15: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
17-17: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
21-21: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
23-23: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: test-windows (20.x) / Run tests on Node v20.x on windows-latest
- GitHub Check: test-windows (18.x) / Run tests on Node v18.x on windows-latest
- GitHub Check: test-ubuntu (20.x) / Run tests on Node v20.x on ubuntu-latest
- GitHub Check: test-ubuntu (18.x) / Run tests on Node v18.x on ubuntu-latest
|
Summary by CodeRabbit
create-jestfor Jest setup.