Added documentation to templates

Author: obany

CHANGELOG.md

@@ -6,6 +6,7 @@
 * Added JsDoc
 * Added TypeDoc
 * Added documentation to framework sources files and generated elements
+* Change Plain App renamed to Vanilla
 
 ## 1.7.1
 

.eslintignore assets/appFramework/.eslintignore

@@ -21,23 +21,22 @@
     },
     "globals": {},
     "rules": {
-        "padded-blocks": "off",
+        "new-cap": "off",
+        "quote-props": "off",
         "sort-keys": "off",
+        "lines-around-comment": "off",
+        "no-useless-constructor": "off",
+        "space-before-function-paren": "off",
+        "padded-blocks": "off",
+        "sort-imports": "off",
         "object-curly-newline": "off",
         "array-bracket-newline": "off",
         "object-property-newline": "off",
-        "dot-location": "off",
-        "func-style": "off",
+        "function-paren-newline": "off",
+        "no-empty-function": "off",
         "global-require": "off",
-        "one-var": "off",
-        "multiline-ternary": "off",
-        "no-ternary": "off",
-        "no-nested-ternary": "off",
-        "no-process-exit": "off",
-        "no-magic-numbers": "off",
-        "arrow-parens": "off",
-        "guard-for-in": "off",
-        "callback-return": "off",
+        "dot-location": "off",
+        "arrow-body-style": "off",
         "max-len": [
             2,
             {
@@ -46,40 +45,34 @@
                 "ignoreUrls": true
             }
         ],
-        "max-statements": "off",
-        "no-plusplus": "off",
-        "id-length": "off",
-        "array-element-newline": "off",
+        "valid-jsdoc": "off",
+        "class-methods-use-this": "off",
+        "no-unused-vars": "off",
+        "func-style": "off",
+        "no-magic-numbers": "off",
+        "no-underscore-dangle": "off",
         "no-undefined": "off",
-        "arrow-body-style": "off",
-        "prefer-destructuring": "off",
-        "lines-around-comment": "off",
-        "no-else-return": "off",
-        "max-params": "off",
-        "require-jsdoc": "off",
-        "max-lines": "off",
-        "no-await-in-loop": "off",
-        "no-process-env": "off",
-        "no-empty-function": "off",
-        "consistent-return": "off",
-        "promise/avoid-new": "off",
-        "max-depth": "off",
+        "multiline-ternary": "off",
+        "no-ternary": "off",
+        "one-var": "off",
         "no-extra-parens": "off",
-        "no-console": "off",
-        "require-await": "off",
-        "space-before-function-paren": "off",
-        "quote-props": "off",
-        "object-curly-spacing": "off",
-        "new-cap": "off",
+        "no-inline-comments": "off",
+        "promise/always-return": "off",
         "babel/new-cap": 1,
         "babel/object-curly-spacing": 1,
         "babel/no-invalid-this": 1,
-        "babel/semi": 1
+        "babel/semi": 1,
+        "react/react-in-jsx-scope": "off"
     },
     "plugins": [
         "node",
         "promise",
         "react",
         "babel"
-    ]
+    ],
+    "settings": {
+        "react": {
+            "pragma": "h"
+        }
+    }
 }

.eslintrc.json assets/appFramework/.eslintrc.json

@@ -0,0 +1,35 @@
+/**
+ * Gen Name Human component class.
+ *
+ * @export
+ * @class GenNamePascalComponent
+ */
+import {Component} from "@angular/core";
+
+@Component({
+    moduleId: "genModuleId",
+    templateUrl: "./gen-name-snake.component.html",
+    styleUrls: ["./gen-name-snake.component.css"]
+})
+export class GenNamePascalComponent {
+    /**
+     * Message displayed in the view.
+     * @type {string}
+     */
+    message;
+
+    /**
+     * Creates an instance of GenNamePascalComponent.
+     */
+    constructor() {
+        this.message = "Hello Gen Name Human";
+    }
+
+    /**
+     * The component was initialized.
+     * @returns {void}
+     */
+    ngOnInit() {
+        this.message += " - onInit called";
+    }
+}

assets/appFramework/angular/generate/component/src/gen-name-snake.component.js

