@angular-eslint/schematics 4.1.0-tmp.2 → 4.2.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.2.0](https://github.com/angular-eslint/angular-eslint/compare/v4.1.0...v4.2.0) (2021-04-28)
+
+### Features
+
+- **schematics:** add add-eslint-to-project schematic ([#426](https://github.com/angular-eslint/angular-eslint/issues/426)) ([7ae557d](https://github.com/angular-eslint/angular-eslint/commit/7ae557d94f53833fbfbf5128d39f64c7bb1c3c5f))
+
+# [4.1.0](https://github.com/angular-eslint/angular-eslint/compare/v4.0.0...v4.1.0) (2021-04-28)
+
+### Bug Fixes
+
+- **schematics:** support workspaces which use targets alias ([#424](https://github.com/angular-eslint/angular-eslint/issues/424)) ([da6bcf7](https://github.com/angular-eslint/angular-eslint/commit/da6bcf70027cc4b339ef2e825a931ec882d4711f))
+
+### Features
+
+- **schematics:** dynamically install tslint-to-eslint-config as needed ([#425](https://github.com/angular-eslint/angular-eslint/issues/425)) ([27ca474](https://github.com/angular-eslint/angular-eslint/commit/27ca474419defb79b552b233689a2dbf31b8ad92))
+
 # [4.0.0](https://github.com/angular-eslint/angular-eslint/compare/v3.0.1...v4.0.0) (2021-04-18)
 
 ### Features

package/dist/add-eslint-to-project/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schematics_1 = require("@angular-devkit/schematics");
+const utils_1 = require("../utils");
+function addESLintToProject(schema) {
+    return (tree) => {
+        const projectName = utils_1.determineTargetProjectName(tree, schema.project);
+        if (!projectName) {
+            throw new Error('\n' +
+                `
+Error: You must specify a project to add ESLint to because you have multiple projects in your angular.json
+
+E.g. npx ng g @angular-eslint/schematics:add-eslint-to-project {{YOUR_PROJECT_NAME_GOES_HERE}}
+        `.trim());
+        }
+        return schematics_1.chain([
+            // Set the lint builder and config in angular.json
+            utils_1.addESLintTargetToProject(projectName, 'lint'),
+            // Create the ESLint config file for the project
+            utils_1.createESLintConfigForProject(projectName),
+        ]);
+    };
+}
+exports.default = addESLintToProject;

package/dist/add-eslint-to-project/schema.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "add-eslint-to-project",
+  "title": "Add ESLint to an Angular CLI project",
+  "type": "object",
+  "properties": {
+    "project": {
+      "description": "The name of the project to add ESLint to.",
+      "type": "string",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      }
+    }
+  },
+  "required": []
+}

package/dist/collection.json

@@ -28,6 +28,11 @@
       "factory": "./library",
       "schema": "./library/schema.json",
       "description": "Generate a library project for Angular."
+    },
+    "add-eslint-to-project": {
+      "factory": "./add-eslint-to-project",
+      "schema": "./add-eslint-to-project/schema.json",
+      "description": "Add ESLint to an Angular CLI project"
     }
   }
 }

package/dist/convert-tslint-to-eslint/index.js

@@ -14,33 +14,18 @@ const eslintPluginConfigBaseOriginal = eslint_plugin_1.default.configs.base;
 const eslintPluginConfigNgCliCompatOriginal = eslint_plugin_1.default.configs['ng-cli-compat'];
 const eslintPluginConfigNgCliCompatFormattingAddOnOriginal = eslint_plugin_1.default.configs['ng-cli-compat--formatting-add-on'];
 const eslintPluginTemplateConfigRecommendedOriginal = eslint_plugin_template_1.default.configs.recommended;
-/**
- * To make the conversion more ergonomic, if the user does not specify a project
- * to convert and only has a single project in their angular.json we will just go
- * ahead and convert that one.
- */
-function determineProjectToConvert(tree, maybeProject) {
-    if (maybeProject) {
-        return maybeProject;
-    }
-    const workspaceJson = utils_1.readJsonInTree(tree, utils_1.getWorkspacePath(tree));
-    const projects = Object.keys(workspaceJson.projects);
-    if (projects.length === 1) {
-        return projects[0];
-    }
-    return null;
-}
 function convert(schema) {
     return (tree) => {
         if (tree.exists('tsconfig.base.json')) {
             throw new Error('\nError: Angular CLI v10.1.0 and later (and no `tsconfig.base.json`) is required in order to run this schematic. Please update your workspace and try again.\n');
         }
-        const projectName = determineProjectToConvert(tree, schema.project);
+        const projectName = utils_1.determineTargetProjectName(tree, schema.project);
         if (!projectName) {
             throw new Error('\n' +
-                `Error: You must specify a project to convert because you have multiple projects in your angular.json\n
-          
-          E.g. npx ng g @angular-eslint/schematics:convert-tslint-to-eslint {{YOUR_PROJECT_NAME_GOES_HERE}}
+                `
+Error: You must specify a project to convert because you have multiple projects in your angular.json
+
+E.g. npx ng g @angular-eslint/schematics:convert-tslint-to-eslint {{YOUR_PROJECT_NAME_GOES_HERE}}
         `.trim());
         }
         const { root: projectRoot, projectType } = utils_1.getProjectConfig(tree, projectName);
@@ -58,9 +43,16 @@ function convert(schema) {
             isRootAngularProject || schema.ignoreExistingTslintConfig
                 ? schematics_1.noop()
                 : removeExtendsFromProjectTSLintConfigBeforeConverting(tree, projectTSLintJsonPath),
-            isRootAngularProject || schema.ignoreExistingTslintConfig
+            isRootAngularProject
                 ? schematics_1.noop()
-                : convertNonRootTSLintConfig(schema, projectRoot, projectType, projectTSLintJsonPath, rootESLintrcJsonPath),
+                : schema.ignoreExistingTslintConfig
+                    ? schematics_1.chain([
+                        // Create the latest recommended ESLint config file for the project
+                        utils_1.createESLintConfigForProject(projectName),
+                        // Delete the TSLint config file for the project
+                        utils_1.removeTSLintJSONForProject(projectName),
+                    ])
+                    : convertNonRootTSLintConfig(schema, projectRoot, projectType, projectTSLintJsonPath, rootESLintrcJsonPath),
             function cleanUpTSLintIfNoLongerInUse(tree) {
                 if (schema.removeTslintIfNoMoreTslintTargets &&
                     !utils_1.isTSLintUsedInWorkspace(tree)) {

package/dist/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sortObjectByKeys = exports.createRootESLintConfigFile = exports.removeTSLintJSONForProject = exports.createESLintConfigForProject = exports.createRootESLintConfig = exports.setESLintProjectBasedOnProjectType = exports.visitNotIgnoredFiles = exports.addESLintTargetToProject = exports.updateWorkspaceInTree = exports.offsetFromRoot = exports.getProjectConfig = exports.isTSLintUsedInWorkspace = exports.getWorkspacePath = exports.updateJsonInTree = exports.readJsonInTree = void 0;
+exports.determineTargetProjectName = exports.sortObjectByKeys = exports.removeTSLintJSONForProject = exports.createESLintConfigForProject = exports.createRootESLintConfig = exports.setESLintProjectBasedOnProjectType = exports.visitNotIgnoredFiles = exports.addESLintTargetToProject = exports.updateWorkspaceInTree = exports.offsetFromRoot = exports.getProjectConfig = exports.isTSLintUsedInWorkspace = exports.getWorkspacePath = exports.updateJsonInTree = exports.readJsonInTree = void 0;
 const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
 const ignore_1 = __importDefault(require("ignore"));
@@ -273,11 +273,10 @@ function createESLintConfigForProject(projectName) {
         const { root: projectRoot, projectType, prefix } = angularJSON.projects[projectName];
         /**
          * If the root is an empty string it must be the initial project created at the
-         * root by the Angular CLI's workspace schematic. We handle creating the root level
-         * config in our own workspace schematic.
+         * root by the Angular CLI's workspace schematic
          */
         if (projectRoot === '') {
-            return;
+            return createRootESLintConfigFile(projectName);
         }
         return updateJsonInTree(core_1.join(core_1.normalize(projectRoot), '.eslintrc.json'), () => createProjectESLintConfig(tree.root.path, projectRoot, projectType, prefix));
     };
@@ -287,23 +286,25 @@ function removeTSLintJSONForProject(projectName) {
     return (tree) => {
         const angularJSON = readJsonInTree(tree, 'angular.json');
         const { root: projectRoot } = angularJSON.projects[projectName];
-        tree.delete(core_1.join(core_1.normalize(projectRoot || '/'), 'tslint.json'));
+        const tslintJsonPath = core_1.join(core_1.normalize(projectRoot || '/'), 'tslint.json');
+        if (tree.exists(tslintJsonPath)) {
+            tree.delete(tslintJsonPath);
+        }
     };
 }
 exports.removeTSLintJSONForProject = removeTSLintJSONForProject;
-function createRootESLintConfigFile(workspaceName) {
+function createRootESLintConfigFile(projectName) {
     return (tree) => {
         var _a;
-        const angularJSON = readJsonInTree(tree, core_1.join(core_1.normalize(workspaceName), 'angular.json'));
+        const angularJSON = readJsonInTree(tree, getWorkspacePath(tree));
         let lintPrefix = null;
-        if ((_a = angularJSON.projects) === null || _a === void 0 ? void 0 : _a[workspaceName]) {
-            const { prefix } = angularJSON.projects[workspaceName];
+        if ((_a = angularJSON.projects) === null || _a === void 0 ? void 0 : _a[projectName]) {
+            const { prefix } = angularJSON.projects[projectName];
             lintPrefix = prefix;
         }
-        return updateJsonInTree(core_1.join(core_1.normalize(workspaceName), '.eslintrc.json'), () => createRootESLintConfig(lintPrefix));
+        return updateJsonInTree('.eslintrc.json', () => createRootESLintConfig(lintPrefix));
     };
 }
-exports.createRootESLintConfigFile = createRootESLintConfigFile;
 function sortObjectByKeys(obj) {
     return Object.keys(obj)
         .sort()
@@ -312,3 +313,19 @@ function sortObjectByKeys(obj) {
     }, {});
 }
 exports.sortObjectByKeys = sortObjectByKeys;
+/**
+ * To make certain schematic usage conversion more ergonomic, if the user does not specify a project
+ * and only has a single project in their angular.json we will just go ahead and use that one.
+ */
+function determineTargetProjectName(tree, maybeProject) {
+    if (maybeProject) {
+        return maybeProject;
+    }
+    const workspaceJson = readJsonInTree(tree, getWorkspacePath(tree));
+    const projects = Object.keys(workspaceJson.projects);
+    if (projects.length === 1) {
+        return projects[0];
+    }
+    return null;
+}
+exports.determineTargetProjectName = determineTargetProjectName;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@angular-eslint/schematics",
-  "version": "4.1.0-tmp.2",
+  "version": "4.2.0",
   "description": "Angular Schematics for angular-eslint",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "prebuild": "ncp ../../node_modules/@schematics/angular/application/schema.json src/application/schema.json && ncp ../../node_modules/@schematics/angular/library/schema.json src/library/schema.json",
-    "build": "rimraf ./dist && tsc -p tsconfig.json && ncp src/collection.json dist/collection.json && ncp src/migrations.json dist/migrations.json && ncp src/ng-add/schema.json dist/ng-add/schema.json && ncp src/convert-tslint-to-eslint/schema.json dist/convert-tslint-to-eslint/schema.json && ncp src/application/schema.json dist/application/schema.json && ncp src/library/schema.json dist/library/schema.json && ncp src/workspace/schema.json dist/workspace/schema.json",
+    "build": "rimraf ./dist && tsc -p tsconfig.json && ncp src/collection.json dist/collection.json && ncp src/migrations.json dist/migrations.json && ncp src/ng-add/schema.json dist/ng-add/schema.json && ncp src/convert-tslint-to-eslint/schema.json dist/convert-tslint-to-eslint/schema.json && ncp src/application/schema.json dist/application/schema.json && ncp src/library/schema.json dist/library/schema.json && ncp src/workspace/schema.json dist/workspace/schema.json && ncp src/add-eslint-to-project/schema.json dist/add-eslint-to-project/schema.json",
     "test": "jest --coverage",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "clean": "rimraf ./dist"
@@ -31,8 +31,8 @@
     "save": "devDependencies"
   },
   "dependencies": {
-    "@angular-eslint/eslint-plugin": "^4.1.0-tmp.2",
-    "@angular-eslint/eslint-plugin-template": "^4.1.0-tmp.2",
+    "@angular-eslint/eslint-plugin": "4.2.0",
+    "@angular-eslint/eslint-plugin-template": "4.2.0",
     "ignore": "5.1.8",
     "strip-json-comments": "3.1.1",
     "tmp": "0.2.1"
@@ -46,5 +46,5 @@
   "peerDependencies": {
     "@angular/cli": ">= 11.2.0 < 12.0.0"
   },
-  "gitHead": "c8b4cab0d3c90b99f3b6b233d1ac8dacb9c27d10"
+  "gitHead": "e1af184da7fbb88902635cd539223ecdaa88c0b8"
 }