-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# Conflicts: # package.json # yarn.lock
- Loading branch information
Showing
6 changed files
with
572 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| Copyright 2021 Software Ventures Limited | ||
|
|
||
| Permission to use, copy, modify, and/or distribute this software for any purpose | ||
| with or without fee is hereby granted, provided that the above copyright notice | ||
| and this permission notice appear in all copies. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH | ||
| REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND | ||
| FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, | ||
| INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS | ||
| OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER | ||
| TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF | ||
| THIS SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # resolve-typescript-plugin | ||
|
|
||
| A webpack plugin to resolve TypeScript files imported using the `.js` extension | ||
| when using ESM imports. | ||
|
|
||
| ## Why? | ||
|
|
||
| If you are using webpack in conjunction with TypeScript and ES Modules, you need | ||
| this plugin for full compliance with the ES Modules ecosystem. | ||
|
|
||
| ES Modules require imports to specify the runtime path of the file to be | ||
| imported, including file extension. For TypeScript files, this means that [you | ||
| must import using the extension `.js`][1] even though the source file uses the | ||
| extension `.ts` or `.tsx`. This is because TypeScript compiles to a `.js` file | ||
| that will be used at runtime. | ||
|
|
||
| However, webpack behaves differently, even when configured for ES Modules. | ||
| webpack expects that files will be imported by specifying the compile-time path | ||
| of the file, including the compile-time extension. For TypeScript files this | ||
| will be `.ts` or `.tsx`. Alternatively, webpack expects that files will be | ||
| imported with no extension, in which case webpack will resolve the extension | ||
| automatically according to the [`resolve.extensions` option][2]. Neither of | ||
| these behaviours is consistent with browser or node ES Module environments. | ||
|
|
||
| This plugin extends webpack module resolution so that imports specifying a `.js` | ||
| extension will resolve to the corresponding `.ts` or `.tsx` file if available, | ||
| and fall back to `.js` otherwise. | ||
|
|
||
| If you want to create ES Modules in TypeScript that are consistent between | ||
| webpack, browser, and node environments, use this plugin. | ||
|
|
||
| See [ts-loader#1110][3] for more background on this issue. | ||
|
|
||
| ## Install | ||
|
|
||
| With npm: | ||
|
|
||
| ```bash | ||
| npm install --save-dev resolve-typescript-plugin | ||
| ``` | ||
|
|
||
| or yarn: | ||
|
|
||
| ```bash | ||
| yarn add --dev resolve-typescript-plugin | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Configure webpack something like this: | ||
|
|
||
| ```js | ||
| const ResolveTypeScriptPlugin = require("resolve-typescript-plugin").default; | ||
|
|
||
| exports = { | ||
| module: { | ||
| rules: [ | ||
| { | ||
| test: /\.tsx?$/, | ||
| use: "ts-loader" | ||
| } | ||
| ] | ||
| }, | ||
| resolve: { | ||
| fullySpecfied: true, | ||
| plugins: [new ResolveTypeScriptPlugin()] | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| You will also need to have [ts-loader][4] (or another TypeScript loader) | ||
| installed and configured. | ||
|
|
||
| ## Feedback | ||
|
|
||
| We're seeking [community feedback][5] on this plugin. | ||
|
|
||
| Please report bugs, problems, and missing features on the [GitHub Issue | ||
| Tracker][6]. | ||
|
|
||
| [1]: https://github.com/microsoft/TypeScript/issues/16577#issuecomment-703190339 | ||
| [2]: https://github.com/TypeStrong/ts-loader/issues/1110 | ||
| [3]: https://webpack.js.org/configuration/resolve/#resolveextensions | ||
| [4]: https://www.npmjs.com/package/ts-loader | ||
| [5]: https://github.com/softwareventures/resolve-typescript-plugin/issues/5 | ||
| [6]: https://github.com/softwareventures/resolve-typescript-plugin/issues |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import {ResolveOptions} from "webpack"; | ||
|
|
||
| type Resolver = NonNullable<ResolveOptions["resolver"]>; | ||
|
|
||
| const pluginName = "ResolveTypescriptPlugin"; | ||
|
|
||
| export interface ResolveTypescriptPluginOptions { | ||
| includeNodeModules?: boolean; | ||
| } | ||
|
|
||
| export default class ResolveTypescriptPlugin { | ||
| private static defaultOptions: ResolveTypescriptPluginOptions = { | ||
| includeNodeModules: false | ||
| }; | ||
|
|
||
| private options: ResolveTypescriptPluginOptions; | ||
|
|
||
| public constructor(options: ResolveTypescriptPluginOptions = {}) { | ||
| this.options = {...ResolveTypescriptPlugin.defaultOptions, ...options}; | ||
| } | ||
|
|
||
| public apply(resolver: Resolver): void { | ||
| const target = resolver.ensureHook("file"); | ||
| for (const extension of [".ts", ".tsx"]) { | ||
| resolver | ||
| .getHook("raw-file") | ||
| .tapAsync(pluginName, (request, resolveContext, callback) => { | ||
| if ( | ||
| !request.path || | ||
| (!this.options.includeNodeModules && | ||
| request.path.match(/(^|[\\/])node_modules($|[\\/])/)) | ||
| ) { | ||
| return callback(); | ||
| } | ||
|
|
||
| const path = request.path.replace(/\.js$/, extension); | ||
| if (path === request.path) { | ||
| callback(); | ||
| } else { | ||
| resolver.doResolve( | ||
| target, | ||
| { | ||
| ...request, | ||
| path, | ||
| relativePath: | ||
| request.relativePath && | ||
| request.relativePath.replace(/\.js$/, extension) | ||
| }, | ||
| `using path: ${path}`, | ||
| resolveContext, | ||
| callback | ||
| ); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.