regeneration TOC and add automatic list component generator (#2022)

ng2-components/README.md

@@ -1,63 +1,114 @@
 # Alfresco Angular Components
 
-## Base components
+<!-- markdown-toc start - Don't edit this section.  npm run toc to generate it-->
 
-- [Core library](ng2-alfresco-core/README.md)
+<!-- toc -->
-- [alfresco-viewer](ng2-alfresco-viewer/README.md)
+
+- [Core](#core)
+  * [Components](#components)
+  * [Directives](#directives)
+- [Content service](#content-service)
+  * [Components](#components-1)
+- [Business service](#business-service)
+  * [components](#components)
+
+<!-- tocstop -->
+
+<!-- markdown-toc end -->
+
+## Core
+
+### Components
+
+<!-- CORE START-->
+- [adf-card-view](ng2-alfresco-core/README.md)
 - [adf-accordion-group](ng2-alfresco-core/README.md)
 - [adf-accordion](ng2-alfresco-core/README.md)
+- [adf-toolbar](ng2-alfresco-core/README.md)<!-- CORE END-->
+<!-- CORE END-->
+
+### Directives
+
+<!-- CORE DIRECTIVE START-->
 - [context-menu](ng2-alfresco-core/README.md)
- * Context Menu component
+- [alfresco-mdl-textfield](ng2-alfresco-core/README.md)
+- [alfresco-mdl-menu](ng2-alfresco-core/README.md)
+- [alfresco-mdl-button](ng2-alfresco-core/README.md)
+- [mdl](ng2-alfresco-core/README.md)
+- [adf-upload](ng2-alfresco-core/README.md)<!-- CORE DIRECTIVE END-->
 
-## ECM components
+## Content service 
 
-- [alfresco-webscript-get](ng2-alfresco-webscript/README.md)
+### Components
-- [alfresco-pagination](ng2-alfresco-datatable/README.md)
+
-- [alfresco-datatable](ng2-alfresco-datatable/README.md)
+<!-- CONTENT START-->
-- [alfresco-login](ng2-alfresco-login/README.md)
+- [alfresco-viewer](ng2-alfresco-viewer/README.md)
-- [alfresco-tag-node-actions-list](ng2-alfresco-tag/README.md)
-- [alfresco-tag-list](ng2-alfresco-tag/README.md)
-- [alfresco-tag-node-list](ng2-alfresco-tag/README.md)
-- [alfresco-document-list](ng2-alfresco-documentlist/README.md)
-- [alfresco-document-menu-action](ng2-alfresco-documentlist/README.md)
-- [alfresco-document-list-breadcrumb](ng2-alfresco-documentlist/README.md)
-- [adf-rating](ng2-alfresco-social/README.md)
-- [adf-like](ng2-alfresco-social/README.md)
-- [alfresco-upload-drag-area](ng2-alfresco-upload/README.md)
-- [alfresco-upload-button](ng2-alfresco-upload/README.md)
-- [alfresco-file-uploading-list](ng2-alfresco-upload/README.md)
-- [alfresco-search](ng2-alfresco-search/README.md)
-- [alfresco-search-control](ng2-alfresco-search/README.md)
-- [alfresco-search-autocomplete](ng2-alfresco-search/README.md)
 - [ng2-alfresco-userinfo](ng2-alfresco-userinfo/README.md)
+- [alfresco-file-uploading-list](ng2-alfresco-upload/README.md)
+- [alfresco-upload-button](ng2-alfresco-upload/README.md)
+- [alfresco-upload-drag-area](ng2-alfresco-upload/README.md)
+- [alfresco-tag-node-list](ng2-alfresco-tag/README.md)
+- [alfresco-tag-list](ng2-alfresco-tag/README.md)
+- [alfresco-tag-node-actions-list](ng2-alfresco-tag/README.md)
+- [adf-like](ng2-alfresco-social/README.md)
+- [adf-rating](ng2-alfresco-social/README.md)
+- [alfresco-search-autocomplete](ng2-alfresco-search/README.md)
+- [alfresco-search-control](ng2-alfresco-search/README.md)
+- [alfresco-search](ng2-alfresco-search/README.md)
+- [alfresco-login](ng2-alfresco-login/README.md)
+- [adf-breadcrumb, alfresco-document-list-breadcrumb](ng2-alfresco-documentlist/README.md)
+- [alfresco-document-menu-action](ng2-alfresco-documentlist/README.md)
+- [alfresco-document-list](ng2-alfresco-documentlist/README.md)
+- [alfresco-datatable-cell](ng2-alfresco-datatable/README.md)
+- [alfresco-datatable](ng2-alfresco-datatable/README.md)
+- [alfresco-pagination](ng2-alfresco-datatable/README.md)
+- [alfresco-webscript-get](ng2-alfresco-webscript/README.md)<!-- CONTENT END-->
+<!-- CONTENT END-->
 
-## BPM components
 
-- [activiti-analytics](ng2-activiti-analytics/README.md)
+<!-- CONTENT DIRECTIVE START--><!-- CONTENT DIRECTIVE END-->
-- [activiti-analytics-generator](ng2-activiti-analytics/README.md)
+
-- [activiti-form](ng2-activiti-form/README.md)
+## Business service 
-- [activiti-content](ng2-activiti-form/README.md)
+
-- [activiti-start-form](ng2-activiti-form/README.md)
+### components
-- [activiti-process-instance-filters](ng2-activiti-processlist/README.md)
+
-- [activiti-process-instance-list](ng2-activiti-processlist/README.md)
+<!-- BUSINESS START-->
-- [activiti-process-instance-details](ng2-activiti-processlist/README.md)
+- [diagram-icon-alfresco-publish-task](ng2-activiti-diagrams/README.md)
-- [activiti-start-process](ng2-activiti-processlist/README.md)
+- [diagram-alfresco-publish-task](ng2-activiti-diagrams/README.md)
-- [activiti-apps](ng2-activiti-tasklist/README.md)
-- [activiti-tasklist](ng2-activiti-tasklist/README.md)
-- [activiti-checklist](ng2-activiti-tasklist/README.md)
-- [adf-task-attachment-list](ng2-activiti-tasklist/README.md)
-- [activiti-people](ng2-activiti-tasklist/README.md)
-- [activiti-comments](ng2-activiti-tasklist/README.md)
-- [activiti-task-header](ng2-activiti-tasklist/README.md)
-- [activiti-task-details](ng2-activiti-tasklist/README.md)
-- [activiti-start-task](ng2-activiti-tasklist/README.md)
-- [activiti-filters](ng2-activiti-tasklist/README.md)
-- [activiti-people-search](ng2-activiti-tasklist/README.md)
-- [activiti-process-instance-header](ng2-activiti-processlist/README.md)
-- [activiti-process-instance-tasks](ng2-activiti-processlist/README.md)
 - [activiti-process-instance-comments](ng2-activiti-processlist/README.md)
 - [activiti-process-instance-variables](ng2-activiti-processlist/README.md)
+- [activiti-process-instance-tasks](ng2-activiti-processlist/README.md)
+- [activiti-process-instance-header](ng2-activiti-processlist/README.md)
+- [adf-people-list](ng2-activiti-tasklist/README.md)
+- [adf-create-task-attachment](ng2-activiti-tasklist/README.md)
+- [activiti-people-search](ng2-activiti-tasklist/README.md)
+- [activiti-start-task](ng2-activiti-tasklist/README.md)
+- [activiti-task-details](ng2-activiti-tasklist/README.md)
+- [activiti-filters](ng2-activiti-tasklist/README.md)
+- [activiti-task-header](ng2-activiti-tasklist/README.md)
+- [activiti-people](ng2-activiti-tasklist/README.md)
+- [adf-task-attachment-list](ng2-activiti-tasklist/README.md)
+- [activiti-comments](ng2-activiti-tasklist/README.md)
+- [activiti-checklist](ng2-activiti-tasklist/README.md)
+- [activiti-tasklist](ng2-activiti-tasklist/README.md)
+- [activiti-apps](ng2-activiti-tasklist/README.md)
 - [activiti-diagram](ng2-activiti-diagrams/README.md)
+- [adf-create-process-attachment](ng2-activiti-processlist/README.md)
+- [adf-process-attachment-list](ng2-activiti-processlist/README.md)
+- [activiti-start-process](ng2-activiti-processlist/README.md)
+- [activiti-process-instance-details](ng2-activiti-processlist/README.md)
+- [activiti-process-instance-filters](ng2-activiti-processlist/README.md)
+- [activiti-process-instance-list](ng2-activiti-processlist/README.md)
+- [activiti-analytics-generator](ng2-activiti-analytics/README.md)
+- [activiti-analytics](ng2-activiti-analytics/README.md)
+- [activiti-start-form](ng2-activiti-form/README.md)
+- [activiti-content](ng2-activiti-form/README.md)
+- [activiti-form](ng2-activiti-form/README.md)<!-- BUSINESS END-->
+<!-- BUSINESS END-->
+
+
+<!-- BUSINESS DIRECTIVE START--><!-- BUSINESS DIRECTIVE END-->
+
 
 You can browse all the components at the following address:
 

ng2-components/config/custom-loaders/generateListComponent.js

@@ -0,0 +1,123 @@
+var path = require('path');
+var fs = require('fs');
+
+var erase = true;
+var readmeContent = null;
+var readmeFilePath = '';
+
+function isFileEmpty(fileContents) {
+    return fileContents.toString('utf8').trim() === '';
+}
+
+function writeFile(file, newValue) {
+    fs.writeFileSync(file, newValue, 'utf-8');
+}
+
+function readFile(file) {
+    return fs.readFileSync(file, 'utf8');
+}
+
+function eraseContentList() {
+    if (erase) {
+        erase = false;
+
+        var businessRegex = /(?:<!-- BUSINESS START-->)([\s\S]*?)(?:<!-- BUSINESS END-->)/;
+        var contentRegex = /(?:<!-- CONTENT START-->)([\s\S]*?)(?:<!-- CONTENT END-->)/;
+        var coreRegex = /(?:<!-- CORE START-->)([\s\S]*?)(?:<!-- CORE END-->)/;
+        var businessRegexDirective = /(?:<!-- BUSINESS DIRECTIVE START-->)([\s\S]*?)(?:<!-- BUSINESS DIRECTIVE END-->)/;
+        var contentRegexDirective = /(?:<!-- CONTENT DIRECTIVE START-->)([\s\S]*?)(?:<!-- CONTENT DIRECTIVE END-->)/;
+        var coreRegexDirective = /(?:<!-- CORE DIRECTIVE START-->)([\s\S]*?)(?:<!-- CORE DIRECTIVE END-->)/;
+
+        readmeContent = readmeContent.replace(businessRegex, '<!-- BUSINESS START--><!-- BUSINESS END-->');
+        readmeContent = readmeContent.replace(contentRegex, '<!-- CONTENT START--><!-- CONTENT END-->');
+        readmeContent = readmeContent.replace(coreRegex, '<!-- CORE START--><!-- CORE END-->');
+
+        readmeContent = readmeContent.replace(businessRegexDirective, '<!-- BUSINESS DIRECTIVE START--><!-- BUSINESS DIRECTIVE END-->');
+        readmeContent = readmeContent.replace(contentRegexDirective, '<!-- CONTENT DIRECTIVE START--><!-- CONTENT DIRECTIVE END-->');
+        readmeContent = readmeContent.replace(coreRegexDirective, '<!-- CORE DIRECTIVE START--><!-- CORE DIRECTIVE END-->');
+
+        writeFile(readmeFilePath, readmeContent)
+    }
+}
+
+function generateListComponent(currentFileContent, webpackInstance) {
+    if (!isFileEmpty(currentFileContent)) {
+
+        var componentReg = /(@Component)(\s?)\((\s?){(\s?)((.|\n)*)}(\s?)\)/gm;
+        var componentSection = componentReg.exec(currentFileContent);
+
+        if (componentSection) {
+            var selectorReg = /(selector)(\s?):(\s?)('|")((.|)*)('|")/gm;
+            var selector = selectorReg.exec(componentSection[0]);
+
+
+            if (selector) {
+                if (selector[0].indexOf('alfresco') > 0 || selector[0].indexOf('activiti') > 0 || selector[0].indexOf('adf') > 0) {
+                    var selector = selector[0].replace("selector: '[", "").replace("']", '').replace("]", '').replace("selector: '", "").replace("'", '');
+                    var removeRoot = webpackInstance.resourcePath.substr(webpackInstance.resourcePath.indexOf('/ng2-components') + 16, webpackInstance.resourcePath.length);
+                    var url = removeRoot.substr(0, removeRoot.indexOf('src')) + 'README.md';
+
+                    var link = '- [' + selector + '](' + url + ')';
+
+                    if (webpackInstance.resourcePath.match('ng2-alfresco-core')) {
+                        readmeContent = readmeContent.replace('<!-- CORE START-->', '<!-- CORE START-->\n' + link);
+                    } else if (webpackInstance.resourcePath.match('ng2-alfresco-')) {
+                        readmeContent = readmeContent.replace('<!-- CONTENT START-->', '<!-- CONTENT START-->\n' + link);
+                    } else if (webpackInstance.resourcePath.match('ng2-activiti-')) {
+                        readmeContent = readmeContent.replace('<!-- BUSINESS START-->', '<!-- BUSINESS START-->\n' + link);
+                    }
+                }
+            }
+        }
+
+
+        var directiveReg = /(@Directive)(\s?)\((\s?){(\s?)((.|\n)*)}(\s?)\)/gm;
+        var directiveSection = directiveReg.exec(currentFileContent);
+
+        if (directiveSection) {
+            var selectorReg = /(selector)(\s?):(\s?)('|")((.|)*)('|")/gm;
+            var selector = selectorReg.exec(directiveSection[0]);
+
+            if (selector) {
+                var selector = selector[0].replace("selector: '[", "").replace("']", '').replace("]", '').replace("selector: '", "").replace("'", '');
+                var removeRoot = webpackInstance.resourcePath.substr(webpackInstance.resourcePath.indexOf('/ng2-components') + 16, webpackInstance.resourcePath.length);
+                var url = removeRoot.substr(0, removeRoot.indexOf('src')) + 'README.md';
+
+                var link = '- [' + selector + '](' + url + ')';
+
+                if (webpackInstance.resourcePath.match('ng2-alfresco-core')) {
+                    readmeContent = readmeContent.replace('<!-- CORE DIRECTIVE START-->', '<!-- CORE DIRECTIVE START-->\n' + link);
+                }
+                //else if (webpackInstance.resourcePath.match('ng2-alfresco-')) {
+                //    readmeContent = readmeContent.replace('<!-- CONTENT DIRECTIVE START-->', '<!-- CONTENT DIRECTIVE START-->\n' + link);
+                //}
+                //else if (webpackInstance.resourcePath.match('ng2-activiti-')) {
+                //    readmeContent = readmeContent.replace('<!-- BUSINESS DIRECTIVE START-->', '<!-- BUSINESS DIRECTIVE START-->\n' + link);
+                //}
+            }
+        }
+
+        writeFile(readmeFilePath, readmeContent);
+
+        return true;
+    }
+}
+
+
+module.exports = function (input, map) {
+    this.cacheable && this.cacheable();
+    var callback = this.async();
+
+    readmeFilePath = path.resolve(__dirname, '../../README.md');
+
+    if (!readmeContent) {
+        readmeContent = readFile(readmeFilePath);
+    }
+
+    if (readmeContent) {
+        eraseContentList();
+        generateListComponent(input, this);
+    }
+    callback(null, input, map);
+}
+

ng2-components/config/webpack.common.js

@@ -34,7 +34,8 @@ module.exports = {
     resolveLoader: {
         alias: {
             "file-multi-loader": path.resolve(__dirname, "./custom-loaders/file-loader-multi"),
-            "license-check": path.resolve(__dirname, "./custom-loaders/license-check")
+            "license-check": path.resolve(__dirname, "./custom-loaders/license-check"),
+            "generate-list-component-loader": path.resolve(__dirname, "./custom-loaders/generateListComponent")
         }
     },
 

ng2-components/config/webpack.doc.js

@@ -0,0 +1,17 @@
+const helpers = require('./helpers');
+const webpackMerge = require('webpack-merge');
+const webpackBuild = require('./webpack.build');
+
+module.exports = webpackMerge(webpackBuild, {
+
+    module: {
+        rules: [
+
+            {
+                test: /\.ts/,
+                loader: 'generate-list-component-loader',
+                exclude: [/node_modules/, /bundles/, /dist/, /demo/]
+            }
+        ]
+    }
+});

ng2-components/ng2-activiti-form/README.md

@@ -22,6 +22,7 @@
   * [Methods](#methods)
 - [Common scenarios](#common-scenarios)
   * [Changing field value based on another field](#changing-field-value-based-on-another-field)
+  * [Listen all form Events](#listen-all-form-events)
 - [See also](#see-also)
 - [Build from sources](#build-from-sources)
 - [NPM scripts](#npm-scripts)

ng2-components/ng2-activiti-tasklist/README.md

@@ -36,6 +36,9 @@
   * [Properties](#properties-7)
   * [Events](#events-6)
 - [TaskDetailsModel](#taskdetailsmodel)
+- [Task People Component](#task-people-component)
+  * [Properties](#properties-8)
+    + [Events](#events-7)
 - [Build from sources](#build-from-sources)
 - [NPM scripts](#npm-scripts)
 - [Demo](#demo)

ng2-components/ng2-alfresco-core/README.md

@@ -17,6 +17,7 @@
   * [Styling](#styling)
 - [Alfresco Api Service](#alfresco-api-service)
 - [AppConfigService](#appconfigservice)
+  * [Different configurations based on environment settings](#different-configurations-based-on-environment-settings)
 - [Notification Service](#notification-service)
 - [Context Menu directive](#context-menu-directive)
 - [Accordion Component](#accordion-component)

ng2-components/package-base.json

@@ -9,7 +9,8 @@
         "pkg-build": "package-json-merge ng2-alfresco-core/package.json ng2-alfresco-datatable/package.json ng2-activiti-diagrams/package.json ng2-activiti-analytics/package.json ng2-activiti-form/package.json ng2-activiti-tasklist/package.json ng2-activiti-processlist/package.json ng2-alfresco-documentlist/package.json ng2-alfresco-login/package.json ng2-alfresco-search/package.json ng2-alfresco-tag/package.json ng2-alfresco-upload/package.json ng2-alfresco-viewer/package.json ng2-alfresco-webscript/package.json ng2-alfresco-webscript/package.json ng2-alfresco-userinfo/package.json ng2-alfresco-social/package.json package-base.json  > package.json",
         "test": "node node_modules/karma/bin/karma start --reporters mocha,coverage --single-run --component .",
         "test-browser": "node node_modules/karma/bin/karma start karma.conf.js --reporters kjhtml",
-        "toc": "markdown-toc -i ng2-alfresco-core/README.md && markdown-toc -i ng2-alfresco-datatable/README.md && markdown-toc -i ng2-activiti-diagrams/README.md && markdown-toc -i ng2-activiti-analytics/README.md && markdown-toc -i ng2-activiti-form/README.md && markdown-toc -i ng2-activiti-tasklist/README.md && markdown-toc -i ng2-activiti-processlist/README.md && markdown-toc -i ng2-alfresco-documentlist/README.md && markdown-toc -i ng2-alfresco-login/README.md && markdown-toc -i ng2-alfresco-search/README.md && markdown-toc -i ng2-alfresco-tag/README.md && markdown-toc -i ng2-alfresco-upload/README.md && markdown-toc -i ng2-alfresco-viewer/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-userinfo/README.md && markdown-toc -i ng2-alfresco-social/README.md",
+        "toc": "markdown-toc -i ng2-alfresco-core/README.md && markdown-toc -i ng2-alfresco-datatable/README.md && markdown-toc -i ng2-activiti-diagrams/README.md && markdown-toc -i ng2-activiti-analytics/README.md && markdown-toc -i ng2-activiti-form/README.md && markdown-toc -i ng2-activiti-tasklist/README.md && markdown-toc -i ng2-activiti-processlist/README.md && markdown-toc -i ng2-alfresco-documentlist/README.md && markdown-toc -i ng2-alfresco-login/README.md && markdown-toc -i ng2-alfresco-search/README.md && markdown-toc -i ng2-alfresco-tag/README.md && markdown-toc -i ng2-alfresco-upload/README.md && markdown-toc -i ng2-alfresco-viewer/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-userinfo/README.md && markdown-toc -i ng2-alfresco-social/README.md && markdown-toc -i README.md",
+        "doc": "npm run toc && npm run npm run webpack -- --config config/webpack.doc.js --progress --profile --bail",
         "tslint": "",
         "prepublish": "",
         "tsc": "",

ng2-components/package.json

@@ -12,7 +12,8 @@
     "coverage": "",
     "prepublish": "",
     "pkg-build": "package-json-merge ng2-alfresco-core/package.json ng2-alfresco-datatable/package.json ng2-activiti-diagrams/package.json ng2-activiti-analytics/package.json ng2-activiti-form/package.json ng2-activiti-tasklist/package.json ng2-activiti-processlist/package.json ng2-alfresco-documentlist/package.json ng2-alfresco-login/package.json ng2-alfresco-search/package.json ng2-alfresco-tag/package.json ng2-alfresco-upload/package.json ng2-alfresco-viewer/package.json ng2-alfresco-webscript/package.json ng2-alfresco-webscript/package.json ng2-alfresco-userinfo/package.json ng2-alfresco-social/package.json package-base.json  > package.json",
-    "toc": "markdown-toc -i ng2-alfresco-core/README.md && markdown-toc -i ng2-alfresco-datatable/README.md && markdown-toc -i ng2-activiti-diagrams/README.md && markdown-toc -i ng2-activiti-analytics/README.md && markdown-toc -i ng2-activiti-form/README.md && markdown-toc -i ng2-activiti-tasklist/README.md && markdown-toc -i ng2-activiti-processlist/README.md && markdown-toc -i ng2-alfresco-documentlist/README.md && markdown-toc -i ng2-alfresco-login/README.md && markdown-toc -i ng2-alfresco-search/README.md && markdown-toc -i ng2-alfresco-tag/README.md && markdown-toc -i ng2-alfresco-upload/README.md && markdown-toc -i ng2-alfresco-viewer/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-userinfo/README.md && markdown-toc -i ng2-alfresco-social/README.md",
+    "toc": "markdown-toc -i ng2-alfresco-core/README.md && markdown-toc -i ng2-alfresco-datatable/README.md && markdown-toc -i ng2-activiti-diagrams/README.md && markdown-toc -i ng2-activiti-analytics/README.md && markdown-toc -i ng2-activiti-form/README.md && markdown-toc -i ng2-activiti-tasklist/README.md && markdown-toc -i ng2-activiti-processlist/README.md && markdown-toc -i ng2-alfresco-documentlist/README.md && markdown-toc -i ng2-alfresco-login/README.md && markdown-toc -i ng2-alfresco-search/README.md && markdown-toc -i ng2-alfresco-tag/README.md && markdown-toc -i ng2-alfresco-upload/README.md && markdown-toc -i ng2-alfresco-viewer/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-userinfo/README.md && markdown-toc -i ng2-alfresco-social/README.md && markdown-toc -i README.md",
+    "doc": "npm run toc && npm run webpack -- --config config/webpack.doc.js --progress --profile --bail",
     "tslint": "",
     "tsc": "",
     "pretest": "",