refactor: split architecture rules into domain-specific files
Split the monolithic .architecture-rules.yaml (1700+ lines) into focused domain-specific files in .architecture-rules/ directory: - _main.yaml: Core config, principles, ignore patterns, severity levels - api.yaml: API endpoint rules (API-001 to API-005) - service.yaml: Service layer rules (SVC-001 to SVC-007) - model.yaml: Model rules (MDL-001 to MDL-004) - exception.yaml: Exception handling rules (EXC-001 to EXC-005) - naming.yaml: Naming convention rules (NAM-001 to NAM-005) - auth.yaml: Auth and multi-tenancy rules (AUTH-*, MT-*) - middleware.yaml: Middleware rules (MDW-001 to MDW-002) - frontend.yaml: Frontend rules (JS-*, TPL-*, FE-*, CSS-*) - language.yaml: Language/i18n rules (LANG-001 to LANG-010) - quality.yaml: Code quality rules (QUAL-001 to QUAL-003) Also creates scripts/validators/ module with base classes for future modular validator extraction. The validate_architecture.py loader now auto-detects and merges split YAML files while maintaining backward compatibility with single file mode. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
240
.architecture-rules/language.yaml
Normal file
240
.architecture-rules/language.yaml
Normal file
@@ -0,0 +1,240 @@
|
||||
# Architecture Rules - Language & I18N Rules
|
||||
# Rules for internationalization and language handling
|
||||
|
||||
language_rules:
|
||||
|
||||
- id: "LANG-001"
|
||||
name: "Only use supported language codes"
|
||||
severity: "error"
|
||||
description: |
|
||||
Only use supported language codes: en, fr, de, lb
|
||||
Never use full language names or invalid codes.
|
||||
|
||||
SUPPORTED CODES:
|
||||
- en: English (fallback language)
|
||||
- fr: French (default for Luxembourg)
|
||||
- de: German
|
||||
- lb: Luxembourgish
|
||||
|
||||
WRONG:
|
||||
language = "english" # Use "en"
|
||||
language = "french" # Use "fr"
|
||||
language = "lux" # Use "lb"
|
||||
|
||||
RIGHT:
|
||||
language = "en"
|
||||
language = "fr"
|
||||
language = "de"
|
||||
language = "lb"
|
||||
pattern:
|
||||
file_pattern: "**/*.py"
|
||||
anti_patterns:
|
||||
- "'english'"
|
||||
- "'french'"
|
||||
- "'german'"
|
||||
- "'luxembourgish'"
|
||||
- "'lux'"
|
||||
|
||||
- id: "LANG-002"
|
||||
name: "Never use inline Alpine.js x-data with Jinja for language selector"
|
||||
severity: "error"
|
||||
description: |
|
||||
Never put complex JavaScript objects inline in x-data when using Jinja variables.
|
||||
Jinja outputs Python lists, not JSON, which breaks JavaScript parsing.
|
||||
|
||||
WRONG (inline with Jinja):
|
||||
<div x-data="{
|
||||
languages: {{ vendor.storefront_languages }},
|
||||
...
|
||||
}">
|
||||
|
||||
RIGHT (function with tojson|safe):
|
||||
<div x-data="languageSelector('{{ lang }}', {{ langs|tojson|safe }})">
|
||||
|
||||
The languageSelector function must be defined in:
|
||||
- static/shop/js/shop-layout.js (for storefront)
|
||||
- static/vendor/js/init-alpine.js (for vendor dashboard)
|
||||
pattern:
|
||||
file_pattern: "app/templates/**/*.html"
|
||||
anti_patterns:
|
||||
- 'x-data="{\s*.*languages:'
|
||||
- 'x-data="{\s*.*languageNames:'
|
||||
- 'x-data="{\s*.*languageFlags:'
|
||||
exceptions:
|
||||
- "partials/header.html"
|
||||
|
||||
- id: "LANG-003"
|
||||
name: "Use tojson|safe for Python lists in JavaScript"
|
||||
severity: "error"
|
||||
description: |
|
||||
When passing Python lists to JavaScript in templates, always use tojson|safe.
|
||||
- tojson converts Python list to JSON
|
||||
- safe prevents HTML escaping of quotes
|
||||
|
||||
WRONG (raw output):
|
||||
languages: {{ vendor.storefront_languages }}
|
||||
<!-- Outputs: ['fr', 'de'] - Python syntax -->
|
||||
|
||||
WRONG (tojson without safe):
|
||||
languages: {{ vendor.storefront_languages|tojson }}
|
||||
<!-- May escape quotes to " -->
|
||||
|
||||
RIGHT:
|
||||
languages: {{ vendor.storefront_languages|tojson|safe }}
|
||||
<!-- Outputs: ["fr", "de"] - Valid JSON -->
|
||||
pattern:
|
||||
file_pattern: "app/templates/**/*.html"
|
||||
required_with_jinja_array:
|
||||
- "|tojson|safe"
|
||||
|
||||
- id: "LANG-004"
|
||||
name: "Language selector function must be exported to window"
|
||||
severity: "error"
|
||||
description: |
|
||||
The languageSelector function must be defined and exported to window
|
||||
in the appropriate JavaScript file.
|
||||
|
||||
Required in static/shop/js/shop-layout.js:
|
||||
function languageSelector(currentLang, enabledLanguages) { ... }
|
||||
window.languageSelector = languageSelector;
|
||||
|
||||
Required in static/vendor/js/init-alpine.js:
|
||||
function languageSelector(currentLang, enabledLanguages) { ... }
|
||||
window.languageSelector = languageSelector;
|
||||
pattern:
|
||||
file_pattern: "static/shop/js/shop-layout.js"
|
||||
required_patterns:
|
||||
- "function languageSelector"
|
||||
- "window.languageSelector"
|
||||
file_pattern: "static/vendor/js/init-alpine.js"
|
||||
required_patterns:
|
||||
- "function languageSelector"
|
||||
- "window.languageSelector"
|
||||
|
||||
- id: "LANG-005"
|
||||
name: "Use native language names in language selector"
|
||||
severity: "error"
|
||||
description: |
|
||||
Language names must be in their native form, not English.
|
||||
|
||||
WRONG (English names):
|
||||
languageNames: {
|
||||
'fr': 'French',
|
||||
'de': 'German',
|
||||
'lb': 'Luxembourgish'
|
||||
}
|
||||
|
||||
RIGHT (native names):
|
||||
languageNames: {
|
||||
'en': 'English',
|
||||
'fr': 'Francais',
|
||||
'de': 'Deutsch',
|
||||
'lb': 'Letzebuergesch'
|
||||
}
|
||||
pattern:
|
||||
file_pattern: "static/**/js/**/*.js"
|
||||
anti_patterns:
|
||||
- "'fr':\\s*'French'"
|
||||
- "'de':\\s*'German'"
|
||||
- "'lb':\\s*'Luxembourgish'"
|
||||
|
||||
- id: "LANG-006"
|
||||
name: "Use correct flag codes for languages"
|
||||
severity: "error"
|
||||
description: |
|
||||
Flag codes must map correctly to flag-icons library codes.
|
||||
|
||||
CORRECT MAPPINGS:
|
||||
- en -> gb (Great Britain flag for English)
|
||||
- fr -> fr (France flag)
|
||||
- de -> de (Germany flag)
|
||||
- lb -> lu (Luxembourg flag)
|
||||
|
||||
WRONG:
|
||||
'en': 'us' # US flag incorrect for general English
|
||||
'en': 'en' # 'en' is not a valid flag code
|
||||
'lb': 'lb' # 'lb' is not a valid flag code
|
||||
|
||||
RIGHT:
|
||||
'en': 'gb',
|
||||
'fr': 'fr',
|
||||
'de': 'de',
|
||||
'lb': 'lu'
|
||||
pattern:
|
||||
file_pattern: "static/**/js/**/*.js"
|
||||
anti_patterns:
|
||||
- "'en':\\s*'us'"
|
||||
- "'en':\\s*'en'"
|
||||
- "'lb':\\s*'lb'"
|
||||
|
||||
- id: "LANG-007"
|
||||
name: "Storefront must respect vendor's enabled languages"
|
||||
severity: "error"
|
||||
description: |
|
||||
Shop/storefront templates must only show languages enabled by the vendor.
|
||||
Use vendor.storefront_languages, not a hardcoded list.
|
||||
|
||||
WRONG (hardcoded):
|
||||
{% set enabled_langs = ['en', 'fr', 'de', 'lb'] %}
|
||||
|
||||
RIGHT (from vendor config):
|
||||
{% set enabled_langs = vendor.storefront_languages if vendor and vendor.storefront_languages else ['fr', 'de', 'en'] %}
|
||||
pattern:
|
||||
file_pattern: "app/templates/shop/**/*.html"
|
||||
required_for_lang_selector:
|
||||
- "vendor.storefront_languages"
|
||||
|
||||
- id: "LANG-008"
|
||||
name: "Language API endpoint must use POST method"
|
||||
severity: "error"
|
||||
description: |
|
||||
The language set API must be called with POST method, not GET.
|
||||
|
||||
WRONG:
|
||||
fetch('/api/v1/language/set?lang=' + lang)
|
||||
fetch('/api/v1/language/set', { method: 'GET' })
|
||||
|
||||
RIGHT:
|
||||
fetch('/api/v1/language/set', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ language: lang })
|
||||
})
|
||||
pattern:
|
||||
file_pattern: "static/**/js/**/*.js"
|
||||
anti_patterns:
|
||||
- "/language/set.*method.*GET"
|
||||
- "/language/set\\?lang="
|
||||
|
||||
- id: "LANG-009"
|
||||
name: "Always provide language default in templates"
|
||||
severity: "error"
|
||||
description: |
|
||||
When accessing request.state.language, always provide a default value.
|
||||
|
||||
WRONG:
|
||||
{{ request.state.language }} <!-- May be None -->
|
||||
|
||||
RIGHT:
|
||||
{{ request.state.language|default("fr") }}
|
||||
pattern:
|
||||
file_pattern: "app/templates/**/*.html"
|
||||
anti_patterns:
|
||||
- 'request\\.state\\.language[^|]'
|
||||
required_pattern: 'request\\.state\\.language\\|default'
|
||||
|
||||
- id: "LANG-010"
|
||||
name: "Translation files must be valid JSON"
|
||||
severity: "error"
|
||||
description: |
|
||||
All translation files in static/locales/ must be valid JSON.
|
||||
No trailing commas, proper quoting, etc.
|
||||
|
||||
Files required:
|
||||
- static/locales/en.json
|
||||
- static/locales/fr.json
|
||||
- static/locales/de.json
|
||||
- static/locales/lb.json
|
||||
pattern:
|
||||
file_pattern: "static/locales/*.json"
|
||||
check: "valid_json"
|
||||
Reference in New Issue
Block a user