@onecx/angular-linter-rules 8.0.0-rc.1 → 8.0.0-rc.12

package/src/lib/rules/prefer-translate-params.rule.ts

@@ -1,133 +0,0 @@
-import { AST_NODE_TYPES, ESLintUtils, TSESLint, TSESTree } from '@typescript-eslint/utils'
-
-const createRule = ESLintUtils.RuleCreator(
-  (name) => `https://github.com/onecx/onecx-portal-ui-libs/tree/main/libs/angular-linter-rules#${name}`,
-)
-
-type Options = []
-type MessageIds = 'preferTranslateParams'
-
-const defaultAllowedFilePatterns = [/\.spec\.ts$/i, /\.test\.ts$/i, /\/testing\//i, /\/mocks\//i]
-
-function isAllowedTestFile(filename: string): boolean {
-  if (!filename || filename === '<input>' || filename === '<text>') return false
-  return defaultAllowedFilePatterns.some((re) => re.test(filename))
-}
-
-function isTranslateGetOrStreamCallExpression(node: TSESTree.Node): node is TSESTree.CallExpression {
-  if (node.type !== AST_NODE_TYPES.CallExpression) return false
-  if (node.callee.type !== AST_NODE_TYPES.MemberExpression) return false
-  if (node.callee.property.type !== AST_NODE_TYPES.Identifier) return false
-  return node.callee.property.name === 'get' || node.callee.property.name === 'stream'
-}
-
-function isTranslateInstantCallExpression(node: TSESTree.Node): node is TSESTree.CallExpression {
-  if (node.type !== AST_NODE_TYPES.CallExpression) return false
-  if (node.callee.type !== AST_NODE_TYPES.MemberExpression) return false
-  if (node.callee.property.type !== AST_NODE_TYPES.Identifier) return false
-  return node.callee.property.name === 'instant'
-}
-
-function isTranslateGetOrStreamPipeCallExpression(node: TSESTree.Node): node is TSESTree.CallExpression {
-  if (node.type !== AST_NODE_TYPES.CallExpression) return false
-  if (node.callee.type !== AST_NODE_TYPES.MemberExpression) return false
-  if (node.callee.property.type !== AST_NODE_TYPES.Identifier) return false
-  if (node.callee.property.name !== 'pipe') return false
-
-  const obj = node.callee.object
-  return isTranslateGetOrStreamCallExpression(obj)
-}
-
-function containsBinaryPlus(context: TSESLint.RuleContext<MessageIds, Options>, node: TSESTree.Node): boolean {
-  let found = false
-
-  const visit = (n: TSESTree.Node): void => {
-    if (found) return
-
-    if (n.type === AST_NODE_TYPES.BinaryExpression && n.operator === '+') {
-      found = true
-      return
-    }
-
-    const keys = context.sourceCode.visitorKeys[n.type] ?? []
-    for (const key of keys) {
-      const value = (n as unknown as Record<string, unknown>)[key]
-      if (!value) continue
-
-      if (Array.isArray(value)) {
-        for (const child of value) {
-          if (found) return
-          if (child && typeof child === 'object' && 'type' in (child as Record<string, unknown>)) {
-            visit(child as TSESTree.Node)
-          }
-        }
-        continue
-      }
-
-      if (value && typeof value === 'object' && 'type' in (value as Record<string, unknown>)) {
-        visit(value as TSESTree.Node)
-      }
-    }
-  }
-
-  visit(node)
-  return found
-}
-
-function isTranslatePipeExpression(node: TSESTree.Expression): boolean {
-  if (node.type !== AST_NODE_TYPES.BinaryExpression || node.operator !== '|') return false
-  const right = node.right
-  return right.type === AST_NODE_TYPES.Identifier && right.name === 'translate'
-}
-
-export const preferTranslateParams = createRule<Options, MessageIds>({
-  name: 'prefer-translate-params',
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description:
-        'Prefer translation parameters instead of concatenating translated strings (use e.g. `translate.get(key, { param })`).',
-    },
-    schema: [],
-    messages: {
-      preferTranslateParams:
-        'Avoid concatenating translated strings. Prefer translation parameters/placeholders instead (e.g. `translate.get(key, { value })`).',
-    },
-  },
-  defaultOptions: [],
-  create(context) {
-    const filename = context.filename
-    const allowed = isAllowedTestFile(filename)
-
-    if (allowed) {
-      return {}
-    }
-
-    return {
-      BinaryExpression(node) {
-        if (node.operator !== '+') return
-        if (
-          isTranslateGetOrStreamCallExpression(node.left) ||
-          isTranslateGetOrStreamCallExpression(node.right) ||
-          isTranslateInstantCallExpression(node.left) ||
-          isTranslateInstantCallExpression(node.right) ||
-          isTranslatePipeExpression(node.left) ||
-          isTranslatePipeExpression(node.right)
-        ) {
-          context.report({ node, messageId: 'preferTranslateParams' })
-        }
-      },
-      TemplateLiteral(node) {
-        if (!node.expressions.some((expr) => isTranslateGetOrStreamCallExpression(expr) || isTranslateInstantCallExpression(expr))) {
-          return
-        }
-        context.report({ node, messageId: 'preferTranslateParams' })
-      },
-      CallExpression(node) {
-        if (!isTranslateGetOrStreamPipeCallExpression(node)) return
-        if (!containsBinaryPlus(context, node)) return
-        context.report({ node, messageId: 'preferTranslateParams' })
-      },
-    }
-  },
-})

package/src/lib/types.ts

@@ -1,6 +0,0 @@
-import type { TSESLint } from '@typescript-eslint/utils'
-
-export type AngularLinterRulesPlugin = {
-  rules: Record<string, TSESLint.RuleModule<string, readonly unknown[]>>
-  configs: Record<string, TSESLint.Linter.Config>
-}

package/src/lib/utils/type-utils.ts

@@ -1,15 +0,0 @@
-import type ts from 'typescript'
-
-export function isTranslateServiceType(typeChecker: ts.TypeChecker, type: ts.Type): boolean {
-  const symbol = type.getSymbol() ?? type.aliasSymbol
-  if (!symbol) return false
-
-  const name = symbol.getName()
-  if (name !== 'TranslateService') return false
-
-  const declarations = symbol.getDeclarations() ?? []
-  return declarations.some((decl) => {
-    const sourceFileName = decl.getSourceFile().fileName
-    return sourceFileName.includes('/@ngx-translate/core/') || sourceFileName.includes('\\@ngx-translate\\core\\')
-  })
-}

package/src/types/rule-tester.d.ts

@@ -1,3 +0,0 @@
-declare module '@typescript-eslint/rule-tester' {
-  export * from '@typescript-eslint/rule-tester/dist/index'
-}

package/src/version.ts

@@ -1,2 +0,0 @@
-export const LIB_NAME = '@onecx/angular-linter-rules'
-export const LIB_VERSION = '0.0.0-PLACEHOLDER'

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "module": "commonjs",
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "importHelpers": true,
-    "noImplicitOverride": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "noPropertyAccessFromIndexSignature": true
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../dist/out-tsc",
-    "declaration": true,
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.rule-tester.json

@@ -1,5 +0,0 @@
-{
-  "extends": "./tsconfig.spec.json",
-  "include": ["src/**/*.ts", "src/**/*.spec.ts", "src/**/*.test.ts", "src/**/*.d.ts", "jest.config.ts"],
-  "exclude": []
-}

package/tsconfig.spec.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../dist/out-tsc",
-    "module": "commonjs",
-    "moduleResolution": "node10",
-    "types": ["jest", "node"]
-  },
-  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
-}