@zohodesk/codestandard-validator 0.0.7-exp-3 → 0.0.7-exp-5

package/configuration/services/GC_Chat/rule_configuration/i18nRules/i18nRules.js

@@ -0,0 +1,284 @@
+let noHardcodingRuleExcludes = {
+  objectKeys: [
+    'dataId',
+    'data-id',
+    'data-test-id',
+    'size',
+    'iconSize',
+    'iconName',
+    'align',
+    'alignBox',
+    'palette',
+    'scroll',
+    'boxSize',
+    'boxPosition',
+    'type',
+    'moduleName',
+    'apiname',
+    'apiName',
+    'id',
+    'target',
+    'tagName',
+    'module',
+    'folderName',
+    'componentGroup',
+    'hoverType',
+    'tabIndex',
+    'aria-Label',
+    'aria-label',
+    'ariaLabel',
+    'd',
+    'className',
+    'rel',
+    'heading',
+    'column',
+    'row',
+    'transform',
+    'color',
+    'condition',
+    'fieldName',
+    'animationStyle',
+    'textBoxVariant',
+    'searchBoxSize',
+    'src',
+    'display',
+    'href',
+    'width',
+    'height',
+    'enctype',
+    'target',
+    'left',
+    'top',
+    'position',
+    'location',
+    'backgroundColor',
+    'visibility',
+    'cursor',
+    'lineHeight',
+    'border',
+    'readOnly',
+    'textAlign',
+    'scrolling',
+    'class',
+    'padding',
+    'overflow',
+    'textBoxSize',
+    'right',
+    'top',
+    'bottom',
+    'left',
+    'fieldType',
+    'regex',
+    'searchModuleFieldName',
+    'searchConditionValue',
+    'logoName',
+    '_id'
+  ],
+  props: [
+    'dataId',
+    'data-id',
+    'data-test-id',
+    'size',
+    'iconSize',
+    'iconName',
+    'align',
+    'alignBox',
+    'palette',
+    'scroll',
+    'boxSize',
+    'boxPosition',
+    'type',
+    'moduleName',
+    'apiname',
+    'apiName',
+    'id',
+    'target',
+    'tagName',
+    'module',
+    'folderName',
+    'componentGroup',
+    'hoverType',
+    'tabIndex',
+    'aria-Label',
+    'aria-label',
+    'ariaLabel',
+    'd',
+    'className',
+    'rel',
+    'heading',
+    'column',
+    'row',
+    'transform',
+    'color',
+    'condition',
+    'fieldName',
+    'animationStyle',
+    'textBoxVariant',
+    'searchBoxSize',
+    'src',
+    'display',
+    'href',
+    'width',
+    'height',
+    'enctype',
+    'target',
+    'left',
+    'top',
+    'position',
+    'location',
+    'backgroundColor',
+    'visibility',
+    'cursor',
+    'lineHeight',
+    'border',
+    'readOnly',
+    'textAlign',
+    'scrolling',
+    'class',
+    'padding',
+    'overflow',
+    'textBoxSize',
+    'right',
+    'top',
+    'bottom',
+    'left',
+    'fieldType',
+    'logoName',
+    '_id'
+  ],
+  methods: [
+    'findIdex',
+    'findIndex',
+    'includes',
+    'getFieldIndex',
+    'oneOf',
+    'oneOfType',
+    'bind',
+    'getFieldLabel',
+    'addEventListener',
+    'removeEventListener',
+    'replace',
+    'split',
+    'indexOf',
+    'set',
+    'selectn',
+    'getAdditionalProperty',
+    'reject',
+    'sendResponse',
+    'resolve',
+    'mapStateToProps',
+    'setAttribute',
+    'updateError',
+    'concat',
+    'createElement',
+    'getproperty',
+    'addElement',
+    'getElementsByName',
+    'match',
+    'lastIndexOf',
+    'setRequestHeader',
+    'getParameter',
+    'getAttribute',
+    'RegExp',
+    'substring',
+    'equals',
+    'log',
+    'debug',
+    'addClass',
+    'open',
+    'find',
+    'setTimeout',
+    'attachEvent',
+    'addEventListener',
+    'removeAttribute',
+    'parseInt',
+    'replace',
+    'setInterval',
+    'getObj',
+    'detachEvent',
+    'removeEventListener',
+    'css',
+    'animate',
+    'bind',
+    'ajaxNew',
+    'set_cookie',
+    'getElementById',
+    'ajax',
+    'find',
+    'createTextNode',
+    'parents',
+    'removeClass',
+    'toggleClass',
+    'write',
+    'get_cookie',
+    'parseFromString',
+    'Error',
+    'error',
+    'querySelector',
+    'getDeptBasedData',
+    'timeEnd',
+    'time',
+    'deskCustomError'
+  ],
+  allowedTags: ['svg', 'css'],
+  keys: [],
+  commentsToIgnoreHardcodingCheck: ['no i18n', 'NOI18N'],
+  stringsAllowedAsBlockCommentStart: ['ignore i18n start', 'no i18n start'],
+  stringsAllowedAsBlockCommentEnd: ['ignore i18n end', 'no i18n end'],
+  dateFormatPatterns: [
+    'dd/MM/yyyy hh:mm a',
+    'MM/dd/yyyy hh:mm a',
+    'yyyy/MM/dd hh:mm a',
+    'dd/MM/yyyy',
+    'MM/dd/yyyy',
+    'yyyy/MM/dd',
+    'DD MMM YYYY hh:mm A',
+    'DD/MM/YYYY h:mm A',
+    'DDD, DD MMM YYYY HH:mm:ss',
+    'DD MMM YYYY',
+    'hh:mm A'
+  ]
+};
+const [error, , off] = ['error', '', 'off'];
+
+let usegetI18NValueAppropriatelyExcludes = {
+  i18nKeys: noHardcodingRuleExcludes.keys,
+  commentsToIgnoreCheck:
+    noHardcodingRuleExcludes.commentsToIgnoreHardcodingCheck
+};
+
+module.exports.i18nConfiguration = [
+  {
+    files: ['src/**/*.js'],
+    excludedFiles: [
+      'src/actions/*.js',
+      'src/library/*.js',
+      'src/middleware/*.js',
+      'src/reducers/*.js',
+      'src/sdk/*.js',
+      'src/store/*.js',
+      'src/worker/*.js',
+      'src/appUrls.js',
+      'src/efc.js',
+      'src/historyChange.js',
+      'src/index.js',
+      'src/initialBindings.js',
+      'src/initialState.js',
+      'src/renderApp.js',
+      'src/bindStaticInfo.js',
+      'src/**/*.spec.js',
+      'src/**/*.docs.js',
+      'src/**/*.test.js'
+    ],
+    rules: {
+      '@zohodesk/no-hardcoding/no-hardcoding': [
+        error,
+        { ...noHardcodingRuleExcludes }
+      ],
+      '@zohodesk/no-hardcoding/use-getI18NValue-method-appropriately': [
+        error,
+        { ...usegetI18NValueAppropriatelyExcludes }
+      ]
+    }
+  }
+];

