Merge pull request #137 from webratio/pr/incompatible-compiler-options

Warn about incompatibility between compileOnSave and path mapping

Author: angelozerr

core/ts.core/src/ts/cmd/tsc/CompilerOptions.java

@@ -1,6 +1,11 @@
 package ts.cmd.tsc;
 
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
+import java.util.Set;
 
 import ts.cmd.AbstractOptions;
 
@@ -49,12 +54,14 @@ public class CompilerOptions extends AbstractOptions {
 	private String out;
 	private String outDir;
 	private String outFile;
+	private Map<String, List<String>> paths;
 	private boolean preserveConstEnums;
 	private boolean pretty;
 	private String project;
 	private String reactNamespace;
 	private boolean removeComments;
 	private String rootDir;
+	private List<String> rootDirs;
 	private boolean skipDefaultLibCheck;
 	private boolean sourceMap;
 	private String sourceRoot;
@@ -819,6 +826,49 @@ public void setOutFile(String outFile) {
 		this.outFile = outFile;
 	}
 
+	/**
+	 * Specify path mapping to be computed relative to baseUrl option.
+	 * 
+	 * @return key patterns to which paths are mapped.
+	 */
+	public Set<String> getPathsKeys() {
+		if (paths == null) {
+			return Collections.emptySet();
+		}
+		return Collections.unmodifiableSet(paths.keySet());
+	}
+
+	/**
+	 * Specify path mapping to be computed relative to baseUrl option.
+	 * 
+	 * @param pathsKey
+	 *            a path key pattern.
+	 * @return paths mapped to the key pattern.
+	 */
+	public List<String> getPathsKeyValues(String pathsKey) {
+		if (paths == null) {
+			return Collections.emptyList();
+		}
+		List<String> values = paths.get(pathsKey);
+		if (values == null) {
+			return Collections.emptyList();
+		}
+		return Collections.unmodifiableList(values);
+	}
+
+	/**
+	 * Specify path mapping to be computed relative to baseUrl option.
+	 * 
+	 * @param paths
+	 */
+	public void setPaths(Map<String, List<String>> paths) {
+		Map<String, List<String>> pathsCopy = new HashMap<>(paths.size());
+		for (Map.Entry<String, List<String>> entry : paths.entrySet()) {
+			pathsCopy.put(entry.getKey(), new ArrayList<>(entry.getValue()));
+		}
+		this.paths = pathsCopy;
+	}
+
 	/**
 	 * Do not erase const enum declarations in generated code. See const enums
 	 * https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md#94-constant-enum-declarations
@@ -939,6 +989,27 @@ public void setRootDir(String rootDir) {
 		this.rootDir = rootDir;
 	}
 
+	/**
+	 * Specify list of root directory to be used when resolving modules.
+	 * 
+	 * @return
+	 */
+	public List<String> getRootDirs() {
+		if (rootDirs == null) {
+			return Collections.emptyList();
+		}
+		return Collections.unmodifiableList(rootDirs);
+	}
+
+	/**
+	 * Specify list of root directory to be used when resolving modules.
+	 * 
+	 * @param rootDirs
+	 */
+	public void setRootDirs(List<String> rootDirs) {
+		this.rootDirs = new ArrayList<>(rootDirs);
+	}
+
 	/**
 	 * Don’t check a user-defined default lib file’s valitidy.
 	 * 

core/ts.core/src/ts/resources/jsonconfig/TsconfigJson.java

@@ -141,6 +141,36 @@ public boolean hasOutFile() {
 		return !StringUtils.isEmpty(options.getOutFile()) || !StringUtils.isEmpty(options.getOut());
 	}
 
+	/**
+	 * Returns true if the "compilerOptions" defines "paths" and false
+	 * otherwise.
+	 * 
+	 * @return true if the "compilerOptions" defines "paths" and false
+	 *         otherwise.
+	 */
+	public boolean hasPaths() {
+		CompilerOptions options = getCompilerOptions();
+		if (options == null) {
+			return false;
+		}
+		return !options.getPathsKeys().isEmpty();
+	}
+
+	/**
+	 * Returns true if the "compilerOptions" defines "rootDirs" and false
+	 * otherwise.
+	 * 
+	 * @return true if the "compilerOptions" defines "rootDirs" and false
+	 *         otherwise.
+	 */
+	public boolean hasRootDirs() {
+		CompilerOptions options = getCompilerOptions();
+		if (options == null) {
+			return false;
+		}
+		return !options.getRootDirs().isEmpty();
+	}
+
 	/**
 	 * Returns the defined "exclude" list from the tsconfig.json other exclude
 	 * by default "node_modules" and "bower_components".

eclipse/ts.eclipse.ide.core/src/ts/eclipse/ide/internal/core/TypeScriptCoreMessages.java

@@ -33,6 +33,7 @@ public class TypeScriptCoreMessages extends NLS {
 	public static String tsconfig_compileOnSave_disable_error;
 	public static String tsconfig_compilation_context_error;
 	public static String tsconfig_cannot_use_compileOnSave_with_outFile_error;
+	public static String tsconfig_cannot_use_compileOnSave_with_path_mapping_error;
 
 	// Launch
 	public static String TypeScriptCompilerLaunchConfigurationDelegate_invalidBuildPath;

eclipse/ts.eclipse.ide.core/src/ts/eclipse/ide/internal/core/TypeScriptCoreMessages.properties

@@ -17,6 +17,7 @@ SaveProjectPreferencesJob_taskName=Saving preferences of project {0}
 tsconfig_compileOnSave_disable_error=TypeScript file cannot be compiled on save because tsconfig.json disable it. If this is not intended, please set "compileOnSave" to "true" of your "{0}" file.
 tsconfig_compilation_context_error=TypeScript file is not included in the TypeScript compilation context. If this is not intended, please check the "files" or "filesGlob" section of your "{0}" file.
 tsconfig_cannot_use_compileOnSave_with_outFile_error=TypeScript file cannot be compiled on save because tsconfig.json defines "out"/outFile". If this is not intended, please set "buildOnSave" to "true" of your "{0}" file.
+tsconfig_cannot_use_compileOnSave_with_path_mapping_error=TypeScript file cannot be compiled on save because tsconfig.json uses path mapping features ("paths", "rootDirs"). If this is not intended, please set "buildOnSave" to "true" of your "{0}" file.
 
 # Launch
 TypeScriptCompilerLaunchConfigurationDelegate_invalidBuildPath=The tsconfig file {0} does not exist for the compiler launch named {1}.

eclipse/ts.eclipse.ide.core/src/ts/eclipse/ide/internal/core/compiler/IDETypeScriptCompiler.java

@@ -17,12 +17,10 @@
 import org.eclipse.core.resources.IContainer;
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IMarker;
-import org.eclipse.core.resources.IResource;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.osgi.util.NLS;
 
 import ts.TypeScriptException;
-import ts.cmd.tsc.CompilerOptionCapability;
 import ts.cmd.tsc.CompilerOptions;
 import ts.cmd.tsc.TypeScriptCompiler;
 import ts.eclipse.ide.core.compiler.IIDETypeScriptCompiler;
@@ -53,16 +51,18 @@ public void compile(IDETsconfigJson tsconfig, List<IFile> tsFiles) throws TypeSc
 		} else {
 			if (tsconfig.isCompileOnSave()) {
 				// compileOnSave is activated
-				if (tsconfig.hasOutFile()) {
-					// tsconfig.json defines "compilerOptions/outFile" or
-					// "compilerOptions/out", the ts files cannot be compiled
+				String tsconfigErrorMessage = checkForInvalidCompileOnSave(tsconfig);
+				if (tsconfigErrorMessage != null) {
+					// tsconfig.json uses features incompatible with
+					// compileOnSave,
+					// the ts files cannot be compiled;
 					// add a warning by suggesting to use "buildOnSave"
 					for (IFile tsFile : tsFiles) {
 						// delete existing marker
 						TypeScriptResourceUtil.deleteTscMarker(tsFile);
 						// add warning marker
 						TypeScriptResourceUtil.addTscMarker(tsFile,
-								NLS.bind(TypeScriptCoreMessages.tsconfig_cannot_use_compileOnSave_with_outFile_error,
+								NLS.bind(tsconfigErrorMessage,
 										tsconfig.getTsconfigFile().getProjectRelativePath().toString()),
 								IMarker.SEVERITY_WARNING, 1);
 						// delete emitted files *.js, *.js.map
@@ -103,6 +103,16 @@ public void compile(IDETsconfigJson tsconfig, List<IFile> tsFiles) throws TypeSc
 		}
 	}
 
+	private String checkForInvalidCompileOnSave(IDETsconfigJson tsconfig) {
+		if (tsconfig.hasOutFile()) {
+			return TypeScriptCoreMessages.tsconfig_cannot_use_compileOnSave_with_outFile_error;
+		}
+		if (tsconfig.hasPaths() || tsconfig.hasRootDirs()) {
+			return TypeScriptCoreMessages.tsconfig_cannot_use_compileOnSave_with_path_mapping_error;
+		}
+		return null;
+	}
+
 	private void compile(IFile tsConfigFile, CompilerOptions tsconfigOptions, List<IFile> tsFiles, boolean buildOnSave)
 			throws TypeScriptException, CoreException {
 		IContainer container = tsConfigFile.getParent();