@skyux-sdk/eslint-config 8.3.0 → 8.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux-sdk/eslint-config",
-  "version": "8.3.0",
+  "version": "8.4.0",
   "author": "Blackbaud, Inc.",
   "description": "Angular CLI schematics to implement recommended ESLint configuration",
   "keywords": [
@@ -33,6 +33,7 @@
   "dependencies": {
     "comment-json": "4.2.3",
     "fs-extra": "10.1.0",
+    "jsonc-parser": "3.2.0",
     "package-json": "7.0.0"
   },
   "main": "./src/index.js",

package/src/schematics/migrations/migration-collection.json

@@ -1,7 +1,7 @@
 {
   "schematics": {
     "noop": {
-      "version": "8.3.0",
+      "version": "8.4.0",
       "factory": "./noop/noop.schematic",
       "description": "Update ESLint dependencies"
     }

package/src/schematics/ng-add/ng-add.schematic.js

@@ -5,6 +5,7 @@ const fs_extra_1 = require("fs-extra");
 const path_1 = require("path");
 const install_dependencies_1 = require("../shared/rules/install-dependencies");
 const modify_eslint_config_1 = require("../shared/rules/modify-eslint-config");
+const modify_tsconfig_1 = require("../shared/rules/modify-tsconfig");
 const tree_1 = require("../shared/utility/tree");
 function getPackageJson(tree) {
     return JSON.parse((0, tree_1.readRequiredFile)(tree, '/package.json'));
@@ -29,6 +30,7 @@ function ngAdd() {
         return (0, schematics_1.chain)([
             (0, install_dependencies_1.installDependencies)(),
             (0, modify_eslint_config_1.modifyEsLintConfig)(),
+            (0, modify_tsconfig_1.modifyTsConfig)(),
             hardenPackageVersion(),
         ]);
     };

package/src/schematics/ng-add/ng-add.schematic.js.map

@@ -1 +1 @@
-{"version":3,"file":"ng-add.schematic.js","sourceRoot":"","sources":["../../../../../../../libs/sdk/eslint-config/src/schematics/ng-add/ng-add.schematic.ts"],"names":[],"mappings":";;AAAA,2DAA+D;AAE/D,uCAAoC;AACpC,+BAA+B;AAE/B,+EAA2E;AAC3E,+EAA0E;AAE1E,iDAA0D;AAE1D,SAAS,cAAc,CAAC,IAAU;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAA,uBAAgB,EAAC,IAAI,EAAE,eAAe,CAAC,CAAgB,CAAC;AAC5E,CAAC;AAED,SAAS,oBAAoB;IAC3B,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,eAAe,GAAG,MAAM,IAAA,mBAAQ,EACpC,IAAA,cAAO,EAAC,SAAS,EAAE,uBAAuB,CAAC,CAC5C,CAAC;QAEF,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,WAAW,CAAC,eAAe,KAAK,EAAE,CAAC;QACnC,WAAW,CAAC,eAAe,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC;QAE5E,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AAED,SAAwB,KAAK;IAC3B,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,4BAA4B,CAAC,EAAE;YAChE,MAAM,IAAI,KAAK,CACb,6DAA6D;gBAC3D,uEAAuE;gBACvE,mEAAmE,CACtE,CAAC;SACH;QAED,OAAO,IAAA,kBAAK,EAAC;YACX,IAAA,0CAAmB,GAAE;YACrB,IAAA,yCAAkB,GAAE;YACpB,oBAAoB,EAAE;SACvB,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAlBD,wBAkBC"}
+{"version":3,"file":"ng-add.schematic.js","sourceRoot":"","sources":["../../../../../../../libs/sdk/eslint-config/src/schematics/ng-add/ng-add.schematic.ts"],"names":[],"mappings":";;AAAA,2DAA+D;AAE/D,uCAAoC;AACpC,+BAA+B;AAE/B,+EAA2E;AAC3E,+EAA0E;AAC1E,qEAAiE;AAEjE,iDAA0D;AAE1D,SAAS,cAAc,CAAC,IAAU;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAA,uBAAgB,EAAC,IAAI,EAAE,eAAe,CAAC,CAAgB,CAAC;AAC5E,CAAC;AAED,SAAS,oBAAoB;IAC3B,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,eAAe,GAAG,MAAM,IAAA,mBAAQ,EACpC,IAAA,cAAO,EAAC,SAAS,EAAE,uBAAuB,CAAC,CAC5C,CAAC;QAEF,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACzC,WAAW,CAAC,eAAe,KAAK,EAAE,CAAC;QACnC,WAAW,CAAC,eAAe,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC;QAE5E,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AAED,SAAwB,KAAK;IAC3B,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,4BAA4B,CAAC,EAAE;YAChE,MAAM,IAAI,KAAK,CACb,6DAA6D;gBAC3D,uEAAuE;gBACvE,mEAAmE,CACtE,CAAC;SACH;QAED,OAAO,IAAA,kBAAK,EAAC;YACX,IAAA,0CAAmB,GAAE;YACrB,IAAA,yCAAkB,GAAE;YACpB,IAAA,gCAAc,GAAE;YAChB,oBAAoB,EAAE;SACvB,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAnBD,wBAmBC"}

package/src/schematics/shared/rules/modify-tsconfig.d.ts

@@ -0,0 +1,2 @@
+import { Rule } from '@angular-devkit/schematics';
+export declare function modifyTsConfig(): Rule;

package/src/schematics/shared/rules/modify-tsconfig.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.modifyTsConfig = void 0;
+const json_file_1 = require("../utility/json-file");
+function modifyTsConfig() {
+    return (tree) => {
+        const tsConfig = new json_file_1.JsonFile(tree, '/tsconfig.json');
+        // Strict null checks are needed for the 'prefer-nullish-coalescing' rule.
+        tsConfig.modify(['compilerOptions', 'strictNullChecks'], true);
+    };
+}
+exports.modifyTsConfig = modifyTsConfig;
+//# sourceMappingURL=modify-tsconfig.js.map

package/src/schematics/shared/rules/modify-tsconfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modify-tsconfig.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/eslint-config/src/schematics/shared/rules/modify-tsconfig.ts"],"names":[],"mappings":";;;AAEA,oDAAgD;AAEhD,SAAgB,cAAc;IAC5B,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QAEtD,0EAA0E;QAC1E,QAAQ,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC,CAAC;AACJ,CAAC;AAPD,wCAOC"}

package/src/schematics/shared/utility/json-file.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The contents of this file were copied from '@schematics/angular'.
+ * @see https://github.com/angular/angular-cli/blob/master/packages/schematics/angular/utility/json-file.ts
+ */
+import { JsonValue } from '@angular-devkit/core';
+import { Tree } from '@angular-devkit/schematics';
+export type InsertionIndex = (properties: string[]) => number;
+export type JsonPath = (string | number)[];
+/**
+ * Handles JSONC files (JSON files that include comments).
+ * @internal
+ */
+export declare class JsonFile {
+    private readonly host;
+    private readonly path;
+    content: string;
+    private get JsonAst();
+    private _jsonAst;
+    constructor(host: Tree, path: string);
+    get(jsonPath: JsonPath): unknown;
+    modify(jsonPath: JsonPath, value: JsonValue | undefined, insertInOrder?: InsertionIndex | false): void;
+    remove(jsonPath: JsonPath): void;
+}

package/src/schematics/shared/utility/json-file.js

@@ -0,0 +1,74 @@
+"use strict";
+/* istanbul ignore file */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonFile = void 0;
+const jsonc_parser_1 = require("jsonc-parser");
+/**
+ * Handles JSONC files (JSON files that include comments).
+ * @internal
+ */
+class JsonFile {
+    get JsonAst() {
+        if (this._jsonAst) {
+            return this._jsonAst;
+        }
+        const errors = [];
+        this._jsonAst = (0, jsonc_parser_1.parseTree)(this.content, errors, {
+            allowTrailingComma: true,
+        });
+        if (errors.length) {
+            const { error, offset } = errors[0];
+            throw new Error(`Failed to parse "${this.path}" as JSON AST Object. ${(0, jsonc_parser_1.printParseErrorCode)(error)} at location: ${offset}.`);
+        }
+        return this._jsonAst;
+    }
+    constructor(host, path) {
+        this.host = host;
+        this.path = path;
+        const buffer = this.host.read(this.path);
+        if (buffer) {
+            this.content = buffer.toString();
+        }
+        else {
+            throw new Error(`Could not read '${path}'.`);
+        }
+    }
+    get(jsonPath) {
+        const jsonAstNode = this.JsonAst;
+        if (!jsonAstNode) {
+            return undefined;
+        }
+        if (jsonPath.length === 0) {
+            return (0, jsonc_parser_1.getNodeValue)(jsonAstNode);
+        }
+        const node = (0, jsonc_parser_1.findNodeAtLocation)(jsonAstNode, jsonPath);
+        return node === undefined ? undefined : (0, jsonc_parser_1.getNodeValue)(node);
+    }
+    modify(jsonPath, value, insertInOrder) {
+        let getInsertionIndex;
+        if (insertInOrder === undefined) {
+            const property = jsonPath.slice(-1)[0];
+            getInsertionIndex = (properties) => [...properties, property].sort().findIndex((p) => p === property);
+        }
+        else if (insertInOrder !== false) {
+            getInsertionIndex = insertInOrder;
+        }
+        const edits = (0, jsonc_parser_1.modify)(this.content, jsonPath, value, {
+            getInsertionIndex,
+            formattingOptions: {
+                insertSpaces: true,
+                tabSize: 2,
+            },
+        });
+        this.content = (0, jsonc_parser_1.applyEdits)(this.content, edits);
+        this.host.overwrite(this.path, this.content);
+        this._jsonAst = undefined;
+    }
+    remove(jsonPath) {
+        if (this.get(jsonPath) !== undefined) {
+            this.modify(jsonPath, undefined);
+        }
+    }
+}
+exports.JsonFile = JsonFile;
+//# sourceMappingURL=json-file.js.map

package/src/schematics/shared/utility/json-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-file.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/eslint-config/src/schematics/shared/utility/json-file.ts"],"names":[],"mappings":";AAAA,0BAA0B;;;AAS1B,+CASsB;AAKtB;;;GAGG;AACH,MAAa,QAAQ;IAGnB,IAAY,OAAO;QACjB,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;SACtB;QAED,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,IAAA,wBAAS,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE;YAC9C,kBAAkB,EAAE,IAAI;SACzB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,oBACE,IAAI,CAAC,IACP,yBAAyB,IAAA,kCAAmB,EAC1C,KAAK,CACN,iBAAiB,MAAM,GAAG,CAC5B,CAAC;SACH;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAID,YAA6B,IAAU,EAAmB,IAAY;QAAzC,SAAI,GAAJ,IAAI,CAAM;QAAmB,SAAI,GAAJ,IAAI,CAAQ;QACpE,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;SAClC;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC,CAAC;SAC9C;IACH,CAAC;IAEM,GAAG,CAAC,QAAkB;QAC3B,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC;QACjC,IAAI,CAAC,WAAW,EAAE;YAChB,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,OAAO,IAAA,2BAAY,EAAC,WAAW,CAAC,CAAC;SAClC;QAED,MAAM,IAAI,GAAG,IAAA,iCAAkB,EAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAEvD,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,2BAAY,EAAC,IAAI,CAAC,CAAC;IAC7D,CAAC;IAEM,MAAM,CACX,QAAkB,EAClB,KAA4B,EAC5B,aAAsC;QAEtC,IAAI,iBAA6C,CAAC;QAClD,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACvC,iBAAiB,GAAG,CAAC,UAAU,EAAE,EAAE,CACjC,CAAC,GAAG,UAAU,EAAE,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;SACrE;aAAM,IAAI,aAAa,KAAK,KAAK,EAAE;YAClC,iBAAiB,GAAG,aAAa,CAAC;SACnC;QAED,MAAM,KAAK,GAAG,IAAA,qBAAM,EAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE;YAClD,iBAAiB;YACjB,iBAAiB,EAAE;gBACjB,YAAY,EAAE,IAAI;gBAClB,OAAO,EAAE,CAAC;aACX;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAA,yBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEM,MAAM,CAAC,QAAkB;QAC9B,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;SAClC;IACH,CAAC;CACF;AApFD,4BAoFC"}