package/configuration/services/GC_Chat/rule_configuration/react-performance-rules/reactPerformanceRulesConfig.js

@@ -0,0 +1,26 @@
+const [off, warn, error] = ['off', 'warn', 'error'];
+module.exports.reactPerformanceRulesConfig = [
+  {
+    files: ['src/**/*.js'],
+    excludedFiles: [
+      'src/actions/*.js',
+      'src/middleware/*.js',
+      'src/reducers/*.js',
+      'src/sdk/*.js',
+      'src/store/*.js',
+      'src/appUrls.js',
+      'src/efc.js',
+      'src/historyChange.js',
+      'src/initialBindings.js',
+      'src/initialState.js',
+      'src/renderApp.js',
+      'src/bindStaticInfo.js',
+      'src/**/*.spec.js',
+      'src/**/*.docs.js',
+      'src/**/*.test.js'
+    ],
+    rules: {
+      '@zohodesk/react-performance/no-ref-mapstatetoprops': [error]
+    }
+  }
+];

package/configuration/services/client_platform/.eslintrc.js

@@ -0,0 +1,35 @@
+const {
+  rulesConfig,
+  plugins,
+  extendPlugins,
+} = require("@zohodesk/codestandard-validator"); //no i18n
+const path = require("path");
+
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: extendPlugins,
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: path.resolve(process.cwd(), "tsconfig.json"), // ts config file get from running directory
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 12,
+    sourceType: "module",
+  },
+  plugins: plugins,
+  ignorePatterns: [
+    "node_modules/",
+    "**/__test__/**",
+    "**/__tests__/**",
+    "**/index.js",
+    "**/index.ts",
+    "**/lint.config.js",
+    "**/react-cli.config.js",
+    "**/es/**"
+  ],
+  overrides: rulesConfig,
+};

