Improve documentation of a new project

Author: xaviermonin

dist/template/new/src/app/app.component.ts

@@ -1,12 +1,37 @@
-import { MnComponent, OnInit } from "@primno/core";
+import { MnComponent, PageType, MnOnFormLoad, MnOnFieldChange, FormEventArg } from "@primno/core";
 
+/**
+ * The AppComponent class is defined as a component by the @MnComponent decorator.
+ * A component is a class that contains an individual piece of functionality to apply to a form or a grid.
+ * This sample component will show a notification when the form is loaded and when the name field is changed.
+ */
 @MnComponent({
+    /**
+     * The scope define when the component will be loaded.
+     * In this case, the component will be loaded on forms of the account entity.
+    */
     scope: {
-        pageType: "entityrecord"
+        pageType: PageType.record,
+        entityName: "account"
     }
 })
-export class AppComponent implements OnInit {
-    public mnOnInit(): void {
-        Xrm.Navigation.openAlertDialog({ text: "Welcome from Primno" });
+export class AppComponent {
+    /**
+     * onFormLoad is an event handler that will be called when the form is loaded due to the @MnOnFormLoad decorator.
+     * Show the notification "Welcome from Primno".
+     */
+    @MnOnFormLoad()
+    public onFormLoad(eventArg: FormEventArg) {
+        eventArg.formCtx.ui.setFormNotification("Welcome from Primno", "INFO", "welcome");
+    }
+
+    /**
+     * onNameChange is an event handler that will be called when the name field is changed due to the @MnOnFieldChange decorator.
+     * Show the notification "Name changed to <name>".
+    */
+    @MnOnFieldChange("name")
+    public onNameChange(eventArg: FormEventArg) {
+        const name = eventArg.formCtx.getAttribute("name").getValue();
+        eventArg.formCtx.ui.setFormNotification(`Name changed to ${name}`, "INFO", "nameChanged");
     }
 }

dist/template/new/src/app/app.module.ts

@@ -1,8 +1,22 @@
 import { MnModule } from "@primno/core";
 import { AppComponent } from "./app.component";
 
+/**
+ * The AppModule class is defined as a module by the @MnModule decorator.
+ * A module is a container of components.
+ */
 @MnModule({
+    /**
+     * The bootstrap property defines that AppComponent will be the root component of the module
+     * and will be created when the module is loaded.
+    */
     bootstrap: AppComponent,
+    /**
+     * The declarations property defines the components that will be available to be child components of the others components of this module.
+     * In this case, the AppComponent is the only component of this module.
+     * If you want to create a component that will be a child of the AppComponent, you must define it in the declarations property.
+     * A component can be declared in only one module.
+    */
     declarations: [
         AppComponent
     ]

dist/template/new/src/entry-point/app.ts

@@ -1 +1,6 @@
+/**
+ * An entry point corresponds to a webresource that will be deployed to PowerApps / Dynamics 365.
+ * The main(s) module(s) must be exported here to be loaded and run by Primno.
+*/
+
 export { AppModule } from "../app/app.module";

src/configuration/workspace-configuration.ts

@@ -43,7 +43,7 @@ export interface WorkspaceConfig {
 export const defaultEnvironnements: Environnement[] = [
     {
         name: "dev",
-        connectionString: ""
+        connectionString: "<set connection string>"
     }
 ];
 

src/core/workspace.ts

@@ -212,7 +212,7 @@ export class Workspace {
         const workspaceDir = path.join(dirPath, name);
 
         if (fs.existsSync(workspaceDir)) {
-            throw new Error("Directory already exist");
+            throw new Error("Directory already exists");
         }
 
         fs.mkdirSync(workspaceDir);