57 lines
3.3 KiB
Markdown
57 lines
3.3 KiB
Markdown
# <img src="http://www.typescriptlang.org/assets/images/icons/apple-touch-icon-180x180.png" height="40" align="right" /> [Plug'n'Play](https://github.com/yarnpkg/rfcs/pull/101) resolver for TypeScript
|
|
|
|
[](https://www.npmjs.com/package/ts-pnp)
|
|
[](https://www.npmjs.com/package/ts-pnp)
|
|
|
|
*This plugin is also available for Webpack ([pnp-webpack-plugin](https://github.com/arcanis/pnp-webpack-plugin)), Jest ([jest-pnp-resolver](https://github.com/arcanis/jest-pnp-resolver)), and Rollup ([rollup-plugin-pnp-resolve](https://github.com/arcanis/rollup-plugin-pnp-resolve))*
|
|
|
|
## Installation
|
|
|
|
```
|
|
yarn add -D ts-pnp
|
|
```
|
|
|
|
## Usage
|
|
|
|
*Note that `ts-pnp` is a low-level package - you shouldn't have to use it unless you're writing a TS compiler host. If you just want to write TypeScript and have it Just Work™, take a look at [`pnp-webpack-plugin`](https://github.com/arcanis/pnp-webpack-plugin#ts-loader-integration) instead.*
|
|
|
|
This package exports a function that can be used to implement the [`resolveModuleName` hook from `CompilerHost`](https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#customizing-module-resolution). It mimics the interface from the one you'd typically use and, as all other PnP plugins, works just fine whether your application is actually running under PnP or not.
|
|
|
|
```js
|
|
import {resolveModuleName} from 'ts-pnp';
|
|
import * as ts from 'typescript';
|
|
|
|
function createCompilerHost(
|
|
compilerOptions: ts.CompilerOptions,
|
|
): ts.CompilerHost {
|
|
const compilerHost = {
|
|
resolveModuleNames,
|
|
resolveTypeReferenceDirectives,
|
|
};
|
|
|
|
return compilerHost;
|
|
|
|
function resolveModuleNames(moduleNames: string[], containingFile: string) {
|
|
return moduleNames.map(moduleName => {
|
|
return resolveModuleName(moduleName, containingFile, compilerOptions, compilerHost, ts.resolveModuleName).resolvedModule;
|
|
});
|
|
}
|
|
|
|
function resolveTypeReferenceDirectives(typeDirectiveNames: string[], containingFile: string) {
|
|
return typeDirectiveNames.map(typeDirectiveName => {
|
|
return resolveModuleName(typeDirectiveName, containingFile, compilerOptions, compilerHost, ts.resolveTypeReferenceDirective).resolvedTypeReferenceDirective;
|
|
});
|
|
}
|
|
}
|
|
```
|
|
|
|
## License (MIT)
|
|
|
|
> **Copyright © 2016 Maël Nison**
|
|
>
|
|
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
>
|
|
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
>
|
|
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|