Merge pull request #4372 from NativeScript/vladimirov/short-imports-warn

feat: detect and report short imports used in application

Author: rosen-vladimirov

lib/common/declarations.d.ts

@@ -1168,6 +1168,13 @@ interface IDoctorService {
 	 * @returns {Promise<boolean>} true if the environment is properly configured for local builds
 	 */
 	canExecuteLocalBuild(platform?: string, projectDir?: string, runtimeVersion?: string): Promise<boolean>;
+
+	/**
+	 * Checks and notifies users for deprecated short imports in their applications.
+	 * @param {string} projectDir Path to the application.
+	 * @returns {void}
+	 */
+	checkForDeprecatedShortImportsInAppDir(projectDir: string): void;
 }
 
 interface IUtils {

lib/common/helpers.ts

@@ -8,6 +8,12 @@ import * as crypto from "crypto";
 import * as _ from "lodash";
 
 const Table = require("cli-table");
+const STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg;
+
+export function stripComments(content: string): string {
+	const newContent = content.replace(STRIP_COMMENTS, "");
+	return newContent;
+}
 
 export function doesCurrentNpmCommandMatch(patterns?: RegExp[]): boolean {
 	const currentNpmCommandArgv = getCurrentNpmCommandArgv();
@@ -682,7 +688,6 @@ const CONSTRUCTOR_ARGS = /constructor\s*([^\(]*)\(\s*([^\)]*)\)/m;
 const FN_NAME_AND_ARGS = /^(?:function)?\s*([^\(]*)\(\s*([^\)]*)\)\s*(=>)?\s*[{_]/m;
 const FN_ARG_SPLIT = /,/;
 const FN_ARG = /^\s*(_?)(\S+?)\1\s*$/;
-const STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg;
 
 export function annotate(fn: any) {
 	let $inject: any,

lib/common/test/unit-tests/helpers.ts

@@ -825,4 +825,40 @@ describe("helpers", () => {
 			});
 		});
 	});
+
+	describe("stripComments", () => {
+		const testData: ITestData[] = [
+			{
+				input: `// this is comment,
+const test = require("./test");`,
+				expectedResult: `\nconst test = require("./test");`
+			},
+			{
+				input: `/* this is multiline
+comment */
+const test = require("./test");`,
+				expectedResult: `\nconst test = require("./test");`
+			},
+			{
+				input: `/* this is multiline
+comment
+// with inner one line comment inside it
+the multiline comment finishes here
+*/
+const test = require("./test");`,
+				expectedResult: `\nconst test = require("./test");`
+			},
+
+			{
+				input: `const test /*inline comment*/ = require("./test");`,
+				expectedResult: `const test  = require("./test");`
+			},
+		];
+
+		it("strips comments correctly", () => {
+			testData.forEach(testCase => {
+				assertTestData(testCase, helpers.stripComments);
+			});
+		});
+	});
 });

lib/constants.ts

@@ -116,6 +116,12 @@ export const NgFlavorName = "Angular";
 export const VueFlavorName = "Vue.js";
 export const TsFlavorName = "Plain TypeScript";
 export const JsFlavorName = "Plain JavaScript";
+export class ProjectTypes {
+	public static NgFlavorName = NgFlavorName;
+	public static VueFlavorName = VueFlavorName;
+	public static TsFlavorName = "Pure TypeScript";
+	public static JsFlavorName = "Pure JavaScript";
+}
 export const BUILD_OUTPUT_EVENT_NAME = "buildOutput";
 export const CONNECTION_ERROR_EVENT_NAME = "connectionError";
 export const USER_INTERACTION_NEEDED_EVENT_NAME = "userInteractionNeeded";

lib/definitions/project.d.ts

