From 4a9647ea4bd94cf6e82984d0056c387ef91f65ec Mon Sep 17 00:00:00 2001 From: Jack Steam Date: Thu, 28 Nov 2019 16:31:13 -0600 Subject: [PATCH] Update README.md Document that extended tsconfigs are not supported. See #135 --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index e73bd63..eff9fbf 100644 --- a/README.md +++ b/README.md @@ -89,3 +89,18 @@ Note that this will often result in less optimal output. This plugin will currently **not warn for any type violations**. This plugin relies on TypeScript's [transpileModule](https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#a-simple-transform-function) function which basically transpiles TypeScript to JavaScript by stripping any type information on a per-file basis. While this is faster than using the language service, no cross-file type checks are possible with this approach. This also causes issues with emit-less types, see [#28](https://github.com/rollup/rollup-plugin-typescript/issues/28). + +### The `extends` Property + +The `extends` property is not supported. This plugin will only use the `configOptions` present in the config file. +```jsonc +// tsconfig.json +{ + // `configOptions` from `base` will not be imported. + "extends": "./configs/base", + // Only these options will be used. + "configOptions": { + target: "es6" + } +} +```