Simplify script type lookup

Author: acdvs

lib/rules/entry-points.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const { getScriptType } = require('../util/metadata');
-const { scriptTypeMap, scriptTypes } = require('../util/scriptTypes');
 
 module.exports = {
   meta: {
@@ -16,9 +15,7 @@ module.exports = {
       let hasValidEntryPoint = false;
       let scriptType = getScriptType(context);
 
-      scriptType = scriptType && scriptType.value;
-
-      if (!scriptType || !scriptTypes.includes(scriptType)) {
+      if (!scriptType.value || !scriptType.def) {
         return;
       }
 
@@ -37,7 +34,7 @@ module.exports = {
       if (returnArgument && returnArgument.type === 'ObjectExpression') {
         for (const property of returnArgument.properties) {
           if (
-            scriptTypeMap[scriptType].entryPoints.includes(property.key.name) &&
+            scriptType.def.entryPoints.includes(property.key.name) &&
             (property.value.type === 'Identifier' ||
               property.value.type === 'FunctionExpression')
           ) {
@@ -53,17 +50,15 @@ module.exports = {
             n.type === 'ExpressionStatement' &&
             n.expression.left.type === 'MemberExpression' &&
             n.expression.left.object.name === returnArgument.name &&
-            scriptTypeMap[scriptType].entryPoints.includes(
-              n.expression.left.property.name
-            )
+            scriptType.def.entryPoints.includes(n.expression.left.property.name)
         );
 
         if (returnAssignments.length > 0) {
           hasValidEntryPoint = true;
         }
       }
 
-      if (scriptTypeMap[scriptType].entryPoints.length === 0) {
+      if (scriptType.def.entryPoints.length === 0) {
         hasValidEntryPoint = true;
       }
 
@@ -72,7 +67,7 @@ module.exports = {
           node: returnStatement || callback,
           messageId: 'returnEntryPoint',
           data: {
-            type: scriptType,
+            type: scriptType.value,
           },
         });
       }

lib/rules/script-type.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const { getScriptType } = require('../util/metadata');
-const { scriptTypes } = require('../util/scriptTypes');
 
 module.exports = {
   meta: {
@@ -23,7 +22,7 @@ module.exports = {
           messageId: 'noValue',
           loc: scriptType.locs.tag,
         });
-      } else if (scriptType.locs.value && !scriptTypes.includes(scriptType.value)) {
+      } else if (scriptType.locs.value && !scriptType.def) {
         context.report({
           messageId: 'invalidValue',
           data: {

lib/util/metadata.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const { getScriptTypeDef } = require('./scriptTypes');
+
 const SCRIPT_TAG = '@NScriptType';
 const SCRIPT_TAG_REGEX = /@NScriptType(?: (\S+))?/;
 
@@ -25,7 +27,8 @@ function getScriptType(context) {
   const typeIndex = tagIndex + SCRIPT_TAG.length + 1;
 
   return {
-    value: scriptType.toLowerCase(),
+    value: scriptType,
+    def: getScriptTypeDef(scriptType),
     locs: {
       tag: {
         start: sourceCode.getLocFromIndex(tagIndex),

lib/util/scriptTypes.js

@@ -1,13 +1,15 @@
 'use strict';
 
-const scriptTypeMap = {
-  BankConnectivityPlugin: {
+const scriptTypes = [
+  {
+    name: 'BankConnectivityPlugin',
     entryPoints: [
       'getRequiredConfigurationFields',
       'downloadPreviousDayBankStatementFile',
     ],
   },
-  BundleInstallationScript: {
+  {
+    name: 'BundleInstallationScript',
     entryPoints: [
       'afterInstall',
       'afterUpdate',
@@ -16,7 +18,8 @@ const scriptTypeMap = {
       'beforeUpdate',
     ],
   },
-  ClientScript: {
+  {
+    name: 'ClientScript',
     entryPoints: [
       'fieldChanged',
       'lineInit',
@@ -32,63 +35,57 @@ const scriptTypeMap = {
       'localizationContextExit',
     ],
   },
-  CustomGLPlugin: {
-    entryPoitns: ['customizeGlImpact'],
-  },
-  DatasetBuilderPlugin: {
-    entryPoints: ['createDataset'],
-  },
-  FiConnectivityPlugin: {
+  { name: 'CustomGLPlugin', entryPoints: ['customizeGlImpact'] },
+  { name: 'DatasetBuilderPlugin', entryPoints: ['createDataset'] },
+  {
+    name: 'FiConnectivityPlugin',
     entryPoints: ['getConfigurationIFrameUrl', 'getAccounts', 'getTransactionData'],
   },
-  FiParserPlugin: {
+  {
+    name: 'FiParserPlugin',
     entryPoints: [
       'parseData',
       'getStandardTransactionCodes',
       'getExpenseCodes',
       'getConfigurationPageUrl',
     ],
   },
-  MapReduceScript: {
+  {
+    name: 'MapReduceScript',
     entryPoints: ['getInputData', 'map', 'reduce', 'summarize'],
   },
-  MassUpdateScript: {
-    entryPoints: ['each'],
-  },
-  PluginTypeImpl: {
-    entryPoints: [],
-  },
-  Portlet: {
-    entryPoints: ['render'],
-  },
-  Restlet: {
-    entryPoints: ['delete', 'get', 'post', 'put'],
-  },
-  ScheduledScript: {
-    entryPoints: ['execute'],
-  },
-  SDFInstallationScript: {
-    entryPoints: ['run'],
-  },
-  Suitelet: {
+  { name: 'MassUpdateScript', entryPoints: ['each'] },
+  { name: 'PluginTypeImpl', entryPoints: [] },
+  { name: 'Portlet', entryPoints: ['render'] },
+  { name: 'Restlet', entryPoints: ['delete', 'get', 'post', 'put'] },
+  { name: 'ScheduledScript', entryPoints: ['execute'] },
+  { name: 'SDFInstallationScript', entryPoints: ['run'] },
+  {
+    name: 'Suitelet',
     entryPoints: ['onRequest'],
   },
-  UserEventScript: {
+  {
+    name: 'UserEventScript',
     entryPoints: ['afterSubmit', 'beforeLoad', 'beforeSubmit'],
   },
-  WorkbookBbuilderPlugin: {
+  {
+    name: 'WorkbookBbuilderPlugin',
     entryPoints: ['createWorkbook'],
   },
-  WorkflowActionScript: {
+  {
+    name: 'WorkflowActionScript',
     entryPoints: ['onAction'],
   },
-};
+];
 
-const scriptTypes = Object.keys(scriptTypeMap).map(function (x) {
-  return x.toLowerCase();
-});
+function getScriptTypeDef(scriptType) {
+  return (
+    !!scriptType &&
+    scriptTypes.find((x) => x.name.toLowerCase() === scriptType.toLowerCase())
+  );
+}
 
 module.exports = {
-  scriptTypeMap,
   scriptTypes,
+  getScriptTypeDef,
 };