Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

6.2 KB
Raw Blame
import type { Rule } from 'eslint'
import type { AST } from 'jsonc-eslint-parser'
import type { JsonRuleModule } from '../utils.ts'
import fs from 'node:fs'
import path, { normalize, sep } from 'node:path'
import { getTranslationSourceKey } from '../../../i18n-plurals.ts'
import { cleanJsonText } from '../utils.ts'

function extractPlaceholders(str: string) {
  const matches = str.match(/\{\{\w+\}\}/g) || []
  return matches.map((m) => m.slice(2, -2)).sort()
}

function extractTagMarkers(str: string) {
  const matches = Array.from(str.matchAll(/<\/?([A-Z][\w-]*)\b[^>]*>/gi))
  const markers = matches.map((match) => {
    const fullMatch = match[0]
    const name = match[1]
    const isClosing = fullMatch.startsWith('</')
    const isSelfClosing = !isClosing && fullMatch.endsWith('/>')

    if (isClosing) return `close:${name}`
    if (isSelfClosing) return `self:${name}`
    return `open:${name}`
  })

  return markers.sort()
}

function formatTagMarker(marker: string) {
  if (marker.startsWith('close:')) return marker.slice('close:'.length)
  if (marker.startsWith('self:')) return marker.slice('self:'.length)
  return marker.slice('open:'.length)
}

function arraysEqual(arr1: string[], arr2: string[]) {
  if (arr1.length !== arr2.length) return false
  return arr1.every((val, i) => val === arr2[i])
}

function uniqueSorted(items: string[]) {
  return Array.from(new Set(items)).sort()
}

function getJsonLiteralValue(node: AST.JSONNode | undefined) {
  if (!node) return undefined
  return node.type === 'JSONLiteral' ? node.value : undefined
}

function buildPlaceholderMessage(
  key: string,
  englishPlaceholders: string[],
  currentPlaceholders: string[],
) {
  const missing = englishPlaceholders.filter((p) => !currentPlaceholders.includes(p))
  const extra = currentPlaceholders.filter((p) => !englishPlaceholders.includes(p))

  const details = []
  if (missing.length > 0) details.push(`missing {{${missing.join('}}, {{')}}}`)
  if (extra.length > 0) details.push(`extra {{${extra.join('}}, {{')}}}`)

  return (
    `Placeholder mismatch with en-US in "${key}": ${details.join('; ')}. ` +
    `Expected: {{${englishPlaceholders.join('}}, {{') || 'none'}}}`
  )
}

function buildTagMessage(key: string, englishTagMarkers: string[], currentTagMarkers: string[]) {
  const missing = englishTagMarkers.filter((p) => !currentTagMarkers.includes(p))
  const extra = currentTagMarkers.filter((p) => !englishTagMarkers.includes(p))

  const details = []
  if (missing.length > 0)
    details.push(`missing ${uniqueSorted(missing.map(formatTagMarker)).join(', ')}`)
  if (extra.length > 0) details.push(`extra ${uniqueSorted(extra.map(formatTagMarker)).join(', ')}`)

  return (
    `Trans tag mismatch with en-US in "${key}": ${details.join('; ')}. ` +
    `Expected: ${uniqueSorted(englishTagMarkers.map(formatTagMarker)).join(', ') || 'none'}`
  )
}

const rule: JsonRuleModule = {
  meta: {
    type: 'problem',
    docs: {
      description: 'Ensure placeholders and Trans tags in translations match the en-US source',
    },
  },
  create(context) {
    const state: {
      enabled: boolean
      englishJson: Record<string, unknown> | null
      englishKeys: Set<string>
      language: string
    } = {
      enabled: false,
      englishJson: null,
      englishKeys: new Set(),
      language: 'en-US',
    }

    function isTopLevelProperty(node: AST.JSONProperty) {
      const objectNode = node.parent
      if (!objectNode || objectNode.type !== 'JSONObjectExpression') return false
      const expressionNode = objectNode.parent
      return (
        !!expressionNode &&
        ['JSONExpressionStatement', 'Program', 'JSONProgram'].includes(expressionNode.type)
      )
    }

    return {
      Program(node) {
        const { filename } = context

        if (!filename.endsWith('.json')) return

        const parts = normalize(filename).split(sep)
        const jsonFile = parts.at(-1)
        const lang = parts.at(-2)

        if (!lang || lang === 'en-US') return

        state.enabled = true
        state.language = lang

        try {
          const englishFilePath = path.join(path.dirname(filename), '..', 'en-US', jsonFile ?? '')
          const englishText = fs.readFileSync(englishFilePath, 'utf8')
          state.englishJson = JSON.parse(cleanJsonText(englishText)) as Record<string, unknown>
          state.englishKeys = new Set(Object.keys(state.englishJson))
        } catch (error) {
          state.enabled = false
          context.report({
            node: node as unknown as Rule.Node,
            message: `Error parsing JSON: ${error instanceof Error ? error.message : String(error)}`,
          })
        }
      },
      JSONProperty(node: AST.JSONProperty) {
        if (!state.enabled) return

        if (!state.englishJson || !isTopLevelProperty(node)) return

        const key = node.key.type === 'JSONIdentifier' ? node.key.name : node.key.value
        if (typeof key !== 'string' || !key) return

        const sourceKey = getTranslationSourceKey(state.englishKeys, key, state.language)
        if (!sourceKey) return

        const currentNode = node.value ?? node
        const currentValue = getJsonLiteralValue(currentNode)
        const englishValue = state.englishJson[sourceKey]

        if (typeof currentValue !== 'string' || typeof englishValue !== 'string') return

        const currentPlaceholders = extractPlaceholders(currentValue)
        const englishPlaceholders = extractPlaceholders(englishValue)
        const currentTagMarkers = extractTagMarkers(currentValue)
        const englishTagMarkers = extractTagMarkers(englishValue)

        if (!arraysEqual(currentPlaceholders, englishPlaceholders)) {
          context.report({
            node: currentNode as unknown as Rule.Node,
            message: buildPlaceholderMessage(key, englishPlaceholders, currentPlaceholders),
          })
        }

        if (!arraysEqual(currentTagMarkers, englishTagMarkers)) {
          context.report({
            node: currentNode as unknown as Rule.Node,
            message: buildTagMessage(key, englishTagMarkers, currentTagMarkers),
          })
        }
      },
    }
  },
}

// JSON listeners receive jsonc-eslint-parser nodes rather than ESTree nodes.
export default rule as unknown as Rule.RuleModule