Skip to content

module: add module.customConditions #57688

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 40 additions & 0 deletions doc/api/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,46 @@ const require = createRequire(import.meta.url);
const siblingModule = require('./sibling-module');
```

### `module.customConditions`

<!-- YAML
added: REPLACEME
-->

* Type: {Set<string>}

The custom resolution conditions specified by the user. The default Node.js conditions are not included.

For example, assuming the following script for `module-customconditions.js`:

```mjs
import module from 'node:module';

if (module.customConditions.has('development')) {
console.warn('warning: running in development mode');
}
```

```cjs
const module = require('node:module');

if (module.customConditions.has('development')) {
console.warn('warning: running in development mode');
}
```

Launching the Node.js process as:

```console
$ node -C development module-customconditions.js
```

Would generate the output:

```text
warning: running in development mode
```

### `module.findPackageJSON(specifier[, base])`

<!-- YAML
Expand Down
16 changes: 16 additions & 0 deletions lib/module.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
'use strict';

const {
ObjectDefineProperty,
SafeArrayIterator,
Set,
} = primordials;
const { getOptionValue } = require('internal/options');
const {
findSourceMap,
getSourceMapsSupport,
Expand All @@ -23,6 +29,16 @@ const { stripTypeScriptTypes } = require('internal/modules/typescript');

Module.register = register;
Module.constants = constants;
ObjectDefineProperty(Module, 'customConditions', {
__proto__: null,
get() {
const value = new Set(new SafeArrayIterator(getOptionValue('--conditions')));
ObjectDefineProperty(this, 'customConditions', { __proto__: null, value, configurable: false });
return value;
},
enumerable: true,
configurable: true,
});
Module.enableCompileCache = enableCompileCache;
Module.findPackageJSON = findPackageJSON;
Module.flushCompileCache = flushCompileCache;
Expand Down
7 changes: 7 additions & 0 deletions test/parallel/test-module-customConditions-empty.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
'use strict';

require('../common');
const assert = require('node:assert');
const { customConditions } = require('module');

assert.deepStrictEqual(customConditions, new Set());
12 changes: 12 additions & 0 deletions test/parallel/test-module-customConditions-multiple.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
'use strict';

// Flags: -C additional -C additional2

require('../common');
const assert = require('node:assert');
const { customConditions } = require('module');

assert.deepStrictEqual(
customConditions,
new Set(['additional', 'additional2'])
);
9 changes: 9 additions & 0 deletions test/parallel/test-module-customConditions-single.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
'use strict';

// Flags: -C additional

require('../common');
const assert = require('node:assert');
const { customConditions } = require('module');

assert.deepStrictEqual(customConditions, new Set(['additional']));
Loading