✨ Added ng add schematic support to lazy-dialogs project

Author: SwabianCoder

projects/lazy-dialogs/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0-rc.5] - 2022-08-22
+
+### Added
+
+- Support for ng add schematic
+
 ## [1.0.0-rc.4] - 2022-08-19
 
 ### Changed

projects/lazy-dialogs/README.md

@@ -10,9 +10,7 @@
 - [@ngx-toolset/lazy-dialogs](#ngx-toolsetlazy-dialogs)
   - [Features](#features)
   - [Installation](#installation)
-    - [NPM](#npm)
   - [Usage](#usage)
-    - [Module Import](#module-import)
     - [Dialog Container and Background Overlay Styles](#dialog-container-and-background-overlay-styles)
     - [Standalone Component](#standalone-component)
     - [Open Standalone Component Dialog](#open-standalone-component-dialog)
@@ -25,39 +23,12 @@
 
 ## Installation
 
-### NPM
-
-`npm install @ngx-toolset/lazy-dialogs --save`
-
-Choose the version corresponding to your Angular version:
-
-| Angular | @ngx-toolset/lazy-dialogs |
-|---------|---------------------------|
-| 14.x.x  | 1.x.x                     |
+```
+ng add @ngx-toolset/lazy-dialogs
+```
 
 ## Usage
 
-### Module Import
-
-Import the `LazyDialogModule` in your `AppModule`:
-
-```ts
-import { NgModule } from '@angular/core';
-import { BrowserModule } from '@angular/platform-browser';
-import { AppComponent } from './app.component';
-import { LazyDialogModule } from '@ngx-toolset/lazy-dialogs';
-
-@NgModule({
-  declarations: [AppComponent],
-  imports: [
-    BrowserModule,
-    LazyDialogModule.forRoot(),
-  ],
-  bootstrap: [AppComponent],
-})
-export class AppModule {}
-```
-
 ### Dialog Container and Background Overlay Styles
 
 Provide your own CSS styles for the dialog's container which can also act as the dialog's background overlay to the `forRoot` function of the `LazyDialogModule`:

projects/lazy-dialogs/package.json

@@ -1,6 +1,14 @@
 {
   "name": "@ngx-toolset/lazy-dialogs",
-  "version": "1.0.0-rc.4",
+  "version": "1.0.0-rc.5",
+  "scripts": {
+    "build": "tsc -p tsconfig.schematics.json",
+    "postbuild": "copyfiles schematics/*/schema.json schematics/*/files/** schematics/collection.json ../../dist/lazy-dialogs/"
+  },
+  "schematics": "./schematics/collection.json",
+  "ng-add": {
+    "save": "dependencies"
+  },
   "description": "Angular lazy dialogs support via service",
   "homepage": "https://github.com/SwabianCoder/ngx-toolset",
   "license": "MIT",
@@ -29,5 +37,9 @@
   },
   "dependencies": {
     "tslib": "^2.3.0"
+  },
+  "devDependencies": {
+    "copyfiles": "file:../../node_modules/copyfiles",
+    "typescript": "file:../../node_modules/typescript"
   }
 }

projects/lazy-dialogs/schematics/collection.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "../../../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "schematics": {
+    "ng-add": {
+      "description": "Add @ngx-toolset/lazy-dialogs to the project.",
+      "factory": "./ng-add/index#ngAdd"
+    }
+  }
+}

projects/lazy-dialogs/schematics/ng-add/index.ts

@@ -0,0 +1,59 @@
+import {
+  Rule,
+  SchematicContext,
+  SchematicsException,
+  Tree,
+} from '@angular-devkit/schematics';
+import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
+import { applyToUpdateRecorder } from '@schematics/angular/utility/change';
+import * as ts from 'typescript';
+import { addSymbolToNgModuleMetadata } from '../utility/ast-utils';
+
+export function ngAdd(): Rule {
+  return (tree: Tree, context: SchematicContext) => {
+    context.logger.info('Installing dependencies...');
+    context.addTask(new NodePackageInstallTask());
+
+    context.logger.info('Adding LazyDialogModule to the app...');
+    const appModulePath = './src/app/app.module.ts';
+
+    if (!tree.exists(appModulePath)) {
+      throw new SchematicsException(
+        `The file ${appModulePath} doesn't exist...`
+      );
+    }
+
+    const recorder = tree.beginUpdate(appModulePath);
+    const appModuleFileContent = tree.read(appModulePath);
+
+    if (appModuleFileContent === null) {
+      throw new SchematicsException(
+        `The content of ${appModulePath} couldn't be read...`
+      );
+    }
+
+    const appModuleFileText = appModuleFileContent.toString('utf-8');
+    const sourceFile = ts.createSourceFile(
+      appModulePath,
+      appModuleFileText,
+      ts.ScriptTarget.Latest,
+      true
+    );
+
+    applyToUpdateRecorder(
+      recorder,
+      addSymbolToNgModuleMetadata(
+        sourceFile,
+        appModulePath,
+        'imports',
+        'LazyDialogModule',
+        '@ngx-toolset/lazy-dialogs',
+        'LazyDialogModule.forRoot({})'
+      )
+    );
+
+    tree.commitUpdate(recorder);
+
+    return tree;
+  };
+}