| | |
|---|
| | | |
|---|
| | | #### Resolver Options |
|---|
| | | |
|---|
| | | | Field | Default | Description | |
|---|
| | | | ---------------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | |
|---|
| | | | alias | [] | A list of module alias configurations or an object which maps key to value | |
|---|
| | | | aliasFields | [] | A list of alias fields in description files | |
|---|
| | | | extensionAlias | {} | An object which maps extension to extension aliases | |
|---|
| | | | cachePredicate | function() { return true }; | A function which decides whether a request should be cached or not. An object is passed to the function with `path` and `request` properties. | |
|---|
| | | | cacheWithContext | true | If unsafe cache is enabled, includes `request.context` in the cache key | |
|---|
| | | | conditionNames | [] | A list of exports field condition names | |
|---|
| | | | descriptionFiles | ["package.json"] | A list of description files to read from | |
|---|
| | | | enforceExtension | false | Enforce that a extension from extensions must be used | |
|---|
| | | | exportsFields | ["exports"] | A list of exports fields in description files | |
|---|
| | | | extensions | [".js", ".json", ".node"] | A list of extensions which should be tried for files | |
|---|
| | | | fallback | [] | Same as `alias`, but only used if default resolving fails | |
|---|
| | | | fileSystem | | The file system which should be used | |
|---|
| | | | fullySpecified | false | Request passed to resolve is already fully specified and extensions or main files are not resolved for it (they are still resolved for internal requests) | |
|---|
| | | | mainFields | ["main"] | A list of main fields in description files | |
|---|
| | | | mainFiles | ["index"] | A list of main files in directories | |
|---|
| | | | modules | ["node_modules"] | A list of directories to resolve modules from, can be absolute path or folder name | |
|---|
| | | | plugins | [] | A list of additional resolve plugins which should be applied | |
|---|
| | | | resolver | undefined | A prepared Resolver to which the plugins are attached | |
|---|
| | | | resolveToContext | false | Resolve to a context instead of a file | |
|---|
| | | | preferRelative | false | Prefer to resolve module requests as relative request and fallback to resolving as module | |
|---|
| | | | preferAbsolute | false | Prefer to resolve server-relative urls as absolute paths before falling back to resolve in roots | |
|---|
| | | | restrictions | [] | A list of resolve restrictions | |
|---|
| | | | roots | [] | A list of root paths | |
|---|
| | | | symlinks | true | Whether to resolve symlinks to their symlinked location | |
|---|
| | | | unsafeCache | false | Use this cache object to unsafely cache the successful requests | |
|---|
| | | | Field | Default | Description | |
|---|
| | | | ------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
|---|
| | | | alias | [] | A list of module alias configurations or an object which maps key to value | |
|---|
| | | | aliasFields | [] | A list of alias fields in description files | |
|---|
| | | | extensionAlias | {} | An object which maps extension to extension aliases | |
|---|
| | | | cachePredicate | function() { return true }; | A function which decides whether a request should be cached or not. An object is passed to the function with `path` and `request` properties. | |
|---|
| | | | cacheWithContext | true | If unsafe cache is enabled, includes `request.context` in the cache key | |
|---|
| | | | conditionNames | [] | A list of exports field condition names | |
|---|
| | | | descriptionFiles | ["package.json"] | A list of description files to read from | |
|---|
| | | | enforceExtension | false | Enforce that a extension from extensions must be used | |
|---|
| | | | exportsFields | ["exports"] | A list of exports fields in description files | |
|---|
| | | | extensions | [".js", ".json", ".node"] | A list of extensions which should be tried for files | |
|---|
| | | | fallback | [] | Same as `alias`, but only used if default resolving fails | |
|---|
| | | | fileSystem | | The file system which should be used | |
|---|
| | | | fullySpecified | false | Request passed to resolve is already fully specified and extensions or main files are not resolved for it (they are still resolved for internal requests) | |
|---|
| | | | mainFields | ["main"] | A list of main fields in description files | |
|---|
| | | | mainFiles | ["index"] | A list of main files in directories | |
|---|
| | | | modules | ["node_modules"] | A list of directories to resolve modules from, can be absolute path or folder name | |
|---|
| | | | plugins | [] | A list of additional resolve plugins which should be applied | |
|---|
| | | | resolver | undefined | A prepared Resolver to which the plugins are attached | |
|---|
| | | | resolveToContext | false | Resolve to a context instead of a file | |
|---|
| | | | preferRelative | false | Prefer to resolve module requests as relative request and fallback to resolving as module | |
|---|
| | | | preferAbsolute | false | Prefer to resolve server-relative urls as absolute paths before falling back to resolve in roots | |
|---|
| | | | restrictions | [] | A list of resolve restrictions | |
|---|
| | | | roots | [] | A list of root paths | |
|---|
| | | | symlinks | true | Whether to resolve symlinks to their symlinked location | |
|---|
| | | | tsconfig | false | TypeScript config for paths mapping. Can be `false` (disabled), `true` (use default `tsconfig.json`), a string path to `tsconfig.json`, or an object with `configFile`, `references`, and `baseUrl` options. Supports JSONC format (comments and trailing commas) like TypeScript compiler. | |
|---|
| | | | tsconfig.configFile | tsconfig.json | Path to the tsconfig.json file | |
|---|
| | | | tsconfig.references | [] | Project references. `'auto'` to load from tsconfig, or an array of paths to referenced projects | |
|---|
| | | | tsconfig.baseUrl | undefined | Override baseUrl from tsconfig.json. If provided, this value will be used instead of the baseUrl in the tsconfig file | |
|---|
| | | | unsafeCache | false | Use this cache object to unsafely cache the successful requests | |
|---|
| | | |
|---|
| | | ## Plugins |
|---|
| | | |
|---|
| | |
|---|
| | | ## Tests |
|---|
| | | |
|---|
| | | ```sh |
|---|
| | | yarn test |
|---|
| | | npm run test |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | ## Passing options from webpack |
|---|
