feat(ng-add): add 'prefer-mapped-imports' rule (#235)

* feat: add dependency to @nativescript/tslint-rules

* feat(ng-add): add 'prefer-mapped-imports' rule

* refactor: import all {N} tslint symbols from the entry point

Author: sis0k0

package.json

@@ -19,7 +19,7 @@
   "dependencies": {
     "@angular-devkit/core": "~8.0.0",
     "@angular-devkit/schematics": "~8.0.0",
-    "@nativescript/tslint-rules": "~0.0.1",
+    "@nativescript/tslint-rules": "~0.0.3",
     "@phenomnomnominal/tsquery": "^3.0.0",
     "@schematics/angular": "~8.0.0"
   },

src/add-ns/index.ts

@@ -23,6 +23,8 @@ import { getAngularProjectSettings, AngularProjectSettings } from '../angular-pr
 import { Extensions } from '../generate/utils';
 
 import { Schema as ConvertRelativeImportsSchema } from '../convert-relative-imports/schema';
+import { getCompilerOptions } from '../ts-utils';
+import { getMappedImportsRuleConfig } from '../mapped-imports-rule-utils';
 
 let extensions: Extensions;
 let projectSettings: AngularProjectSettings;
@@ -50,6 +52,7 @@ export default function(options: MigrationOptions): Rule {
     addNativeScriptProjectId,
 
     modifyWebTsconfig,
+    modifyTsLintConfig,
 
     options.skipAutoGeneratedComponent ?
       noop() :
@@ -241,6 +244,55 @@ const addNativeScriptProjectId = (tree: Tree, context: SchematicContext) => {
   tree.overwrite('package.json', JSON.stringify(packageJson, null, 2));
 };
 
+const modifyTsLintConfig = (tree: Tree, context: SchematicContext) => {
+  context.logger.info('Modifying tslint.json');
+
+  const tsLintConfigPath = 'tslint.json';
+  let tsLintConfig;
+  try {
+    tsLintConfig = getJsonFile(tree, tsLintConfigPath);
+  } catch (e) {
+    context.logger.warn('Failed to update tslint.json.');
+    context.logger.debug(e.message);
+
+    return;
+  }
+
+  tsLintConfig.extends = tsLintConfig.extends || [];
+  if (typeof tsLintConfig.extends === 'string') {
+    tsLintConfig.extends = [
+      tsLintConfig.extends,
+    ];
+  }
+  tsLintConfig.extends.push('@nativescript/tslint-rules');
+
+  tsLintConfig.rules = tsLintConfig.rules || {};
+  const ruleConfig = getRuleConfig(tree);
+  if (!ruleConfig) {
+    context.logger.warn('Failed to update tslint.json.');
+    context.logger.debug('Failed to construct tslint rule configuration.');
+
+    return;
+  }
+
+  const { name, options } = ruleConfig;
+  tsLintConfig.rules[name] = options;
+
+  tree.overwrite(tsLintConfigPath, JSON.stringify(tsLintConfig, null, 2));
+};
+
+const getRuleConfig = (tree: Tree) => {
+  const tsConfigPath = projectSettings.tsConfig || 'tsconfig.json';
+  const compilerOptions = getCompilerOptions(tree, tsConfigPath);
+  if (!compilerOptions) {
+    return;
+  }
+
+  const ruleConfig = getMappedImportsRuleConfig(compilerOptions);
+
+  return ruleConfig;
+};
+
 /**
  * Add web-specific path mappings and files
  */
@@ -320,6 +372,7 @@ const addDependencies = () => (tree: Tree, context: SchematicContext) => {
   const devDepsToAdd = {
     'nativescript-dev-webpack': '~1.0.0',
     '@nativescript/schematics': '~0.7.0',
+    '@nativescript/tslint-rules': '~0.0.2',
   };
   packageJson.devDependencies = {...devDepsToAdd, ...packageJson.devDependencies};
 

src/add-ns/index_spec.ts

@@ -84,6 +84,7 @@ describe('Add {N} schematic', () => {
 
             expect(devDependencies['nativescript-dev-webpack']).toBeDefined();
             expect(devDependencies['@nativescript/schematics']).toBeDefined();
+            expect(devDependencies['@nativescript/tslint-rules']).toBeDefined();
         });
 
         it('should add run scripts to the package json', () => {
@@ -167,6 +168,24 @@ describe('Add {N} schematic', () => {
             expect(maps).toContain('src/*');
         });
 
+        it('should modify tslint.json to include rule for using remapped imports', () => {
+            const tsLintConfigPath = '/tslint.json';
+            expect(appTree.files).toContain(tsLintConfigPath);
+
+            const tsLintConfig = JSON.parse(getFileContent(appTree, tsLintConfigPath));
+            const { extends: tsLintExtends, rules: tsLintRules } = tsLintConfig;
+
+            expect(tsLintExtends).toEqual(jasmine.any(Array));
+            expect(tsLintExtends).toContain('@nativescript/tslint-rules');
+
+            expect(tsLintRules).toEqual(jasmine.any(Object));
+            expect(Object.keys(tsLintRules)).toContain('prefer-mapped-imports');
+            const rule = tsLintRules['prefer-mapped-imports'];
+            const ruleOptions = rule[1];
+            const actualBaseUrl = ruleOptions['base-url'];
+            expect(actualBaseUrl).toEqual('./');
+        });
+
         it('should generate a sample shared component', () => {
             const { files } = appTree;
             const appRoutingModuleContent = appTree.readContent('/src/app/app-routing.module.tns.ts');

src/convert-relative-imports/index.ts

@@ -3,12 +3,12 @@ import { IRule, Replacement } from 'tslint';
 import { tsquery } from '@phenomnomnominal/tsquery';
 import { Tree, SchematicContext, isContentAction } from '@angular-devkit/schematics';
 import { LoggerApi } from '@angular-devkit/core/src/logger';
-import { PreferMappedImportsRule } from '@nativescript/tslint-rules';
-import { parseCompilerOptions } from '@nativescript/tslint-rules/dist/preferMappedImportsRule';
 
-import { parseTsConfigFile } from '../ts-utils';
+import { getCompilerOptions } from '../ts-utils';
 import { getFileContents } from '../utils';
 import { getTsConfigFromProject } from '../angular-project-parser';
+import { getMappedImportsRule } from '../mapped-imports-rule-utils';
+
 import { Schema as ConvertRelativeImportsSchema } from './schema';
 
 // TODO: add link to the docs
@@ -25,7 +25,7 @@ export default function(options: ConvertRelativeImportsSchema) {
       return tree;
     }
 
-    const tsConfigPath = getTsConfigPath(tree, options.project, logger) || 'tsconfig.json';
+    const tsConfigPath = getTsConfigFromProject(tree, options.project) || 'tsconfig.json';
     const compilerOptions = getCompilerOptions(tree, tsConfigPath);
 
     if (!compilerOptions) {
@@ -61,7 +61,7 @@ function fixImports(
   filePaths: Set<string>,
   compilerOptions: ts.CompilerOptions,
 ): Tree {
-  const rule = generateTslintRule(compilerOptions);
+  const rule = getMappedImportsRule(compilerOptions);
   if (!rule) {
     logger.debug('Convert Relative Imports: Failed to extract remap options from the TS compiler options.');
     logger.error(conversionFailureMessage);
@@ -91,49 +91,3 @@ function applyTslintRuleFixes(rule: IRule, filePath: string, fileContent: string
 
   return fixedContent;
 }
-
-function generateTslintRule(compilerOptions: ts.CompilerOptions): PreferMappedImportsRule | undefined {
-  const remapOptions = parseCompilerOptions(compilerOptions);
-  if (!remapOptions) {
-    return;
-  }
-
-  const tslintRuleArguments = {
-    prefix: remapOptions.prefix,
-    'prefix-mapped-to': remapOptions.prefixMappedTo,
-    'base-url': remapOptions.baseUrl,
-  };
-
-  const rule = new PreferMappedImportsRule({
-    ruleArguments: [tslintRuleArguments],
-    ruleName: 'prefer-mapped-imports',
-    ruleSeverity: 'error',
-    disabledIntervals: [],
-  });
-
-  return rule;
-}
-
-function getTsConfigPath(tree: Tree, projectName: string, logger: LoggerApi): string | undefined {
-  let tsConfig: string | undefined;
-  try {
-    tsConfig = getTsConfigFromProject(tree, projectName);
-  } catch (e) {
-    logger.error(e);
-  }
-
-  return tsConfig;
-}
-
-function getCompilerOptions(tree: Tree, tsConfigPath: string)
-  : ts.CompilerOptions | undefined {
-
-  const tsConfigObject = parseTsConfigFile(tree, tsConfigPath);
-  if (!tsConfigObject) {
-    return;
-  }
-
-  const compilerOptions = tsConfigObject.options;
-
-  return compilerOptions;
-}

src/mapped-imports-rule-utils.ts

@@ -0,0 +1,66 @@
+import * as ts from 'typescript';
+import {
+    PreferMappedImportsRule,
+    RuleArgs,
+    parseCompilerOptions,
+} from '@nativescript/tslint-rules';
+
+const RULE_NAME = 'prefer-mapped-imports';
+
+export function getMappedImportsRule(compilerOptions: ts.CompilerOptions):
+    PreferMappedImportsRule | undefined {
+
+    const tslintRuleArguments = getMappedImportsArguments(compilerOptions);
+    if (!tslintRuleArguments) {
+        return;
+    }
+
+    const rule = new PreferMappedImportsRule({
+        ruleArguments: [tslintRuleArguments],
+        ruleName: RULE_NAME,
+        ruleSeverity: 'error',
+        disabledIntervals: [],
+    });
+
+    return rule;
+}
+
+export interface RuleConfig {
+    name: string;
+    options: object;
+}
+
+export function getMappedImportsRuleConfig(compilerOptions: ts.CompilerOptions): RuleConfig | undefined {
+    const tslintRuleArguments = getMappedImportsArguments(compilerOptions);
+    if (!tslintRuleArguments) {
+        return;
+    }
+
+    const ruleOptions = [
+        true,
+        tslintRuleArguments,
+    ];
+
+    return {
+        name: RULE_NAME,
+        options: ruleOptions,
+    };
+}
+
+function getMappedImportsArguments(compilerOptions: ts.CompilerOptions)
+    : RuleArgs | undefined {
+
+    const remapOptions = parseCompilerOptions(compilerOptions);
+    if (!remapOptions) {
+        return;
+    }
+
+    const { prefix, prefixMappedTo, baseUrl } = remapOptions;
+    const tslintRuleArguments = {
+        prefix,
+        'prefix-mapped-to': prefixMappedTo,
+        'base-url': baseUrl,
+    };
+
+    return tslintRuleArguments;
+}

src/ng-new/shared/_files/package.json

@@ -40,6 +40,7 @@
     "@angular/compiler-cli": "~8.0.1",
     "@angular-devkit/build-angular": "~0.800.0",
     "@nativescript/schematics": "~0.7.0",
+    "@nativescript/tslint-rules": "~0.0.2",
     "@types/jasmine": "~3.3.8",
     "@types/jasminewd2": "~2.0.3",
     "@types/node": "~8.9.4",

src/ts-utils.ts

@@ -1,3 +1,5 @@
+import { dirname } from 'path';
+
 import {
   addImportToModule,
   addBootstrapToModule,
@@ -9,7 +11,6 @@ import { SchematicsException, Rule, Tree } from '@angular-devkit/schematics';
 import * as ts from 'typescript';
 
 import { toComponentClassName, Node, removeNode, getFileContents, getJsonFile } from './utils';
-import { dirname } from 'path';
 
 class RemoveContent implements Node {
   constructor(private pos: number, private end: number) {
@@ -620,7 +621,33 @@ export const replaceTextInNode = (tree: Tree, node: ts.Node, oldText: string, ne
   tree.commitUpdate(recorder);
 };
 
-export function parseTsConfigFile(tree: Tree, tsConfigPath: string): ts.ParsedCommandLine {
+export const getSourceFile = (host: Tree, path: string): ts.SourceFile => {
+  const buffer = host.read(path);
+  if (!buffer) {
+    throw new SchematicsException(
+      `Could not find file at ${path}. See https://github.com/NativeScript/nativescript-schematics/issues/172.`,
+    );
+  }
+  const content = buffer.toString();
+  const source = ts.createSourceFile(path, content, ts.ScriptTarget.Latest, true);
+
+  return source;
+};
+
+export function getCompilerOptions(tree: Tree, tsConfigPath: string)
+  : ts.CompilerOptions | undefined {
+
+  const tsConfigObject = parseTsConfigFile(tree, tsConfigPath);
+  if (!tsConfigObject) {
+    return;
+  }
+
+  const compilerOptions = tsConfigObject.options;
+
+  return compilerOptions;
+}
+
+function parseTsConfigFile(tree: Tree, tsConfigPath: string): ts.ParsedCommandLine {
   const config = getJsonFile(tree, tsConfigPath);
   const host: ts.ParseConfigHost = {
     useCaseSensitiveFileNames: ts.sys.useCaseSensitiveFileNames,
@@ -634,16 +661,3 @@ export function parseTsConfigFile(tree: Tree, tsConfigPath: string): ts.ParsedCo
 
   return tsConfigObject;
 }
-
-export const getSourceFile = (host: Tree, path: string): ts.SourceFile => {
-  const buffer = host.read(path);
-  if (!buffer) {
-    throw new SchematicsException(
-      `Could not find file at ${path}. See https://github.com/NativeScript/nativescript-schematics/issues/172.`,
-    );
-  }
-  const content = buffer.toString();
-  const source = ts.createSourceFile(path, content, ts.ScriptTarget.Latest, true);
-
-  return source;
-};