@skyux-sdk/eslint-schematics 12.8.0

package/README.md

@@ -0,0 +1 @@
+# @skyux-sdk/eslint-schematics

package/collection.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "../../../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "schematics": {
+    "ng-add": {
+      "description": "Add @skyux-sdk/eslint-schematics to your project.",
+      "factory": "./src/schematics/ng-add/ng-add.schematic",
+      "schema": "./src/schematics/ng-add/schema.json"
+    }
+  }
+}

package/migrations.json

@@ -0,0 +1,9 @@
+{
+  "schematics": {
+    "noop": {
+      "version": "12.8.0",
+      "factory": "./src/schematics/migrations/noop/noop.schematic",
+      "description": "Update skyux-eslint dependencies"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@skyux-sdk/eslint-schematics",
+  "version": "12.8.0",
+  "author": "Blackbaud, Inc.",
+  "description": "SKY UX ESLint schematics for Angular CLI projects",
+  "keywords": [
+    "blackbaud",
+    "skyux"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/blackbaud/skyux.git"
+  },
+  "bugs": {
+    "url": "https://github.com/blackbaud/skyux/issues"
+  },
+  "homepage": "https://github.com/blackbaud/skyux#readme",
+  "schematics": "./collection.json",
+  "ng-add": {
+    "save": "devDependencies"
+  },
+  "ng-update": {
+    "packageGroupName": "@skyux-sdk/eslint-schematics",
+    "migrations": "./migrations.json",
+    "packageGroup": {
+      "skyux-eslint": "12.8.0"
+    }
+  },
+  "peerDependencies": {
+    "@angular/cli": "^19.2.8"
+  },
+  "dependencies": {
+    "semver": "7.7.1",
+    "tslib": "^2.8.1"
+  },
+  "types": "./src/index.d.ts",
+  "main": "./src/index.js",
+  "type": "commonjs"
+}

package/src/schematics/migrations/noop/noop.schematic.d.ts

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

package/src/schematics/migrations/noop/noop.schematic.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+function default_1() {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    return () => { };
+}
+//# sourceMappingURL=noop.schematic.js.map

package/src/schematics/migrations/noop/noop.schematic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noop.schematic.js","sourceRoot":"","sources":["../../../../../../../../libs/sdk/eslint-schematics/src/schematics/migrations/noop/noop.schematic.ts"],"names":[],"mappings":";;AAEA,4BAGC;AAHD;IACE,gEAAgE;IAChE,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;AAClB,CAAC"}

package/src/schematics/ng-add/ng-add.schematic.d.ts

@@ -0,0 +1,5 @@
+import { Rule } from '@angular-devkit/schematics';
+/**
+ * Adds `skyux-eslint` to an existing `angular-eslint` config file.
+ */
+export default function ngAdd(): Rule;

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

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = ngAdd;
+const tslib_1 = require("tslib");
+const cli_1 = require("@angular/cli");
+const dependencies_1 = require("@schematics/angular/utility/dependencies");
+const semver_1 = tslib_1.__importDefault(require("semver"));
+const ESLINT_CONFIG_EXTENDS_REGEXP = /(?<=extends:\s*\[)[^\]]*(?=])/g;
+const MODULE_EXPORTS_REGEXP = /\nmodule\.exports/;
+function getRootEslintConfigFilePath(tree) {
+    if (!(0, dependencies_1.getPackageJsonDependency)(tree, 'angular-eslint')) {
+        throw new Error("The package 'angular-eslint' is not installed. " +
+            `Run 'ng add angular-eslint@${cli_1.VERSION.major}' and try this command again.\n` +
+            'See: https://github.com/angular-eslint/angular-eslint#quick-start');
+    }
+    const eslintDependency = (0, dependencies_1.getPackageJsonDependency)(tree, 'eslint');
+    const eslintMajorVersion = eslintDependency && semver_1.default.minVersion(eslintDependency.version)?.major;
+    if (eslintMajorVersion && eslintMajorVersion < 9) {
+        throw new Error("The 'skyux-eslint' package requires eslint version 9.");
+    }
+    let foundFile;
+    tree.getDir('/').visit((filePath) => {
+        if (foundFile) {
+            return;
+        }
+        if (filePath.match(/^\/\.eslintrc/)) {
+            throw new Error("The 'skyux-eslint' package does not support ESLint's legacy config. " +
+                'Migrate to ESLint\'s "flat" config and try the command again.');
+        }
+        if (filePath.match(/^\/eslint\.config\.(js|mjs|cjs)$/)) {
+            foundFile = filePath;
+        }
+    });
+    if (!foundFile) {
+        throw new Error('A compatible ESLint config file could not be found.');
+    }
+    return foundFile;
+}
+/**
+ * Adds `skyux-eslint` to an existing `angular-eslint` config file.
+ */
+function ngAdd() {
+    return (tree) => {
+        const configFile = getRootEslintConfigFilePath(tree);
+        const contents = tree.readText(configFile);
+        const recorder = tree.beginUpdate(configFile);
+        const exportsMatch = MODULE_EXPORTS_REGEXP.exec(contents);
+        if (exportsMatch) {
+            recorder.insertLeft(exportsMatch.index, 'const skyux = require("skyux-eslint");\n');
+        }
+        const statements = [
+            'skyux.configs.templateRecommended',
+            'skyux.configs.tsRecommended',
+        ];
+        contents.match(ESLINT_CONFIG_EXTENDS_REGEXP)?.forEach((element) => {
+            recorder.insertRight(contents.indexOf(element) + element.length, `${' '.repeat(2)}...${statements.pop()},\n${' '.repeat(4)}`);
+        });
+        tree.commitUpdate(recorder);
+    };
+}
+//# sourceMappingURL=ng-add.schematic.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ng-add.schematic.js","sourceRoot":"","sources":["../../../../../../../libs/sdk/eslint-schematics/src/schematics/ng-add/ng-add.schematic.ts"],"names":[],"mappings":";;AAuDA,wBA8BC;;AApFD,sCAAuC;AACvC,2EAAoF;AAEpF,4DAA4B;AAE5B,MAAM,4BAA4B,GAAG,gCAAgC,CAAC;AACtE,MAAM,qBAAqB,GAAG,mBAAmB,CAAC;AAElD,SAAS,2BAA2B,CAAC,IAAU;IAC7C,IAAI,CAAC,IAAA,uCAAwB,EAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,KAAK,CACb,iDAAiD;YAC/C,8BAA8B,aAAO,CAAC,KAAK,iCAAiC;YAC5E,mEAAmE,CACtE,CAAC;IACJ,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAA,uCAAwB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClE,MAAM,kBAAkB,GACtB,gBAAgB,IAAI,gBAAM,CAAC,UAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IAEzE,IAAI,kBAAkB,IAAI,kBAAkB,GAAG,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,SAA6B,CAAC;IAElC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClC,IAAI,SAAS,EAAE,CAAC;YACd,OAAO;QACT,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,sEAAsE;gBACpE,+DAA+D,CAClE,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,CAAC,kCAAkC,CAAC,EAAE,CAAC;YACvD,SAAS,GAAG,QAAQ,CAAC;QACvB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,SAAwB,KAAK;IAC3B,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,UAAU,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAC;QAErD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAE9C,MAAM,YAAY,GAAG,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE1D,IAAI,YAAY,EAAE,CAAC;YACjB,QAAQ,CAAC,UAAU,CACjB,YAAY,CAAC,KAAK,EAClB,0CAA0C,CAC3C,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG;YACjB,mCAAmC;YACnC,6BAA6B;SAC9B,CAAC;QAEF,QAAQ,CAAC,KAAK,CAAC,4BAA4B,CAAC,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAChE,QAAQ,CAAC,WAAW,CAClB,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,EAC1C,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAC5D,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC,CAAC;AACJ,CAAC"}

package/src/schematics/ng-add/schema.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "type": "object",
+  "properties": {}
+}

