feat: Automatic alias mapping based on baseDir in tsconfig.json (ts)

nchanged · nchanged · commit 8f1104033c7b · 2018-05-16T09:45:04.000+02:00
diff --git a/docs/development/configuration.md b/docs/development/configuration.md
@@ -631,14 +631,6 @@ FuseBox.init({
 })
 ```
 
-Alternatively you can use the chainable API
-
-```js
-fuse.bundle("app")
-    .alias("foo", "~/foo/f")
-    .alias("bar", "~/bar/b")
-```
-
 
 In your code, you would use it in a way similar to this:
 ```js
@@ -648,6 +640,39 @@ import faraway from "faraway";
 console.log(utils, faraway);
 ```
 
+
+`baseUrl` option will automatically list your home directory and create aliases, unless `automaticAlias` is set
+```json
+{
+  "compilerOptions": {
+    "baseUrl": "."
+  }
+}
+```
+
+## Automatic alias
+
+The option `automaticAlias` is enabled by default, and works only if `tsconfig.json` is found and you are dealing with typescript
+
+```json
+{
+  "compilerOptions": {
+    "baseUrl": "."
+  }
+}
+```
+
+FuseBox will automatically list all your homeDir directories and map aliases for you. Note, that baseURL should be equal `.` and located right in your home directory (for example `src/`)
+
+
+```
+→ Applying automatic alias based on baseUrl in tsconfig.json
+→
+    components => "~/components"
+    foo => "~/foo"
+    index => "~/index"
+    ui => "~/ui"
+```
 ## Extension Overrides
 
 You can optionally override how file extensions are resolved. This is useful if you want to create platform specific bundles:
diff --git a/src/core/FuseBox.ts b/src/core/FuseBox.ts
@@ -55,6 +55,7 @@ export interface FuseBoxOptions {
     output?: string;
     emitHMRDependencies?: boolean;
     filterFile?: (file: File) => boolean;
+    automaticAlias: boolean;
     allowSyntheticDefaultImports?: boolean;
     debug?: boolean;
     files?: any;
@@ -107,6 +108,11 @@ export class FuseBox {
         if (opts.writeBundles !== undefined) {
             this.context.userWriteBundles = opts.writeBundles;
         }
+
+        if (opts.automaticAlias !== undefined) {
+            this.context.automaticAlias = opts.automaticAlias;
+        }
+
         // setting targets
         opts.target = opts.target || "browser";
         const [target, languageLevel] = opts.target.toLowerCase().split("@");
diff --git a/src/core/TypescriptConfig.ts b/src/core/TypescriptConfig.ts
@@ -13,6 +13,7 @@ export class TypescriptConfig {
     // the actual typescript config
     private config: any;
     private customTsConfig: string;
+    private configFile: string;
 
     constructor(public context: WorkFlowContext) { }
 
@@ -30,6 +31,25 @@ export class TypescriptConfig {
         if (this.context.forcedLanguageLevel) {
             this.forceCompilerTarget(this.context.forcedLanguageLevel);
         }
+
+        if (compilerOptions.baseUrl === "." && this.context.automaticAlias) {
+            let aliasConfig = {};
+            let log = [];
+            fs.readdirSync(this.context.homeDir).forEach(file => {
+                const extension = path.extname(file);
+                if (!extension || extension === ".ts" || extension === ".tsx") {
+                    let name = file;
+                    if (extension) {
+                        name = file.replace(/\.tsx?/, "")
+                    }
+                    log.push(`\t${name} => "~/${name}"`)
+                    aliasConfig[name] = `~/${name}`;
+                }
+            });
+            this.context.log.echoInfo(`Applying automatic alias based on baseUrl in tsconfig.json`)
+            this.context.log.echoInfo(`\n ${log.join("\n")}`)
+            this.context.addAlias(aliasConfig);
+        }
     }
 
     public forceCompilerTarget(level: ScriptTarget) {
@@ -68,27 +88,27 @@ export class TypescriptConfig {
         if (CACHED[cacheKey]) {
             this.config = CACHED[cacheKey];
         } else {
-            let url, configFile;
+            let url;
             let config: any = {
                 compilerOptions: {},
             };;
             let configFileFound = false;
             let tsConfigOverride: any;
             if (typeof this.customTsConfig === "string") {
-                configFile = ensureUserPath(this.customTsConfig);
+                this.configFile = ensureUserPath(this.customTsConfig);
             } else {
                 url = path.join(this.context.homeDir, "tsconfig.json");
                 let tsconfig = findFileBackwards(url, this.context.appRoot);
                 if (tsconfig) {
                     configFileFound = true;
-                    configFile = tsconfig;
+                    this.configFile = tsconfig;
                 }
             }
-            if (configFile) {
-                const configFileRelPath = configFile.replace(this.context.appRoot, "");
+            if (this.configFile) {
+                const configFileRelPath = this.configFile.replace(this.context.appRoot, "");
                 this.context.log.echoInfo(`Typescript config file:  ${configFileRelPath}`);
                 configFileFound = true;
-                const res = ts.readConfigFile(configFile, (p) => fs.readFileSync(p).toString());
+                const res = ts.readConfigFile(this.configFile, (p) => fs.readFileSync(p).toString());
                 config = res.config;
                 if (res.error) {
                     this.context.log.echoError(`Errors in ${configFileRelPath}`);
@@ -108,8 +128,8 @@ export class TypescriptConfig {
                 config.compilerOptions = Object.assign(config.compilerOptions, tsConfigOverride);
             }
             // allowSyntheticDefaultImports
-            if( config.compilerOptions.allowSyntheticDefaultImports !== undefined ){
-                if( this.context.fuse && this.context.fuse.producer ) {
+            if (config.compilerOptions.allowSyntheticDefaultImports !== undefined) {
+                if (this.context.fuse && this.context.fuse.producer) {
                     this.context.fuse.producer.allowSyntheticDefaultImports = config.compilerOptions.allowSyntheticDefaultImports;;
                 }
             }
diff --git a/src/core/WorkflowContext.ts b/src/core/WorkflowContext.ts
@@ -71,6 +71,8 @@ export class WorkFlowContext {
 
     public dynamicImportsEnabled = true;
 
+    public automaticAlias = true;
+
     public shim: any;
 
     public writeBundles = true;
