Merge branch 'snovoselski/update-data-analytics-sample-extras-15' of https://github.com/IgniteUI/igniteui-angular-samples into snovoselski/update-data-analytics-sample-extras-15

Author: zdrawku

.github/workflows/build-app-crm.yml

@@ -34,10 +34,10 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
             node-version: ${{ matrix.node-version }}
             cache: 'npm'

.github/workflows/build-app-lob.yml

@@ -39,10 +39,10 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
             node-version: ${{ matrix.node-version }}
             cache: 'npm'

.hooks/prepare-commit-msg

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+'use strict';
+
+var validate = require('./scripts/validate'),
+    fs = require('fs');
+
+var options = {
+    style: "default"
+};
+
+var text = fs.readFileSync(process.argv[2]).toString();
+
+var errors = [];
+errors = validate(text, options, errors);
+
+if (errors.length > 0) {
+    process.stdout.write(errors[0].toString());
+    process.exitCode = 1;
+}

.hooks/scripts/common.js

@@ -0,0 +1,44 @@
+'use strict';
+
+module.exports = {
+    matchType: (types, line) => {
+        return types.some(function(type) {
+            if (line.startsWith(type)) {
+                return true;
+            }
+
+            return false;
+        });
+    },
+
+    errorFactory: (prefix, message, additionalParams) => {
+        var result = '';
+        if (prefix) {
+            result = prefix;
+        }
+
+        result += message;
+
+        if (additionalParams) {
+            result += additionalParams;
+        }
+        
+        return result;
+    },
+
+    errorMessages: {
+        MESSAGE_SHOULD_START_WITH_TYPE: 'Message should start with one of the following types:\n',
+        NEED_OPENING_PARENTHESIS: 'Need an opening parenthesis right after the type: (',
+        TYPE_WAS_EMPTY: '<type> was empty, it must be one of these: \n',
+        TYPE_WAS_INVALID: '<type> was invalid, It has to be one of these:\n',
+        NEED_CLOSING_PARENTHESIS: 'Need a closing parenthesis after scope declaration: <scope>")"',
+        SCOPE_WAS_EMPTY: "<scope> cannot be empty!",
+        NEED_A_COLON: "Need a colon after the closing parenthesis: ):",
+        NEED_SPACE_AND_SUBJECT: 'Need a space and <subject> after colon: ": <subject>"',
+        SUBJECT_WAS_EMPTY: '<subject> must not be empty',
+        WRONG_REVERT_STRUCT: 'If this is a revert of a previous commit, please write:\n',
+        UNDEFINED_OF_COMMIT_MSG: 'Commit message is undefined, abort with error',
+        MSG_IS_NOT_A_STRING: 'Commit message is not a string, abort with error',
+        MSG_IS_EMPTY: 'Commit message is empty, abort with error'
+    }
+}

.hooks/scripts/templateValidators/default-style-validator.js