package/src/schematics/testing/scaffold.d.ts

@@ -0,0 +1,15 @@
+import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
+/**
+ * Creates a new Angular CLI application.
+ */
+export declare function createTestApp(runner: SchematicTestRunner, appOptions: {
+    setupEslint?: boolean;
+    projectName: string;
+}): Promise<UnitTestTree>;
+/**
+ * Create a test workspace with a library as the default project.
+ */
+export declare function createTestLibrary(runner: SchematicTestRunner, libOptions: {
+    setupEslint?: boolean;
+    projectName: string;
+}): Promise<UnitTestTree>;

package/src/schematics/testing/scaffold.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestApp = createTestApp;
+exports.createTestLibrary = createTestLibrary;
+const cli_1 = require("@angular/cli");
+/**
+ * Creates a new Angular CLI application.
+ */
+async function createTestApp(runner, appOptions) {
+    const tree = await runner.runExternalSchematic('@schematics/angular', 'ng-new', {
+        directory: '/',
+        name: appOptions.projectName,
+        routing: true,
+        strict: true,
+        style: 'scss',
+        version: cli_1.VERSION.major,
+    });
+    if (appOptions.setupEslint) {
+        await runner.runExternalSchematic('angular-eslint', 'ng-add', {}, tree);
+    }
+    return tree;
+}
+/**
+ * Create a test workspace with a library as the default project.
+ */
+async function createTestLibrary(runner, libOptions) {
+    const tree = await runner.runExternalSchematic('@schematics/angular', 'ng-new', {
+        directory: '/',
+        name: `${libOptions.projectName}-workspace`,
+        createApplication: false,
+        strict: true,
+        version: cli_1.VERSION.major,
+    });
+    if (libOptions.setupEslint) {
+        await runner.runExternalSchematic('angular-eslint', 'ng-add', {}, tree);
+    }
+    await runner.runExternalSchematic('@schematics/angular', 'library', {
+        name: libOptions.projectName,
+    }, tree);
+    // Create a "showcase" application for library projects.
+    await runner.runExternalSchematic('@schematics/angular', 'application', {
+        name: `${libOptions.projectName}-showcase`,
+    }, tree);
+    if (libOptions.setupEslint) {
+        await runner.runExternalSchematic('angular-eslint', 'add-eslint-to-project', {
+            project: libOptions.projectName,
+        }, tree);
+        await runner.runExternalSchematic('angular-eslint', 'add-eslint-to-project', {
+            project: `${libOptions.projectName}-showcase`,
+        }, tree);
+    }
+    return tree;
+}
+//# sourceMappingURL=scaffold.js.map

