Path mapping module resolution #5728

vladima · 2015-11-20T05:38:11Z

initial implementation for this proposal: #5039.

- verify that this module resolution strategy works in VSCode
- this strategy does not work with Visual Studio as is but the reason is on the managed side (fix is already submitted). I've verified that once this fix is applied it starts working with with Visual Studio without any changes on the script side (thus check here)

lucamorelli · 2015-11-21T07:15:35Z

I suppose this can solve problems I had using angular2 with jspm with Visual Studio. How can try if this works?

dsebastien · 2015-11-21T19:42:53Z

Great, I'll try this out as soon as it is merged :)

yuit · 2015-11-23T23:55:38Z

src/compiler/program.ts

+    // @file: /a/b/c/generated/form1.content.ts
+    //     export var x = ...
+    // first './form.content.ts' needs to be converted to non-relative name.
+    // 1. convert it to absolute name '/a/b/c/src/form1.content.ts' ->


form1.content.ts is form.content.ts

yuit · 2015-11-24T01:23:20Z

can you add test with suffix in paths matching like

"paths": {
     "generated/*/folder1" : ["build/folder1"]

as well as the case when there are multiple match but we pick the longest one (so we have a record of what we use to do in case of future change)

yuit · 2015-11-24T01:30:16Z

Also what happens in this case:

    "rootDirs": [
        "*",
        "generated/*" 
    ],

is this allowed? if so could we have some tests as well? (from the spec, it seems so. I can't tell from the comment though)
also what happen:

    "rootDirs": [
        "*",
        "generated/*/folder1" 
    ],

vladima · 2015-11-24T05:23:49Z

@yuit

sure, I can add test for path mappings where '*' appear in the middle of the substitution string
"' * ' in rootDirs" this is part that slightly diverges from the spec (I have not updated it yet): since rootDirs are always prefixes, the only shape where '*' makes sense is <prefix> *. To avoid confusion now rootDirs are just strings.

…solution

…eld is not 'string'

…solution

alexeagle · 2016-01-13T00:12:16Z

Can you enable the --traceModuleResolution option when running through the language services?

vladima · 2016-01-13T06:05:56Z

Sure, I'll add it in the next iteration of this PR

…solution

prabirshrestha · 2016-01-21T20:13:12Z

Here is my folder structure

├───app
│       app.ts
│       tsconfig.json
│       webpack.config.js
│
└───libs
    └───guid
        │   package.json
        │
        ├───dist
        │       guid.d.ts
        │       guid.js
        │       guid.js.map
        │
        └───src
                guid.ts
                tsconfig.json

libs/guid/package.json:

{
  "name": "guid",
  "version": "1.0.0",
  "main": "dist/guid.js",
  "typings": "dist/guid.d.ts"
}

app/app.ts:

import guid from 'libs/guid';

console.log(guid());

app/tsconfig.json

{
    "compilerOptions": {
        "declaration": true,
        "module": "commonjs",
        "noImplicitAny": true,
        "removeComments": false,
        "sourceMap": true,
        "outDir": "dist/",
        "target": "es5",
        "moduleResolution": "baseUrl",
        "baseUrl": "",
        "paths": {
            "libs/guid": ["../libs/guid/dist/guid.d.ts"]
        }
    },
    "exclude": [
        "dist"
    ]
}

Rather than specifying paths as "libs/guid": ["../libs/guid/dist/guid.d.ts"] would it be possible to only specify "libs/guid": ["../libs/guid"] and if package.json with typings exists refer to it? This way the libs/guid/package.json controls the entry point rather than caller.

prabirshrestha · 2016-01-21T22:03:53Z

Also how do I set path mappings in csproj?

vladima · 2016-01-21T22:20:42Z

I'm currently making a few adjustments to this PR based on results of the latest design meeting and I think that your initial scenario should be supported. Regarding specifying path mappings in .csproj - this won't work, paths and rootDirs will be options that can be specified only via tsconfig.json

brentyates · 2016-01-22T00:03:12Z

src/compiler/program.ts

+                trace(host, Diagnostics.Module_name_0_matched_pattern_1, moduleName, matchedPattern);
+            }
+
+            for (const subst of compilerOptions.paths[matchedPattern]) {


In your proposal example, it shows paths can be defined as the follows:

"pattern-1": "substitution" | ["list of substitutions"]

However, when const subst of compilerOptions.paths[matchedPattern] is ran, if my path's substitution is a string, of will iterate over each character of the string. Does this need to change or perhaps normalize the compiler options?

the proposal needs to be adjusted - it should always be the list

prabirshrestha · 2016-01-22T00:45:46Z

@vladima Would really love to see it working in csproj since that is what we are using internally.
Or is there any way to tell csproj to use tsconfig.json?

I was expecting something like this in csproj.

<TypeScriptPath>
  <Pattern>libs/guid<Pattern>
  <Substitution>../libs/guid</Substitution>
<TypeScriptPath>

joshuastobaugh57 · 2016-01-22T01:59:18Z

src/compiler/commandLineParser.ts

+        {
+            // this option can only be specified in tsconfig.json
+            // use type = object to copy the value as-is
+            name: "rootDirs",


Leave a line note

…solution

mhegazy · 2016-01-25T21:50:03Z

src/compiler/commandLineParser.ts

            },
            description: Diagnostics.Specifies_module_resolution_strategy_Colon_node_Node_js_or_classic_TypeScript_pre_1_6,
-            error: Diagnostics.Argument_for_moduleResolution_option_must_be_node_or_classic,
+            error: Diagnostics.Argument_for_moduleResolution_option_must_be_node_classic_or_baseUrl,


remove "baseURL" from the message

mhegazy · 2016-01-27T01:09:43Z

👍

Path mapping module resolution

gsaandy · 2016-03-27T03:22:01Z

which version of typescript and gulp-typescript support this?

mhegazy · 2016-03-28T17:19:10Z

which version of typescript

TypeScript@next and should be in the next release TS 2.0

vladima added 3 commits November 18, 2015 21:46

initial implementation of path mapping based module resolution

d2fd643

merge with master

6bed1ba

verbose module resolution

6844285

msftclas added the cla-not-required label Nov 20, 2015

yuit reviewed Nov 23, 2015
View reviewed changes

vladima added 11 commits November 24, 2015 16:02

merge with master

cccdd44

addressed PR feedback

25cc97b

addressed PR feedback

62370a0

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

0377e7a

…solution

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

4e3cba1

…solution

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

cc25f2c

…solution

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

0d0de5a

…solution

fix merge issues

f18e203

merge with master

9a9b51f

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

0130c23

…solution

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

bb9498f

…solution

vladima mentioned this pull request Dec 7, 2015

tsc should give an error if "typings" in package.json is not a string #4828

Closed

vladima added 2 commits December 7, 2015 11:40

merge with origin/master, add trace message with type of 'typings' fi…

2dbf621

…eld is not 'string'

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

6a63c0d

…solution

Matthias247 mentioned this pull request Dec 9, 2015

automatic module resolution for JPSM packages #6012

Closed

vladima added 2 commits December 11, 2015 09:29

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

a81c875

…solution

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

c644fb3

…solution

vladima added 3 commits January 5, 2016 13:34

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

73c94d0

…solution

merge with origin/master

3d4e220

merge with origin/master

39ad077

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

9d828e3

…solution

brentyates reviewed Jan 22, 2016
View reviewed changes

joshuastobaugh57 reviewed Jan 22, 2016
View reviewed changes

vladima added 3 commits January 24, 2016 19:57

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

cb3e93f

…solution

Merge remote-tracking branch 'origin/master' into pathMappingModuleRe…

2b2b150

…solution

update implementation based on the results of design meeting

8a8ed0a

mhegazy reviewed Jan 25, 2016
View reviewed changes

addressed PR feedback

adacad3

vladima added a commit that referenced this pull request Jan 27, 2016

Merge pull request #5728 from Microsoft/pathMappingModuleResolution

f23c35f

Path mapping module resolution

vladima merged commit f23c35f into master Jan 27, 2016

vladima deleted the pathMappingModuleResolution branch January 27, 2016 19:38

adidahiya mentioned this pull request Jan 28, 2016

Path mappings based module resolution #5039

Closed

bySabi mentioned this pull request Feb 20, 2016

[1.3] - How to prevent TypeScript from marking the meteor/PACKAGE_NAME imports as error? meteor/meteor#6177

Closed

Arnavion mentioned this pull request Mar 27, 2016

Importing scoped npm modules without scope name #7695

Closed

Blasz mentioned this pull request Jun 14, 2016

importing is cumbersome for deeply nested components, how do I set up a map to the app root? angular/angular-cli#865

Closed

microsoft locked and limited conversation to collaborators Jun 19, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Path mapping module resolution #5728

Path mapping module resolution #5728

vladima commented Nov 20, 2015

lucamorelli commented Nov 21, 2015

dsebastien commented Nov 21, 2015

yuit Nov 23, 2015

yuit commented Nov 24, 2015

yuit commented Nov 24, 2015

vladima commented Nov 24, 2015

alexeagle commented Jan 13, 2016

vladima commented Jan 13, 2016

prabirshrestha commented Jan 21, 2016

prabirshrestha commented Jan 21, 2016

vladima commented Jan 21, 2016

brentyates Jan 22, 2016

vladima Jan 22, 2016

prabirshrestha commented Jan 22, 2016

joshuastobaugh57 Jan 22, 2016

mhegazy Jan 25, 2016

vladima Jan 27, 2016

mhegazy commented Jan 27, 2016

gsaandy commented Mar 27, 2016

mhegazy commented Mar 28, 2016

Path mapping module resolution #5728

Path mapping module resolution #5728

Conversation

vladima commented Nov 20, 2015

lucamorelli commented Nov 21, 2015

dsebastien commented Nov 21, 2015

yuit Nov 23, 2015

Choose a reason for hiding this comment

yuit commented Nov 24, 2015

yuit commented Nov 24, 2015

vladima commented Nov 24, 2015

alexeagle commented Jan 13, 2016

vladima commented Jan 13, 2016

prabirshrestha commented Jan 21, 2016

prabirshrestha commented Jan 21, 2016

vladima commented Jan 21, 2016

brentyates Jan 22, 2016

Choose a reason for hiding this comment

vladima Jan 22, 2016

Choose a reason for hiding this comment

prabirshrestha commented Jan 22, 2016

joshuastobaugh57 Jan 22, 2016

Choose a reason for hiding this comment

mhegazy Jan 25, 2016

Choose a reason for hiding this comment

vladima Jan 27, 2016

Choose a reason for hiding this comment

mhegazy commented Jan 27, 2016

gsaandy commented Mar 27, 2016

mhegazy commented Mar 28, 2016