@@ -0,0 +1,75 @@
+'use strict';
+
+var matchType = require('../common').matchType,
+    errorFactory = require('../common').errorFactory,
+    errMessages = require('../common').errorMessages;
+
+module.exports = (lines, options, errors) => {
+    var scheme = '<type>(<scope>): <subject> <#issue|optional>';
+    var prefix = `First line must be ${scheme}\n`;
+
+    var line = lines[0];
+    if (line.startsWith('revert: ')) {
+        line = line.replace(/^revert: /, '');
+        prefix = `First line must be revert: ${scheme}\n`;
+    } else if (line.startsWith('revert')) {
+        errors.push(errorFactory(errMessages.WRONG_REVERT_STRUCT, 'revert: ' + scheme));
+        
+        return;
+    }
+
+    if (!matchType(options.types, line)) {
+        errors.push(errorFactory(prefix, errMessages.MESSAGE_SHOULD_START_WITH_TYPE, options.types.join(', ')));
+        
+        return;
+    }
+
+    if (line.indexOf('(') === -1) {
+        errors.push(errorFactory(prefix, errMessages.NEED_OPENING_PARENTHESIS));
+
+        return;
+    }
+
+    var type = line.replace(/\(.*/, '');
+    if (options.types.indexOf(type) === -1) {
+        errors.push(errorFactory(prefix, errMessages.TYPE_WAS_INVALID, options.types.join(', ')));
+
+        return;
+    }
+
+    if (line.indexOf(')') === -1) {
+        errors.push(errorFactory(prefix, errMessages.NEED_CLOSING_PARENTHESIS));
+
+        return;
+    }
+
+    var scope = line.slice(line.indexOf('(') + 1, line.indexOf(')'));
+    if (scope.length === 0) {
+        errors.push(errorFactory(prefix, errMessages.SCOPE_WAS_EMPTY));
+    }
+    
+    if (line.indexOf(type + '(' + scope + '):') === - 1) {
+        errors.push(errorFactory(prefix, errMessages.NEED_A_COLON));
+        
+        return;
+    }
+
+    var subject = line.split(':')[1];
+    if (subject === "" || !subject.startsWith(' ')) {
+        errors.push(errorFactory(prefix, errMessages.NEED_SPACE_AND_SUBJECT));
+        
+        return;
+    }
+
+    subject = subject.trim();
+
+    if (subject.length === 0) {
+        errors.push(errorFactory(errMessages.SUBJECT_WAS_EMPTY));
+        
+        return;
+    }
+
+    if (subject.length < options.subjectLimits) {
+        errors.push(`<subject> should contains at least ${options.subjectLimits} characters`);
+    }
+}

.hooks/scripts/templates/default.js

@@ -0,0 +1,23 @@
+'use strict';
+
+var path = require('path');
+
+var defaults = {
+    default: {
+        style: 'default',
+        subjectLimits: 15,
+        lineLimits: {
+            firstLine: 80,
+            otherLine: 80,
+        },
+        issuePattern: '(#)[0-9]+',
+        typesWithMandatoryIssue: [],
+        guidelinesUrl: 'https://bit.ly/angular-guidelines',
+        types: [
+            'feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'chore', 'build', 'ci', 'revert'
+        ],
+    },
+    oldMessagePath: path.join('.git', 'COMMIT_EDITMSG_OLD')
+}
+
+module.exports = defaults;

.hooks/scripts/utils/issue-validator.js

@@ -0,0 +1,33 @@
+'use strict';
+
+var matchType = require('../common').matchType,
+    errorFactory = require('../common').errorFactory;
+
+module.exports = (lines, options, errors) => {
+    var ticket = new RegExp(options.issuePattern);
+    var whetherIssueIsMandatory = false,
+        wheterMatchAnyIssueRef = false;
+
+
+    if (matchType(options.typesWithMandatoryIssue, lines[0])) {
+        whetherIssueIsMandatory = true;
+    }
+
+    lines.forEach((line) => {
+        line = line.trim();
+        if (line === "") {
+            return;
+        }
+
+        if (ticket.test(line)) {
+            wheterMatchAnyIssueRef = true;
+            return;
+        }
+    });
+
+    if (whetherIssueIsMandatory && !wheterMatchAnyIssueRef) {
+        errors.push(errorFactory(
+            `The issue reference for (${options.typesWithMandatoryIssue.join(', ')}) types is mandatory!\n`,
+            "Please add at least one related issue. E.g: Closes #31, Closes #45"));
+    }
+}

.hooks/scripts/utils/line-limits.js

@@ -0,0 +1,22 @@
+'use strict';
+
+module.exports = (lines, options, errors) => {
+    var limits = options.lineLimits;
+    lines.forEach((line, index) => {
+        line = line.trim();
+        if (index === 0) {
+            if (line.length === 0) {
+                errors.push('First line of commit message must not be empty!');
+            } else if (line.length > limits.firstLine) {
+                errors.push(`First line of commit message must be no logner than ${limits.firstLine} characters!`);
+            }
+        } else if (index === 1 && line.length > 0) {
+            errors.push('Second line must be always empty!');
+        } else if (line.length > limits.otherLine) {
+            errors.push(
+                `Commit message line ${index + 1} is too long: ${line.length}, only ${limits.otherLine} are allowed.
+                The line is: ${line.substring(0, 20)} [...]!`
+            );
+        }
+    });
+}

.hooks/scripts/validate.js

@@ -0,0 +1,59 @@
+'use strict';
+
+var defaultTemp = require('./templates/default'),
+    commitValidator = require('./templateValidators/default-style-validator'),
+    lineLimits = require('./utils/line-limits'),
+    issuesValidator = require('./utils/issue-validator'),
+    semver = require('semver'),
+    errMessages = require('./common').errorMessages,
+    errorFactory = require('./common').errorFactory;
+  
+module.exports = (message, options, errors) => {
+    message = message.trim();
+    if (message === undefined) {
+        errors.push(errMessages.UNDEFINED_OF_COMMIT_MSG);
+    } else if (!(typeof message === 'string' || message instanceof String)) {
+        errors.push(errMessages.MSG_IS_NOT_A_STRING);
+    } else if (message.length === 0) {
+        errors.push(errMessages.MSG_IS_EMPTY);
+    }
+  
+    var lines = message.split('\n');
+    if (semver.valid(lines[0])) {
+        return [];
+    }
+  
+    if(lines[0].toLocaleLowerCase().startsWith("merge")) {
+        return [];
+    }
+
+    // Get the default template if the style property matches
+    if (defaultTemp[options.style]) {
+        options = defaultTemp[options.style];
+    }
+
+    // Get the lineLimits options from the default 
+    // if the template is custom and there is no lineLimits declared.
+    if (!options.lineLimits) {
+        options.lineLimits = defaultTemp["default"].lineLimits;
+    }
+
+    if (!options.lineLimits.firstLine) {
+        options.lineLimits.firstLine = defaultTemp["default"].lineLimits.firstLine;
+    }
+
+    if (!options.lineLimits.otherLine) {
+        options.lineLimits.otherLine = defaultTemp["default"].lineLimits.otherLine;
+    }
+
+    if(!options.type) {
+        options.types = defaultTemp["default"].types;
+    }
+
+    lineLimits(lines, options, errors);
+    commitValidator(lines, options, errors);
+    issuesValidator(lines, options, errors);
+  
+    return errors;
+}
+  

README.html

@@ -13,7 +13,7 @@
     <article>
       <h1>Thank you for downloading
         <br>Ignite UI for Angular</h1>
-      <p>In the package you just downloaded, you get a complete set of samples, including source code for each of them. You’ll
+      <p>In the package you just downloaded, you get a complete set of samples, including source code for each of them. You'll
         see the full array of capabilities in Ignite UI for Angular, all the different features for the controls, how they
         are implemented.
       </p>
@@ -43,7 +43,7 @@ <h2>Prerequisites to using Ignite UI for Angular</h2>
         app, including Ignite UI for Angular, and to build Ignite UI for Angular apps.
         <br>
         <br>To get started, you must install both NodeJS and Visual Studio Code on your machine. Modern web development with
-        Angular requires NodeJS, it’s sort of like an ASP.NET app running in the browser requires ASP.NET runtime deployed
+        Angular requires NodeJS, it's sort of like an ASP.NET app running in the browser requires ASP.NET runtime deployed
         on the server. For development, there is nothing better than Visual Studio Code to build Angular apps. Getting started
         is easy, just download and install both Node.js and Visual Studio Code.</p>
       <div class="callouts">
@@ -69,7 +69,7 @@ <h2>Running the Ignite UI for Angular Samples</h2>
       <h3>Step-by-Step</h3>
       <ol>
         <li>Unzip the package to your hard drive. </li>
-        <li>Open the project by right-clicking anywhere in the folder that you’ve just unzipped and selecting “Open with Code”
+        <li>Open the project by right-clicking anywhere in the folder that you've just unzipped and selecting “Open with Code”
           from the context menu. If you do not have a right-click option to Open in Code, or you are running a Mac, simply
           open Visual Studio Code and from the File menu select Open Folder and select the folder you just unzipped. </li>
         <li>Once Visual Studio Code is open, you should see the samples folders in the Explorer pane. </li>
@@ -85,13 +85,13 @@ <h3>Step-by-Step</h3>
   <section class="cli">
     <article>
       <h2>Building your first Ignite UI for Angular app</h2>
-      <p>After you’ve looked at the Ignite UI for Angular samples and explored the online docs, it’s time to get started building
-        your first Ignite UI for Angular app. Using the Ignite UI for Angular CLI (Command Line Interface), it’s super-easy
+      <p>After you've looked at the Ignite UI for Angular samples and explored the online docs, it's time to get started building
+        your first Ignite UI for Angular app. Using the Ignite UI for Angular CLI (Command Line Interface), it's super-easy
         to get started building full-featured Angular apps. Our CLI gives you the ability to initialize, develop, scaffold,
         and maintain applications in Angular with Ignite UI, all with pre-set navigation, templates for each control and
         full screen views that can help you kick off any type of Angular app development.
         <br>
-        <br>We’ve included 2 videos that will help you install the pre-requisites and walk you through using the Ignite UI for
+        <br>We've included 2 videos that will help you install the pre-requisites and walk you through using the Ignite UI for
         Angular CLI to build your first Ignite UI for Angular app.</p>
       <div class="callouts">
         <div class="callout">
@@ -137,4 +137,4 @@ <h2>Building your first Ignite UI for Angular app</h2>
   </footer>
 </body>
 
-</html>
+</html>