Make script type case insensitive, improve naming

Author: acdvs

lib/rules/entry-points.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const metadataUtil = require('../util/metadata');
-const scriptTypeMap = require('../util/scriptTypes');
+const { getScriptType } = require('../util/metadata');
+const { scriptTypes } = require('../util/scriptTypes');
 
 module.exports = {
   meta: {
@@ -15,8 +15,7 @@ module.exports = {
     return {
       'CallExpression[callee.name=define]': function (node) {
         let hasValidEntryPoint = false;
-        let scriptType = metadataUtil.getScriptType(context);
-        const scriptTypes = Object.keys(scriptTypeMap);
+        let scriptType = getScriptType(context);
 
         scriptType = scriptType && scriptType.value;
 

lib/rules/script-type.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const metadataUtil = require('../util/metadata');
-const scriptTypeMap = require('../util/scriptTypes');
+const { getScriptType } = require('../util/metadata');
+const { scriptTypes } = require('../util/scriptTypes');
 
 module.exports = {
   meta: {
@@ -15,8 +15,7 @@ module.exports = {
   create: function (context) {
     return {
       Program: function () {
-        const scriptType = metadataUtil.getScriptType(context);
-        const scriptTypes = Object.keys(scriptTypeMap);
+        const scriptType = getScriptType(context);
 
         if (!scriptType) return;
 

lib/util/metadata.js

@@ -25,7 +25,7 @@ function getScriptType(context) {
   const typeIndex = tagIndex + SCRIPT_TAG.length + 1;
 
   return {
-    value: scriptType,
+    value: scriptType.toLowerCase(),
     locs: {
       tag: {
         start: sourceCode.getLocFromIndex(tagIndex),

lib/util/scriptTypes.js

@@ -1,6 +1,12 @@
 'use strict';
 
-module.exports = {
+const scriptTypeMap = {
+  BankConnectivityPlugin: {
+    entryPoints: [
+      'getRequiredConfigurationFields',
+      'downloadPreviousDayBankStatementFile',
+    ],
+  },
   BundleInstallationScript: {
     entryPoints: [
       'afterInstall',
@@ -26,12 +32,29 @@ module.exports = {
       'localizationContextExit',
     ],
   },
+  DatasetBuilderPlugin: {
+    entryPoints: ['createDataset'],
+  },
+  FiConnectivityPlugin: {
+    entryPoints: ['getConfigurationIFrameUrl', 'getAccounts', 'getTransactionData'],
+  },
+  FiParserPlugin: {
+    entryPoints: [
+      'parseData',
+      'getStandardTransactionCodes',
+      'getExpenseCodes',
+      'getConfigurationPageUrl',
+    ],
+  },
   MapReduceScript: {
     entryPoints: ['getInputData', 'map', 'reduce', 'summarize'],
   },
   MassUpdateScript: {
     entryPoints: ['each'],
   },
+  PluginTypeImpl: {
+    entryPoints: [],
+  },
   Portlet: {
     entryPoints: ['render'],
   },
@@ -50,33 +73,19 @@ module.exports = {
   UserEventScript: {
     entryPoints: ['afterSubmit', 'beforeLoad', 'beforeSubmit'],
   },
-  WorkflowActionScript: {
-    entryPoints: ['onAction'],
-  },
-  bankConnectivityPlugin: {
-    entryPoints: [
-      'getRequiredConfigurationFields',
-      'downloadPreviousDayBankStatementFile',
-    ],
-  },
-  datasetbuilderplugin: {
-    entryPoints: ['createDataset'],
-  },
-  fiConnectivityPlugin: {
-    entryPoints: ['getConfigurationIFrameUrl', 'getAccounts', 'getTransactionData'],
-  },
-  fiParserPlugin: {
-    entryPoints: [
-      'parseData',
-      'getStandardTransactionCodes',
-      'getExpenseCodes',
-      'getConfigurationPageUrl',
-    ],
-  },
-  workbookbuilderplugin: {
+  WorkbookBbuilderPlugin: {
     entryPoints: ['createWorkbook'],
   },
-  plugintypeimpl: {
-    entryPoints: [],
+  WorkflowActionScript: {
+    entryPoints: ['onAction'],
   },
 };
+
+const scriptTypes = Object.keys(scriptTypeMap).map(function (x) {
+  return x.toLowerCase();
+});
+
+module.exports = {
+  scriptTypeMap,
+  scriptTypes,
+};

scripts/generate_docs.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const { MODULE_NAMES } = require('./../lib/util/modules');
-const SCRIPT_TYPES = require('./../lib/util/scriptTypes');
+const { scriptTypeMap } = require('./../lib/util/scriptTypes');
 
 const SRC_DIR = './docs/src';
 const OUT_DIR = './docs/rules';
@@ -10,7 +10,7 @@ const SCRIPT_NAME = path.basename(__filename);
 const docsToModify = {
   'entry-points.md': {
     old: '<ENTRY_POINTS>',
-    new: Object.entries(SCRIPT_TYPES).reduce((str, [scriptType, st]) => {
+    new: Object.entries(scriptTypeMap).reduce((str, [scriptType, st]) => {
       str += `- ${scriptType}\n`;
       st.entryPoints.forEach((ep) => (str += `  - ${ep}\n`));
       return str;
@@ -25,7 +25,7 @@ const docsToModify = {
   },
   'script-type.md': {
     old: '<SCRIPT_TYPES>',
-    new: Object.keys(SCRIPT_TYPES).reduce((str, x) => {
+    new: Object.keys(scriptTypeMap).reduce((str, x) => {
       str += `- ${x}\n`;
       return str;
     }, ''),

tests/rules/script-type.js

@@ -20,13 +20,27 @@ ruleTester.run('script-type', rule, {
     },
     {
       code: `
+/**
+ * @NScriptType bundleinstallationscript
+ */
+      `,
+    },
+    {
+      code: `
 /**
  * @NScriptType ClientScript
  */
       `,
     },
     {
       code: `
+/**
+ * @NScriptType FiParserPlugin
+ */
+      `,
+    },
+    {
+      code: `
 /**
  * @NScriptType MapReduceScript
  */
@@ -108,13 +122,6 @@ ruleTester.run('script-type', rule, {
     {
       code: '// @NScriptType SuiteletScript',
     },
-    {
-      code: `
-/**
- * @NScriptType fiParserPlugin
- */
-      `,
-    },
   ],
 
   invalid: [