Chore: Copy formatter files from eslint-plugin-episerver-cms

The tests/fixtures/output.* files are the formatted versions of the
results from the same source as the tests/fixtures/input.json so they
will serve as regression tests initially.

Author: seriema

docs/README.md

@@ -0,0 +1,99 @@
+# Formatters
+
+There are several formatters and they can be used with the `-f` flag when calling ESLint. They reside in `./node_modules/eslint-plugin-episerver-cms/formatters/`.
+
+## Summary format
+
+Usage:
+
+```
+$ eslint . -f ./node_modules/eslint-plugin-episerver-cms/formatters/summary.js
+```
+
+Result:
+
+![formatter:summary output](summary.png)
+
+
+## Table format
+
+Used by the `summary` formatter.
+
+Usage:
+
+```
+$ eslint . -f ./node_modules/eslint-plugin-episerver-cms/formatters/table.js
+```
+
+
+## CSV format
+
+This is the preferred format if you want to send us your usage. Outputed file can be commited to track progress in lowering usage of internal and deprecated API's.
+
+Usage:
+
+```
+# Output to console
+$ eslint . -f ./node_modules/eslint-plugin-episerver-cms/formatters/csv.js
+
+# Output to file
+$ eslint . -f ./node_modules/eslint-plugin-episerver-cms/formatters/csv.js -o epi-module-usage.csv
+```
+
+Result:
+
+```csv
+Rule,Module name,Usage count
+no-deprecated-episerver-apis,epi/shell/widget/_ActionProviderWidget,3
+no-deprecated-episerver-apis,epi-cms/store/CustomQueryEngine,2
+no-internal-episerver-apis,epi-cms/contentediting/NotificationBar,8
+no-internal-episerver-apis,epi/shell/widget/_ModelBindingMixin,8
+```
+
+
+## JSON format
+
+Outputed file can be commited to track progress in lowering usage of internal and deprecated API's.
+
+Usage:
+
+```
+# Output to console
+$ eslint . -f ./node_modules/eslint-plugin-episerver-cms/formatters/json.js
+
+# Output to file
+$ eslint . -f ./node_modules/eslint-plugin-episerver-cms/formatters/json.js -o epi-module-usage.json
+```
+
+Result:
+
+```json
+[
+    {
+        "rule": "no-deprecated-episerver-apis",
+        "violations": [
+            {
+                "module": "epi/shell/widget/_ActionProviderWidget",
+                "usages": 3
+            },
+            {
+                "module": "epi-cms/store/CustomQueryEngine",
+                "usages": 2
+            }
+        ]
+    },
+    {
+        "rule": "no-internal-episerver-apis",
+        "violations": [
+            {
+                "module": "epi-cms/contentediting/NotificationBar",
+                "usages": 8
+            },
+            {
+                "module": "epi/shell/widget/_ModelBindingMixin",
+                "usages": 17
+            },
+        ]
+    }
+]
+```

docs/summary.png

@@ -0,0 +1,21 @@
+const normalizer = require("./normalized");
+
+/* FORMAT (ordered by module name):
+    Rule,Module name,Usage count
+    no-deprecated-episerver-apis,epi/shell/widget/_ActionProviderWidget,3
+    no-deprecated-episerver-apis,epi-cms/store/CustomQueryEngine,2
+    no-internal-episerver-apis,epi-cms/contentediting/NotificationBar,8
+    no-internal-episerver-apis,epi/shell/widget/_ModelBindingMixin,17
+*/
+
+module.exports = function (results) {
+    return normalizer(results)
+        .reduce((results, summary) => {
+            return results.concat(
+                summary.violations.map(violation => {
+                    return `${summary.rule},${violation.module},${violation.usages}`;
+                })
+            )
+        }, ["Rule,Module name,Usage count"])
+        .join("\n");
+};

lib/csv.js

@@ -0,0 +1,32 @@
+const normalizer = require("./normalized");
+
+/* FORMAT (pretty printed version of 'normalized'):
+    [
+        {
+            "rule": "no-deprecated-episerver-apis",
+            "violations": [
+                {
+                    "module": "epi/shell/widget/_ActionProviderWidget",
+                    "usages": 3
+                },
+                {
+                    "module": "epi-cms/store/CustomQueryEngine",
+                    "usages": 2
+                }
+            ]
+        },
+        {
+            "rule": "no-internal-episerver-apis",
+            "violations": [
+                {
+                    "module": "epi/shell/widget/dialog/_DialogContentMixin":,
+                    "usages": 5
+                }
+            ]
+        }
+    ]
+*/
+
+module.exports = function (results) {
+    return JSON.stringify(normalizer(results), null, 4);
+};

lib/eslint-json-parser.js

@@ -0,0 +1,88 @@
+module.exports = function (results) {
+
+/* FORMAT (A sorted array, with nested elements for rule violations that are sorted by module name for minimal git diffs when commiting the csv or json results):
+    [
+        {
+            rule: "no-deprecated-episerver-apis",
+            violations: [
+                {
+                    module: "epi-cms/store/CustomQueryEngine",
+                    usages: 2
+                },
+                {
+                    module: "epi/shell/widget/_ActionProviderWidget",
+                    usages: 3
+                }
+            ]
+        },
+        {
+            rule: "no-internal-episerver-apis",
+            violations: [
+                {
+                    module: "epi/shell/widget/dialog/_DialogContentMixin":,
+                    usages: 5
+                }
+            ]
+        }
+    ]
+*/
+
+    const hasMessages = result => result.messages.length;
+
+    const epiRulePlugin = "episerver-cms/";
+    const ruleNameFromMessage = msg => msg.ruleId.replace(epiRulePlugin, "");
+
+    const isEpiMessage = message => message.ruleId && message.ruleId.startsWith(epiRulePlugin);
+    const areEpiMessages = result => result.messages.filter(isEpiMessage);
+
+    const moduleNameFromMessage = msg => msg.message
+        .replace(/'/g, "")
+        .replace(" is an internal Episerver module and can have a breaking change in any release.", "")
+        .replace(" is a deprecated Episerver module and will be removed in a future major version.", "");
+
+    const countModules = (seq, current) => {
+        current.messages
+            .filter(isEpiMessage) // `areEpiMessages` doesn't seem to work. It includes linting errors from this file, which is strange.
+            .forEach(msg => {
+                const module = moduleNameFromMessage(msg);
+                const rule = ruleNameFromMessage(msg);
+
+                if (!seq[rule]) { seq[rule] = {}; }
+
+                if (!seq[rule][module]) { seq[rule][module] = 0; }
+
+                seq[rule][module]++;
+            });
+
+        return seq;
+    };
+
+    // This holds an object with module name and usage count as key and value.
+    const hashmap = results
+        .filter(hasMessages)
+        .filter(areEpiMessages) // TODO: Why doesn't this work?
+        .reduce(countModules, {
+            // empty object to start with, to use as a simple hash map
+        });
+
+
+    return Object
+        .keys(hashmap)
+        .sort() // Sort on rule name, which are the keys
+        .map(rule => {
+            const violations = hashmap[rule];
+
+            return {
+                rule,
+                violations: Object
+                    .keys(violations)
+                    .sort() // First sort on module name, which are the keys
+                    .map(name => {
+                        return {
+                            module: name,
+                            usages: violations[name]
+                        };
+                    })
+                };
+        });
+};

lib/json.js

@@ -0,0 +1,5 @@
+const defaultFormatter = require("./table");
+
+module.exports = function (results) {
+    return defaultFormatter(results);
+}