package/configuration/services/client_platform/index.js

@@ -0,0 +1,16 @@
+
+const { plugins ,  rulesConfig} = require('../../common/index')
+const { architecture_rule_configuration } = require('./rule_configuration/architecture_rules/architectureRuleConfiguration')
+const { clientscript_rule_configuration } = require('./rule_configuration/architecture_rules/clientScriptRuleConfiguration')
+const { errorhandle_rule_configuration } = require('./rule_configuration/architecture_rules/errorHandlerRuleConfiguration')
+const { i18nConfiguration } = require('./rule_configuration/i18n/i18n')
+const { sdk_rule_configuration } = require('./rule_configuration/sdk/sdk')
+const $plugins =  [...require('./pluginVersion'), ...plugins ]
+
+
+
+module.exports = { 
+    rulesConfig : Object.assign([],[...architecture_rule_configuration, ...i18nConfiguration, ...rulesConfig, ...clientscript_rule_configuration,...errorhandle_rule_configuration,...sdk_rule_configuration])   ,
+    plugins: $plugins.map((plugin) =>  plugin?.plugin).filter(item => item !== undefined) ,
+    extendPlugins: $plugins.map((plugin) =>  plugin?.extend).filter(item => item !== undefined) 
+}

package/configuration/services/client_platform/pluginVersion.js

@@ -0,0 +1,12 @@
+module.exports = [
+  {
+    packageName: "@zohodesk/eslint-plugin-no-hardcoding",
+    version: "1.0.6-platform-1",
+    plugin: "@zohodesk/no-hardcoding"
+  },
+  {
+    packageName: "@zohodesk/eslint-plugin-architecturerules",
+    version: "0.0.6-exp-1",
+    plugin: "@zohodesk/architecturerules"
+  }
+];

package/configuration/services/client_platform/rule_configuration/architecture_rules/architectureRuleConfiguration.js

