Skip to content

docs(register): update options docs #3190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JLHwung wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(register): update options docs #3190

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/register.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ when using features that require it, like generators.
### Ignores `node_modules` by default

**NOTE:** By default all requires to `node_modules` will be ignored. You can
override this by passing an ignore regex via:
override this by passing the [`ignore`](./options.md#ignore) option via:

```js title="JavaScript"
require("@babel/register")({
// This will override `node_modules` ignoring - you can alternatively pass
// an array of strings to be explicitly matched or a regex / glob
// an array of strings to be explicitly matched or a regex / function
ignore: [],
});
```
Expand All @@ -45,7 +45,7 @@ require("@babel/register")({

```js title="JavaScript"
require("@babel/register")({
// Array of ignore conditions, either a regex or a function. (Optional)
// Array of ignore conditions, either a string, regex or a function. (Optional)
// File paths that match any condition are not compiled.
ignore: [
// When a file path matches this regex then it is **not** compiled
Expand All @@ -70,9 +70,9 @@ require("@babel/register")({
},
],

// Setting this will remove the currently hooked extensions of `.es6`, `.es`, `.jsx`, `.mjs`
// and .js so you'll have to add them back if you want them to be used again.
extensions: [".es6", ".es", ".jsx", ".js", ".mjs"],
// Setting this will remove the currently hooked extensions of `.es6`, `.es`, `.jsx`, `.mjs`,
// .cjs and .js so you'll have to add them back if you want them to be used again.
extensions: [".es6", ".es", ".jsx", ".js", ".mjs", ".cjs"],

// Setting this to false will disable the cache.
cache: true,
Expand Down