--
Change 1 of 1 by Nicholas Merritt <nimerritt@gmail.com>:
Add note about module resolution using paths
See https://github.com/bazelbuild/rules_typescript/issues/178 for context.
Closes #181
PiperOrigin-RevId: 198575170
diff --git a/README.md b/README.md
index bf3167b..6f5f8f2 100644
--- a/README.md
+++ b/README.md
@@ -199,6 +199,19 @@
will import from `/place.ts`.
+
+Since this is an extension to the vanillia TypeScript compiler, editors which use the TypeScript language services to provide code completion and inline type checking will not be able to resolve the modules. In the above example, adding
+```json
+"paths": {
+ "myworkspace/*": ["*"]
+}
+```
+to `tsconfig.json` will fix the imports for the common case of using absolute paths.
+See https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping for more details on the paths syntax.
+
+Similarly, you can use path mapping to teach the editor how to resolve imports
+from `ts_library` rules which set the `module_name` attribute.
+
## Notes
If you'd like a "watch mode", try https://github.com/bazelbuild/bazel-watcher