@@ -0,0 +1,172 @@
+const path = require("path");
+const [warn, error, off] = ["warn", "error", "off"];
+const {domains, frameworks, adapters, applications,library } = require('./layerConfiguration')
+
+module.exports.architecture_rule_configuration = [
+  {
+    files: ["src/library/**", "src/platform/**"],
+    rules: {
+     "@zohodesk/architecturerules/import-contract":['error',{ importConfig: { domains,applications,adapters,frameworks, library}}],
+      "@zohodesk/architecturerules/no-comments": [warn,{terms:['TODO','FIX','BUG','OPTIMIZE','HACK','NOTE','REFACTOR','DEPRECATED','WARNING','REVIEW','INFO']}],
+      "max-lines-per-function": [error, 20],
+      "max-lines": [
+        error,
+        { max: 250, skipBlankLines: true, skipComments: true }
+      ],
+      "@zohodesk/architecturerules/no-unused-vars": error,
+      "@zohodesk/architecturerules/no-defaultprops": error,
+      "@zohodesk/architecturerules/define-property-schema": [
+        warn,
+        {
+          variableType: "ArrayExpression",
+          schemaType: "TSTypeAnnotation"
+        }
+      ],
+      "@zohodesk/architecturerules/no-nested-property": error,
+      "@zohodesk/architecturerules/path-alias": error,
+      "@zohodesk/architecturerules/define-contract-schema": warn,
+      "@zohodesk/architecturerules/avoid-deprecated-methods": warn
+    },
+    excludedFiles: [
+      "**/src/library/**/__tests__/**",
+      "**/src/platform/**/__tests__/**",
+      "**/src/library/**/__testcases__/**",
+      "**/src/platform/**/__testcases__/**",
+      "**/src/**/**/http-template/**"
+    ]
+  },
+  {
+    files: ["src/library/**", "src/platform/**"],
+    rules: {
+      "@zohodesk/architecturerules/spinal-case-folder": error,
+      "@zohodesk/architecturerules/pascal-case-file": error
+    },
+    excludedFiles: [
+      "**/src/library/**/__tests__/**",
+      "**/src/platform/**/__tests__/**",
+      "**/src/library/**/__testcases__/**",
+      "**/src/platform/**/__testcases__/**",
+      "**/src/**/**/http-template/**"
+    ]
+  },
+  {
+    files: ['src/{library,platform}/**/usecases/**', 'src/{library,platform}/**/controllers/**', 'src/{library,platform}/**/presenter/**'],
+    rules: {
+      '@zohodesk/architecturerules/return-void': error
+    },
+    excludedFiles: ["**/src/{library,platform}/**/usecases/entities-factory/**"]
+  },
+  {
+    files: ["src/library/**/entities/**", "src/platform/**/entities/**"],
+    rules: {
+      "@zohodesk/architecturerules/no-external-library": [
+        error,
+        {
+          packageTypes: ["npm-dev"],
+          packageJson: require(path.resolve(process.cwd(), "package.json"))
+        }
+      ]
+    }
+  },
+  {
+    files: [
+      "src/**/**/adaptors/controllers/**",
+      "src/**/**/usecases/interactors/**"
+    ],
+    rules: {
+      "@zohodesk/architecturerules/should-implement": [
+        off,
+        {
+          interface: {
+            usecases: path.resolve(
+              process.cwd(),
+              "**",
+              "architecture",
+              "IUsecase.ts"
+            ),
+            controllers: path.resolve(
+              process.cwd(),
+              "**",
+              "architecture",
+              "IController.ts"
+            )
+          }
+        }
+      ]
+    },
+    excludedFiles: [
+      "src/**/adaptors/**/interfaces/**",
+      "src/**/usecases/**/interfaces/**"
+    ]
+  },
+  {
+    files: ["src/**/**/adaptors/**/**"],
+    rules: {
+      "@zohodesk/architecturerules/no-businesslogic": error
+    }
+  },
+  {
+    files: [
+      "src/**/**/Actions.ts",
+      "src/**/**/Constants.ts",
+      "src/**/**/Symbols.ts"
+    ],
+    rules: {
+      "@zohodesk/architecturerules/snake-case-identifier": error,
+      "@zohodesk/architecturerules/type-should-be-constant": error
+    }
+  },
+  {
+    files: ["**/src/library/dot/**"],
+    rules: {
+      "@zohodesk/architecturerules/no-hooks-used": error
+    }
+  },
+  {
+    files: ["**/src/**/**"],
+    rules: {
+      "@zohodesk/architecturerules/method-not-invoke": [
+        error,
+        { methods: ["updateState"] }
+      ]
+    },
+    excludedFiles: ["**/src/**/**/presenter/**"]
+  },
+  {
+    files: ["**/src/**/**"],
+    rules: {
+      "@zohodesk/architecturerules/method-not-invoke": [
+        error,
+        { methods: ["dispatch"] }
+      ]
+    },
+    excludedFiles: ["**/src/**/**/usecase/**", "**/src/**/**/frameworks/**"]
+  },
+  {
+    files: ["**/src/**/**"],
+    rules: {
+      "@zohodesk/architecturerules/method-not-invoke": [
+        error,
+        { methods: ["repository"] }
+      ]
+    },
+    excludedFiles: ["**/src/**/**/usecase/**"]
+  },
+  {
+    files: ["**/src/**/Repository.ts"],
+    rules: {
+      "@zohodesk/architecturerules/avoid-local-state": [
+        error,
+        { methodName: ["useState"] }
+      ]
+    },
+    excludedFiles:["src/library/custom-component/adapters/gateways/repository/Repository.ts",
+                  "src/library/dot/components/action-location/adapters/gateway/Repository.ts"]
+  },
+  {
+    files:["**/src/**/**/frameworks/**"],
+    rules:{
+      "@zohodesk/architecturerules/single-factory":[off,{methodShouldImplement:"create"}]
+    }
+  }
+];

package/configuration/services/client_platform/rule_configuration/architecture_rules/clientScriptRuleConfiguration.js