package/src/schematics/testing/scaffold.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../../../../../../../libs/sdk/eslint-schematics/src/schematics/testing/scaffold.ts"],"names":[],"mappings":";;AASA,sCAyBC;AAKD,8CA+DC;AAlGD,sCAAuC;AAEvC;;GAEG;AACI,KAAK,UAAU,aAAa,CACjC,MAA2B,EAC3B,UAGC;IAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAC5C,qBAAqB,EACrB,QAAQ,EACR;QACE,SAAS,EAAE,GAAG;QACd,IAAI,EAAE,UAAU,CAAC,WAAW;QAC5B,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,aAAO,CAAC,KAAK;KACvB,CACF,CAAC;IAEF,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;QAC3B,MAAM,MAAM,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,iBAAiB,CACrC,MAA2B,EAC3B,UAGC;IAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAC5C,qBAAqB,EACrB,QAAQ,EACR;QACE,SAAS,EAAE,GAAG;QACd,IAAI,EAAE,GAAG,UAAU,CAAC,WAAW,YAAY;QAC3C,iBAAiB,EAAE,KAAK;QACxB,MAAM,EAAE,IAAI;QACZ,OAAO,EAAE,aAAO,CAAC,KAAK;KACvB,CACF,CAAC;IAEF,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;QAC3B,MAAM,MAAM,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,MAAM,CAAC,oBAAoB,CAC/B,qBAAqB,EACrB,SAAS,EACT;QACE,IAAI,EAAE,UAAU,CAAC,WAAW;KAC7B,EACD,IAAI,CACL,CAAC;IAEF,wDAAwD;IACxD,MAAM,MAAM,CAAC,oBAAoB,CAC/B,qBAAqB,EACrB,aAAa,EACb;QACE,IAAI,EAAE,GAAG,UAAU,CAAC,WAAW,WAAW;KAC3C,EACD,IAAI,CACL,CAAC;IAEF,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;QAC3B,MAAM,MAAM,CAAC,oBAAoB,CAC/B,gBAAgB,EAChB,uBAAuB,EACvB;YACE,OAAO,EAAE,UAAU,CAAC,WAAW;SAChC,EACD,IAAI,CACL,CAAC;QAEF,MAAM,MAAM,CAAC,oBAAoB,CAC/B,gBAAgB,EAChB,uBAAuB,EACvB;YACE,OAAO,EAAE,GAAG,UAAU,CAAC,WAAW,WAAW;SAC9C,EACD,IAAI,CACL,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}