feat: add Angular schematics (#220)

Author: timdeschryver

angular.json

@@ -20,13 +20,8 @@
             "main": "apps/example-app/src/main.ts",
             "polyfills": "apps/example-app/src/polyfills.ts",
             "tsConfig": "apps/example-app/tsconfig.app.json",
-            "assets": [
-              "apps/example-app/src/favicon.ico",
-              "apps/example-app/src/assets"
-            ],
-            "styles": [
-              "apps/example-app/src/styles.css"
-            ],
+            "assets": ["apps/example-app/src/favicon.ico", "apps/example-app/src/assets"],
+            "styles": ["apps/example-app/src/styles.css"],
             "scripts": [],
             "vendorChunk": true,
             "extractLicenses": false,
@@ -58,9 +53,7 @@
               "buildOptimizer": true
             }
           },
-          "outputs": [
-            "{options.outputPath}"
-          ]
+          "outputs": ["{options.outputPath}"]
         },
         "serve": {
           "builder": "@angular-devkit/build-angular:dev-server",
@@ -97,9 +90,7 @@
             "jestConfig": "apps/example-app/jest.config.js",
             "setupFile": "apps/example-app/src/test-setup.ts"
           },
-          "outputs": [
-            "coverage/"
-          ]
+          "outputs": ["coverage/"]
         }
       }
     },
@@ -144,6 +135,9 @@
               },
               {
                 "command": "cpy ./README.md ./dist/@testing-library/angular"
+              },
+              {
+                "command": "cpy schematics/**/*.json ../../dist/@testing-library/angular --cwd=./projects/testing-library --parents"
               }
             ]
           }
@@ -154,9 +148,7 @@
             "jestConfig": "projects/testing-library/jest.config.js",
             "setupFile": "projects/testing-library/test-setup.ts"
           },
-          "outputs": [
-            "coverage/projects/testing-library"
-          ]
+          "outputs": ["coverage/projects/testing-library"]
         }
       }
     },
@@ -208,11 +200,9 @@
             "jestConfig": "projects/jest-utils/jest.config.js",
             "setupFile": "projects/jest-utils/test-setup.ts"
           },
-          "outputs": [
-            "coverage/projects/jest-utils"
-          ]
+          "outputs": ["coverage/projects/jest-utils"]
         }
       }
     }
   }
-}
+}

migrations.json

@@ -21,6 +21,13 @@
     "url": "https://github.com/testing-library/angular-testing-library/issues"
   },
   "homepage": "https://github.com/testing-library/angular-testing-library#readme",
+  "schematics": "./schematics/collection.json",
+  "ng-add": {
+    "save": "devDependencies"
+  },
+  "ng-update": {
+    "migrations": "./schematics/migrations/migration.json"
+  },
   "peerDependencies": {
     "@angular/common": ">= 10.0.0",
     "@angular/platform-browser": ">= 10.0.0",

projects/testing-library/package.json

@@ -0,0 +1,10 @@
+{
+  "schematics": {
+    "ng-add": {
+      "aliases": ["init"],
+      "factory": "./ng-add",
+      "schema": "./ng-add/schema.json",
+      "description": "Add @testing-library/angular to your application"
+    }
+  }
+}

projects/testing-library/schematics/collection.json

@@ -0,0 +1,3 @@
+{
+  "schematics": {}
+}

projects/testing-library/schematics/migrations/migration.json

@@ -0,0 +1,10 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+
+export default function (): Rule {
+  return (_host: Tree, context: SchematicContext) => {
+    context.logger.info(
+      `Correctly installed @testing-library/angular.
+See our docs at https://testing-library.com/docs/angular-testing-library/intro/ to get started.`,
+    );
+  };
+}

projects/testing-library/schematics/ng-add/index.ts

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsTestingLibraryAngular",
+  "title": "testing-library-anguular",
+  "type": "object",
+  "properties": {},
+  "required": []
+}

projects/testing-library/schematics/ng-add/schema.json

@@ -0,0 +1,2 @@
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface Schema {}