@@ -0,0 +1,19 @@
+const [warn, error, off] = ["warn", "error", "off"];
+
+module.exports.clientscript_rule_configuration = [
+    {
+      files: ["**/*.js", "**/*.js"],
+      rules: {
+        "@zohodesk/architecturerules/import-restricted":[off],
+        "@zohodesk/architecturerules/method-signature":[error, {
+            handler: 'execute',
+            handlerProperties: [
+              { type: 'ObjectPattern', property: ['event', 'sdk', 'context'] }
+            ]
+          }],
+        "@zohodesk/architecturerules/should-not-block-thread":[off],
+        "@zohodesk/architecturerules/framework-agnostic":[off,{forbiddenImports:null,domGlobals:null}]
+      },
+      excludedFiles: [ ] 
+    }
+]

package/configuration/services/client_platform/rule_configuration/architecture_rules/customFieldRuleConfiguration.js

@@ -0,0 +1,30 @@
+const [warn, error, off] = ["warn", "error", "off"];
+
+module.exports.customfield_rule_configuration = [
+  {
+    files: [
+      "**/*.js"
+    ],
+    rules: {
+        "@zohodesk/architecturerules/framework-agnostic":[off,{forbiddenImports:null,domGlobals:null}],
+        "@zohodesk/architecturerules/method-signature": [
+        error,
+        {
+          handler: "fieldToUIComponentTranslator",
+          handlerProperties: [
+            {
+              type: "ObjectExpression",
+              property: ["field", "record" , "context" ]
+            }
+          ]
+        }
+      ]
+    },
+    excludedFiles: []
+  }
+];
+
+
+/**
+ *  rule no 2 need to enable in deskclientapp
+ */

package/configuration/services/client_platform/rule_configuration/architecture_rules/errorHandlerRuleConfiguration.js

@@ -0,0 +1,34 @@
+const [warn, error, off] = ["warn", "error", "off"];
+
+module.exports.errorhandle_rule_configuration = [
+  {
+    files: [
+      "**/src/**/**/ErrorEventHandlersFactory.ts"
+    ],
+    rules: {
+      "@zohodesk/architecturerules/ensure-event-handler": [
+        error,
+        { eventName: "COMPONENT_ERROR_THROWN" }
+      ],
+      "@zohodesk/architecturerules/method-signature": [
+        error,
+        {
+          handler: "dispatch",
+          handlerProperties: [
+            {
+              type: "ObjectExpression",
+              property: ["type", "payload"],
+              nestedProperties: {
+                payload: {
+                  type: "ObjectExpression",
+                  property: ["code", "message", "errorDetails"]
+                }
+              }
+            }
+          ]
+        }
+      ]
+    },
+    excludedFiles: []
+  }
+];

package/configuration/services/client_platform/rule_configuration/architecture_rules/layerConfiguration.js

@@ -0,0 +1,52 @@
+ module.exports = {
+    domains: {
+      from: /^.*\/src\/.*\/domain/,
+      avoid: [
+        /^.*\/src\/.*\/applications/,
+        /^.*\/src\/.*\/adapters/,
+        /^.*\/src\/.*\/frameworks/
+      ],
+      avoidFrom: []
+    },
+    applications: {
+      from: /^.*\/src\/.*\/applications/,
+      avoid: [
+        /^.*\/src\/.*\/adapters/,
+        /^.*\/src\/.*\/frameworks/
+      ],
+      avoidFrom: []
+    },
+    adapters: {
+      from: /^.*\/src\/.*\/adapters/,
+      avoid: [
+        /^.*\/src\/.*\/frameworks/
+      ],
+      avoidFrom: [
+        /^.*\/src\/.*\/entities/
+      ]
+    },
+    frameworks: {
+      from: /^.*\/src\/.*\/frameworks/,
+      avoid: [],
+      avoidFrom: [
+        /^.*\/src\/.*\/applications/
+      ]
+    },
+    libraries:{
+      from: /^.*\/src\/.*\/library/,
+      avoid: [
+        /^.*\/src\/platform\/.*\/bc/,
+        /^.*\/src\/platform\/.*\/cc/,
+        /^.*\/src\/platform\/cc/,
+        /^.*\/src\/platform\/bc/
+      ],
+      avoidFrom: []
+  },
+    library:{
+      from: /^.*\/src\/library/,
+      avoid: [
+        /^.*\/src\/platform/
+      ],
+      avoidFrom: []
+  }
+}