@@ -0,0 +1,35 @@
+/**
+ * Gen Name Human component class.
+ *
+ * @export
+ * @class GenNamePascalComponent
+ */
+import { Component, OnInit } from "@angular/core";
+
+@Component({
+    moduleId: "genModuleId",
+    templateUrl: "./gen-name-snake.component.html",
+    styleUrls: ["./gen-name-snake.component.css"]
+})
+export class GenNamePascalComponent implements OnInit {
+    /**
+     * Message displayed in the view.
+     * @type {string}
+     */
+    public message: string;
+
+    /**
+     * Creates an instance of GenNamePascalComponent.
+     */
+    constructor() {
+        this.message = "Hello Gen Name Human";
+    }
+
+    /**
+     * The component was initialized.
+     * @returns {void}
+     */
+    public ngOnInit(): void {
+        this.message += " - onInit called";
+    }
+}

assets/appFramework/angular/generate/component/src/gen-name-snake.component.ts

@@ -0,0 +1,3 @@
+.gen-name-snake-component {
+  font-size: 20px;
+}

assets/appFramework/angular/generate/component/src/{GEN_NAME_SNAKE}.js

@@ -0,0 +1,3 @@
+.gen-name-snake-component {
+  font-size: 20px;
+}

assets/appFramework/angular/generate/component/src/{GEN_NAME_SNAKE}.ts

@@ -0,0 +1,3 @@
+.gen-name-snake-component {
+  font-size: 20px;
+}

assets/appFramework/angular/generate/component/style/gen-name-snake.component.css

@@ -0,0 +1,2 @@
+.gen-name-snake-component
+  font-size: 20px

assets/appFramework/angular/generate/component/style/gen-name-snake.component.less

@@ -0,0 +1,11 @@
+/**
+ * Tests for GenNamePascalComponent.
+ */
+import {GenNamePascalComponent} from "../../src/gen-name-snake.component";
+
+describe("GenNamePascalComponent", () => {
+    it("can be created", () => {
+        const obj = new GenNamePascalComponent();
+        expect(obj).toBeDefined();
+    });
+});

assets/appFramework/angular/generate/component/style/gen-name-snake.component.scss

@@ -0,0 +1,11 @@
+/**
+ * Tests for GenNamePascalComponent.
+ */
+import { GenNamePascalComponent } from "../../src/gen-name-snake.component";
+
+describe("GenNamePascalComponent", () => {
+    it("can be created", () => {
+        const obj = new GenNamePascalComponent();
+        expect(obj).toBeDefined();
+    });
+});

assets/appFramework/angular/generate/component/style/gen-name-snake.component.styl

@@ -0,0 +1,12 @@
+/**
+ * Tests for GenNamePascalComponent.
+ */
+import chai from "chai";
+import {GenNamePascalComponent} from "../../src/gen-name-snake.component";
+
+describe("GenNamePascalComponent", () => {
+    it("can be created", () => {
+        const obj = new GenNamePascalComponent();
+        chai.should().exist(obj);
+    });
+});

assets/appFramework/angular/generate/component/style/{GEN_NAME_SNAKE}.css

@@ -0,0 +1,12 @@
+/**
+ * Tests for GenNamePascalComponent.
+ */
+import /* Synthetic Import */ chai from "chai";
+import { GenNamePascalComponent } from "../../src/gen-name-snake.component";
+
+describe("GenNamePascalComponent", () => {
+    it("can be created", () => {
+        const obj = new GenNamePascalComponent();
+        chai.should().exist(obj);
+    });
+});

assets/appFramework/angular/generate/component/style/{GEN_NAME_SNAKE}.less

@@ -0,0 +1,3 @@
+<div class="gen-name-snake-component">
+  {{ message }}
+</div>

assets/appFramework/angular/generate/component/style/{GEN_NAME_SNAKE}.scss

@@ -0,0 +1,18 @@
+/**
+ * Gen Name Human directive class.
+ *
+ * @export
+ * @class GenNamePascalDirective
+ */
+import {Directive} from "@angular/core";
+
+@Directive({
+    selector: "[appGenNamePascal]"
+})
+export class GenNamePascalDirective {
+    /**
+     * Creates an instance of GenNamePascalDirective.
+     */
+    constructor() {
+    }
+}

assets/appFramework/angular/generate/component/style/{GEN_NAME_SNAKE}.styl

@@ -0,0 +1,18 @@
+/**
+ * Gen Name Human directive class.
+ *
+ * @export
+ * @class GenNamePascalDirective
+ */
+import { Directive } from "@angular/core";
+
+@Directive({
+    selector: "[appGenNamePascal]"
+})
+export class GenNamePascalDirective {
+    /**
+     * Creates an instance of GenNamePascalDirective.
+     */
+    constructor() {
+    }
+}