Merge pull request #86 from CKGrafico/patch-1

Add options to wildcard

Author: piotr-oles

README.md

@@ -210,8 +210,7 @@ import Hello from '@/components/hello.vue'
 }
 ```
 
-6. The commonly used `@` path wildcard will work if you set up a `baseUrl` and `paths` (in `compilerOptions`) to include `@/*`. If you don't set this, then 
-the fallback for the `@` wildcard will be `[tsconfig directory]/src` (we hope to make this more flexible on future releases):  
+6. It accepts any wildcard in your TypeScript configuration:  
 ```
 // tsconfig.json
 {
@@ -223,6 +222,9 @@ the fallback for the `@` wildcard will be `[tsconfig directory]/src` (we hope to
     "paths": {
       "@/*": [
         "src/*"
+      ],
+      "~/*": [
+        "src/*"
       ]
     }
   }

src/VueProgram.ts

@@ -31,24 +31,43 @@ class VueProgram {
   }
 
   /**
-   * Since 99.9% of Vue projects use the wildcard '@/*', we only search for that in tsconfig CompilerOptions.paths.
+   * Search for default wildcard or wildcard from options, we only search for that in tsconfig CompilerOptions.paths.
    * The path is resolved with thie given substitution and includes the CompilerOptions.baseUrl (if given).
    * If no paths given in tsconfig, then the default substitution is '[tsconfig directory]/src'.
    * (This is a fast, simplified inspiration of what's described here: https://github.com/Microsoft/TypeScript/issues/5039)
    */
   public static resolveNonTsModuleName(moduleName: string, containingFile: string, basedir: string, options: ts.CompilerOptions) {
     const baseUrl = options.baseUrl ? options.baseUrl : basedir;
-    const pattern = options.paths ? options.paths['@/*'] : undefined;
-    const substitution = pattern ? options.paths['@/*'][0].replace('*', '') : 'src';
-    const isWildcard = moduleName.substr(0, 2) === '@/';
+    const discardedSymbols = ['.', '..', '/'];
+    const wildcards: string[] = [];
+
+    if (options.paths) {
+      Object.keys(options.paths).forEach(key => {
+        const pathSymbol = key[0];
+        if (discardedSymbols.indexOf(pathSymbol) < 0 && wildcards.indexOf(pathSymbol) < 0) {
+          wildcards.push(pathSymbol);
+        }
+      });
+    } else {
+      wildcards.push('@');
+    }
+
     const isRelative = !path.isAbsolute(moduleName);
+    let correctWildcard;
 
-    if (isWildcard) {
+    wildcards.forEach(wildcard => {
+      if (moduleName.substr(0, 2) === `${wildcard}/`) {
+        correctWildcard = wildcard;
+      }
+    });
+
+    if (correctWildcard) {
+      const pattern = options.paths ? options.paths[`${correctWildcard}/*`] : undefined;
+      const substitution = pattern ? options.paths[`${correctWildcard}/*`][0].replace('*', '') : 'src';
       moduleName = path.resolve(baseUrl, substitution, moduleName.substr(2));
     } else if (isRelative) {
       moduleName = path.resolve(path.dirname(containingFile), moduleName);
     }
-
     return moduleName;
   }
 

test/integration/vue.spec.js

@@ -134,7 +134,7 @@ describe('[INTEGRATION] vue', function () {
     createCompiler({ tslint: true, vue: true });
 
     compiler.run(function(error, stats) {
-      expect(stats.compilation.errors.length).to.be.equal(2);
+      expect(stats.compilation.errors.length).to.be.equal(1);
       callback();
     });
   });
@@ -143,8 +143,8 @@ describe('[INTEGRATION] vue', function () {
     createCompiler({ tslint: true, vue: true, checkSyntacticErrors: true });
 
     compiler.run(function(error, stats) {
-      expect(stats.compilation.errors.length).to.be.equal(3);
+      expect(stats.compilation.errors.length).to.be.equal(2);
       callback();
     });
   });
-});
+});

test/unit/VueProgram.spec.js

@@ -9,6 +9,7 @@ describe('[UNIT] VueProgram', function () {
     expect(VueProgram.isVue('../test.vue')).to.be.true;
     expect(VueProgram.isVue('../../test.vue')).to.be.true;
     expect(VueProgram.isVue('@/test.vue')).to.be.true;
+    expect(VueProgram.isVue('~/test.vue')).to.be.true;
     expect(VueProgram.isVue('../../.vue')).to.be.false;
     expect(VueProgram.isVue('./test.css')).to.be.false;
     expect(VueProgram.isVue('./')).to.be.false;
@@ -63,4 +64,4 @@ describe('[UNIT] VueProgram', function () {
     resolvedModuleName = VueProgram.resolveNonTsModuleName(moduleName, containingFile, basedir, options);
     expect(resolvedModuleName).to.be.equal('/baseurl3/src1/src2/test.vue');
   });
-});
+});