@@ -172,6 +172,13 @@ interface IProjectDataService {
 	 * @returns {Promise<IAssetGroup>} An object describing the current asset structure for Android.
 	 */
 	getAndroidAssetsStructure(opts: IProjectDir): Promise<IAssetGroup>;
+
+	/**
+	 * Returns array with paths to all `.js` or `.ts` files in application's app directory.
+	 * @param {string} projectDir Path to application.
+	 * @returns {string[]} Array of paths to `.js` or `.ts` files.
+	 */
+	getAppExecutableFiles(projectDir: string): string[];
 }
 
 interface IAssetItem {
@@ -535,9 +542,9 @@ interface ICocoaPodsService {
 
 	/**
 	 * Merges pod's xcconfig file into project's xcconfig file
-	 * @param projectData 
-	 * @param platformData 
-	 * @param opts 
+	 * @param projectData
+	 * @param platformData
+	 * @param opts
 	 */
 	mergePodXcconfigFile(projectData: IProjectData, platformData: IPlatformData, opts: IRelease): Promise<void>;
 }

lib/project-data.ts

@@ -16,19 +16,19 @@ export class ProjectData implements IProjectData {
 	 */
 	private static PROJECT_TYPES: IProjectType[] = [
 		{
-			type: "Pure JavaScript",
+			type: constants.ProjectTypes.JsFlavorName,
 			isDefaultProjectType: true
 		},
 		{
-			type: constants.NgFlavorName,
+			type: constants.ProjectTypes.NgFlavorName,
 			requiredDependencies: ["@angular/core", "nativescript-angular"]
 		},
 		{
-			type: constants.VueFlavorName,
+			type: constants.ProjectTypes.VueFlavorName,
 			requiredDependencies: ["nativescript-vue"]
 		},
 		{
-			type: "Pure TypeScript",
+			type: constants.ProjectTypes.TsFlavorName,
 			requiredDependencies: ["typescript", "nativescript-dev-typescript"]
 		}
 	];

lib/services/doctor-service.ts

@@ -1,10 +1,10 @@
 import { EOL } from "os";
 import * as path from "path";
 import * as helpers from "../common/helpers";
-import { TrackActionNames } from "../constants";
+import { TrackActionNames, NODE_MODULES_FOLDER_NAME, TNS_CORE_MODULES_NAME } from "../constants";
 import { doctor, constants } from "nativescript-doctor";
 
-class DoctorService implements IDoctorService {
+export class DoctorService implements IDoctorService {
 	private static DarwinSetupScriptLocation = path.join(__dirname, "..", "..", "setup", "mac-startup-shell-script.sh");
 	private static WindowsSetupScriptExecutable = "powershell.exe";
 	private static WindowsSetupScriptArguments = ["start-process", "-FilePath", "PowerShell.exe", "-NoNewWindow", "-Wait", "-ArgumentList", '"-NoProfile -ExecutionPolicy Bypass -Command iex ((new-object net.webclient).DownloadString(\'https://www.nativescript.org/setup/win\'))"'];
@@ -14,10 +14,12 @@ class DoctorService implements IDoctorService {
 		private $logger: ILogger,
 		private $childProcess: IChildProcess,
 		private $injector: IInjector,
+		private $projectDataService: IProjectDataService,
+		private $fs: IFileSystem,
 		private $terminalSpinnerService: ITerminalSpinnerService,
 		private $versionsService: IVersionsService) { }
 
-	public async printWarnings(configOptions?: { trackResult: boolean , projectDir?: string, runtimeVersion?: string, options?: IOptions }): Promise<void> {
+	public async printWarnings(configOptions?: { trackResult: boolean, projectDir?: string, runtimeVersion?: string, options?: IOptions }): Promise<void> {
 		const infos = await this.$terminalSpinnerService.execute<NativeScriptDoctor.IInfo[]>({
 			text: `Getting environment information ${EOL}`
 		}, () => doctor.getInfos({ projectDir: configOptions && configOptions.projectDir, androidRuntimeVersion: configOptions && configOptions.runtimeVersion }));
@@ -48,6 +50,8 @@ class DoctorService implements IDoctorService {
 			this.$logger.error("Cannot get the latest versions information from npm. Please try again later.");
 		}
 
+		this.checkForDeprecatedShortImportsInAppDir(configOptions.projectDir);
+
 		await this.$injector.resolve<IPlatformEnvironmentRequirements>("platformEnvironmentRequirements").checkEnvironmentRequirements({
 			platform: null,
 			projectDir: configOptions && configOptions.projectDir,
@@ -113,6 +117,59 @@ class DoctorService implements IDoctorService {
 		return !hasWarnings;
 	}
 
+	public checkForDeprecatedShortImportsInAppDir(projectDir: string): void {
+		if (projectDir) {
+			try {
+				const files = this.$projectDataService.getAppExecutableFiles(projectDir);
+				const shortImports = this.getDeprecatedShortImportsInFiles(files, projectDir);
+				if (shortImports.length) {
+					this.$logger.printMarkdown("Detected short imports in your application. Please note that `short imports are deprecated` since NativeScript 5.2.0. More information can be found in this blogpost https://www.nativescript.org/blog/say-goodbye-to-short-imports-in-nativescript");
+					shortImports.forEach(shortImport => {
+						this.$logger.printMarkdown(`In file \`${shortImport.file}\` line \`${shortImport.line}\` is short import. Add \`tns-core-modules/\` in front of the required/imported module.`);
+					});
+				}
+			} catch (err) {
+				this.$logger.trace(`Unable to validate if project has short imports. Error is`, err);
+			}
+		}
+	}
+
+	protected getDeprecatedShortImportsInFiles(files: string[], projectDir: string): { file: string, line: string }[] {
+		const shortImportRegExps = this.getShortImportRegExps(projectDir);
+		const shortImports: { file: string, line: string }[] = [];
+
+		for (const file of files) {
+			const fileContent = this.$fs.readText(file);
+			const strippedComments = helpers.stripComments(fileContent);
+			const linesWithRequireStatements = strippedComments
+				.split(/\r?\n/)
+				.filter(line => /\btns-core-modules\b/.exec(line) === null && (/\bimport\b/.exec(line) || /\brequire\b/.exec(line)));
+
+			for (const line of linesWithRequireStatements) {
+				for (const regExp of shortImportRegExps) {
+					const matches = line.match(regExp);
+
+					if (matches && matches.length) {
+						shortImports.push({ file, line });
+						break;
+					}
+				}
+			}
+		}
+
+		return shortImports;
+	}
+
+	private getShortImportRegExps(projectDir: string): RegExp[] {
+		const pathToTnsCoreModules = path.join(projectDir, NODE_MODULES_FOLDER_NAME, TNS_CORE_MODULES_NAME);
+		const contents = this.$fs.readDirectory(pathToTnsCoreModules)
+			.filter(entry => this.$fs.getFsStats(path.join(pathToTnsCoreModules, entry)).isDirectory());
+
+		const regExps = contents.map(c => new RegExp(`[\"\']${c}[\"\'/]`, "g"));
+
+		return regExps;
+	}
+
 	private async runSetupScriptCore(executablePath: string, setupScriptArgs: string[]): Promise<ISpawnResult> {
 		return this.$childProcess.spawnFromEvent(executablePath, setupScriptArgs, "close", { stdio: "inherit" });
 	}

lib/services/platform-service.ts

@@ -27,6 +27,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 		private $errors: IErrors,
 		private $fs: IFileSystem,
 		private $logger: ILogger,
+		private $doctorService: IDoctorService,
 		private $packageInstallationManager: IPackageInstallationManager,
 		private $platformsData: IPlatformsData,
 		private $projectDataService: IProjectDataService,
@@ -237,6 +238,8 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 				await this.cleanDestinationApp(platformInfo);
 			}
 
+			this.$doctorService.checkForDeprecatedShortImportsInAppDir(platformInfo.projectData.projectDir);
+
 			await this.preparePlatformCore(
 				platformInfo.platform,
 				platformInfo.appFilesUpdaterOptions,

lib/services/project-data-service.ts

@@ -1,7 +1,7 @@
 import * as path from "path";
 import { ProjectData } from "../project-data";
 import { exported } from "../common/decorators";
-import { NATIVESCRIPT_PROPS_INTERNAL_DELIMITER, AssetConstants, SRC_DIR, RESOURCES_DIR, MAIN_DIR, CLI_RESOURCES_DIR_NAME } from "../constants";
+import { NATIVESCRIPT_PROPS_INTERNAL_DELIMITER, AssetConstants, SRC_DIR, RESOURCES_DIR, MAIN_DIR, CLI_RESOURCES_DIR_NAME, ProjectTypes } from "../constants";
 
 interface IProjectFileData {
 	projectData: any;
@@ -116,6 +116,32 @@ export class ProjectDataService implements IProjectDataService {
 		};
 	}
 
+	public getAppExecutableFiles(projectDir: string): string[] {
+		const projectData = this.getProjectData(projectDir);
+
+		let supportedFileExtension = ".js";
+		if (projectData.projectType === ProjectTypes.NgFlavorName || projectData.projectType === ProjectTypes.TsFlavorName) {
+			supportedFileExtension = ".ts";
+		}
+
+		const files = this.$fs.enumerateFilesInDirectorySync(
+			projectData.appDirectoryPath,
+			(filePath, fstat) => {
+				if (filePath.indexOf(projectData.appResourcesDirectoryPath) !== -1) {
+					return false;
+				}
+
+				if (fstat.isDirectory()) {
+					return true;
+				}
+
+				return path.extname(filePath) === supportedFileExtension;
+			}
+		);
+
+		return files;
+	}
+
 	private getImageDefinitions(): IImageDefinitionsStructure {
 		const pathToImageDefinitions = path.join(__dirname, "..", "..", CLI_RESOURCES_DIR_NAME, AssetConstants.assets, AssetConstants.imageDefinitionsFileName);
 		const imageDefinitions = this.$fs.readJson(pathToImageDefinitions);

test/npm-support.ts

@@ -107,6 +107,9 @@ function createTestInjector(): IInjector {
 		extractPackage: async (packageName: string, destinationDirectory: string, options?: IPacoteExtractOptions): Promise<void> => undefined
 	});
 	testInjector.register("usbLiveSyncService", () => ({}));
+	testInjector.register("doctorService", {
+		checkForDeprecatedShortImportsInAppDir: (projectDir: string): void => undefined
+	});
 
 	return testInjector;
 }