Merge pull request #1260 from appwrite/feat-djlint-twig-formatter

Author: ChiragAgg5k

.github/workflows/djlint.yml

@@ -0,0 +1,31 @@
+name: Twig Linting
+
+on:
+  pull_request:
+    paths:
+      - '**.twig'
+      - '.github/workflows/djlint.yml'
+      - 'pyproject.toml'
+  push:
+    branches:
+      - master
+    paths:
+      - '**.twig'
+      - '.github/workflows/djlint.yml'
+      - 'pyproject.toml'
+
+jobs:
+  djlint:
+    name: djLint - Twig Linter
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Run djLint linter
+        run: |
+          uvx djlint templates/ --lint

CONTRIBUTING.md

@@ -122,6 +122,31 @@ docker run --rm -v $(pwd):/app -w /app php:8.3-cli php example.php
 
 Check your output files at: /examples/new-lang and make sure the SDK works. When possible, add some unit tests.
 
+## Linting Twig Templates
+
+We use [djLint](https://djlint.com/) to lint Twig template files for syntax errors and common issues. The linter runs automatically on pull requests.
+
+**To lint templates locally:**
+```bash
+composer lint-twig
+```
+
+**Requirements:**
+- [uv](https://github.com/astral-sh/uv) must be installed (for running `uvx` commands)
+
+**Configuration:**
+- Located in `pyproject.toml`
+- Only linting is enabled (formatting is disabled to avoid breaking code generation)
+- Several rules are ignored as they produce false positives for code generation templates
+
+**What the linter catches:**
+- Template syntax errors
+- Missing closing tags
+- Extra blank lines
+- Basic HTML structure issues
+
+**Note:** If you encounter linting errors that seem incorrect for code generation templates, please discuss in your PR rather than disabling the linter.
+
 ## SDK Checklist
 
 It is very important for us to create a consistent structure and architecture, as well as a language-native feel for the SDKs we generate.

README.md

@@ -70,6 +70,19 @@ $sdk->generate(__DIR__ . '/examples/php'); // Generate source code
 
 ```
 
+## Linting Twig Templates
+
+This project uses [djLint](https://djlint.com/) to lint Twig template files for syntax and common issues.
+
+**Note:** Formatting is disabled as it breaks code generation syntax. Only linting is used.
+
+**Available command:**
+```bash
+composer lint-twig  # Check for linting errors
+```
+
+Requires [uv](https://github.com/astral-sh/uv) to be installed. Configuration is in `pyproject.toml`. The linter runs automatically on pull requests via GitHub Actions.
+
 ## Supported Specs
 
 * [Swagger 2](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)

composer.json

@@ -14,7 +14,8 @@
     "scripts": {
         "test": "vendor/bin/phpunit",
         "lint": "vendor/bin/phpcs",
-        "format": "vendor/bin/phpcbf"
+        "format": "vendor/bin/phpcbf",
+        "lint-twig": "uvx djlint templates/ --lint"
     },
     "autoload": {
         "psr-4": {

pyproject.toml

@@ -0,0 +1,18 @@
+[tool.djlint]
+
+profile="jinja"
+extension="twig"
+
+ignore="H012,H025,H030,H031,T001,T002,T027,T032"
+# H012: spaces around = - false positive for TypeScript generics like <T = Models.Document>
+# H025: orphan tags - false positive for code generics like <T>, <String>, <Exception>
+# H030/H031: meta description/keywords (not applicable to SDK code templates)
+# T001: whitespace in tags - {%~ is intentional Twig whitespace control
+# T002: double quotes - templates need flexibility with quote styles
+# T027: unclosed strings - false positive for ${{ secrets.X }} in GitHub Actions
+# T032: extra whitespace in tags - often intentional for formatting/line continuation
+
+exclude=".git,vendor,tests/sdks,node_modules,examples"
+
+use_gitignore=true
+max_line_length=1200

templates/android/build.gradle.twig

@@ -29,6 +29,5 @@ task clean(type: Delete) {
     delete rootProject.buildDir
 }
 
-
 apply from: "${rootDir}/scripts/publish-config.gradle"
 

templates/android/example/src/main/java/io/package/android/ui/accounts/AccountsFragment.kt.twig

@@ -13,7 +13,6 @@ import androidx.fragment.app.viewModels
 import {{ sdk.namespace | caseDot }}.android.R
 import {{ sdk.namespace | caseDot }}.android.databinding.FragmentAccountBinding
 
-
 class AccountsFragment : Fragment() {
 
     private lateinit var binding: FragmentAccountBinding

templates/apple/Sources/Client.swift.twig

@@ -38,7 +38,6 @@ open class Client {
 
     internal var http: HTTPClient
 
-
     private static let boundaryChars = "abcdefghijklmnopqrstuvwxyz1234567890"
 
     private static let boundary = randomBoundary()
@@ -266,7 +265,6 @@ open class Client {
         var request = HTTPClientRequest(url: endPoint + path + queryParameters)
         request.method = .RAW(value: method)
 
-
         for (key, value) in self.headers.merging(headers, uniquingKeysWith: { $1 }) {
             request.headers.add(name: key, value: value)
         }

templates/cli/install.ps1.twig

@@ -35,7 +35,6 @@ function Greeting {
     Write-Host "Welcome to the {{ spec.title | caseUcfirst }} CLI install shield."  
 }
 
-
 function CheckSystemInfo {
     Write-Host "[1/4] Getting System Info ..."
     if ((Get-ExecutionPolicy) -gt 'RemoteSigned' -or (Get-ExecutionPolicy) -eq 'ByPass') {
@@ -60,7 +59,6 @@ function DownloadBinary {
     Move-Item ${{ spec.title | upper }}_DOWNLOAD_DIR ${{ spec.title | upper }}_INSTALL_PATH
 }
 
-
 function Install {
     Write-Host "[3/4] Starting installation ..."
 
@@ -83,7 +81,6 @@ function InstallCompleted {
     Write-Host "As first step, you can login to your {{ spec.title | caseUcfirst }} account using 'appwrite login'"
 }
 
-
 Greeting
 CheckSystemInfo
 DownloadBinary

templates/cli/install.sh.twig

@@ -39,7 +39,6 @@ RED='\033[0;31m'
 GREEN='\033[0;32m'
 NC='\033[0m' # No Color
 
-
 greeting() {
     echo -e "${RED}"
     cat << "EOF"