这是indexloc提供的服务，不要输入任何密码
Skip to content

chore: update documentation for enforce_extension #85

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

Merged
merged 1 commit into from
Feb 9, 2024
Merged

chore: update documentation for enforce_extension #85

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
18 changes: 11 additions & 7 deletions src/options.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,19 @@ pub struct ResolveOptions {
/// Default `["package.json"]`
pub description_files: Vec<String>,

/// If true, it will not allow extension-less files.
/// So by default `require('./foo')` works if `./foo` has a `.js` extension,
/// but with this enabled only `require('./foo.js')` will work.
/// Set to [EnforceExtension::Enabled] for [ESM Mandatory file extensions](https://nodejs.org/api/esm.html#mandatory-file-extensions).
///
/// Default to `true` when [ResolveOptions::extensions] contains an empty string.
/// Use `Some(false)` to disable the behavior.
/// See <https://github.com/webpack/enhanced-resolve/pull/285>
/// If `enforce_extension` is set to [EnforceExtension::Enabled], resolution will not allow extension-less files.
/// This means `require('./foo.js')` will resolve, while `require('./foo')` will not.
///
/// Default None, which is the same as `Some(false)` when the above empty rule is not applied.
/// The default value for `enforce_extension` is [EnforceExtension::Auto], which is changed upon initialization.
///
/// It changes to [EnforceExtension::Enabled] if [ResolveOptions::extensions] contains an empty string;
/// otherwise, this value changes to [EnforceExtension::Disabled].
///
/// Explicitly set the value to [EnforceExtension::Disabled] to disable this automatic behavior.
///
/// For reference, this behavior is aligned with `enhanced-resolve`. See <https://github.com/webpack/enhanced-resolve/pull/285>.
pub enforce_extension: EnforceExtension,

/// A list of exports fields in description files.
Expand Down