Intégrations

Il existe plusieurs intégrations d’éditeurs construites pour djLint.

∞ GitHub Actions

Dans un workflow GitHub Actions, djLint signale chaque résultat sous forme d’annotation, qui apparaît donc directement dans le diff d’une pull request. Aucune configuration n’est nécessaire : djLint détecte le workflow et adapte sa sortie automatiquement.

- run: pip install djlint
- run: djlint . --lint --profile django

Utilisez --no-github-output pour obtenir la sortie console habituelle, ou --github-output pour forcer les annotations en dehors d’Actions.

Les annotations sont liées à une seule pull request. Pour conserver les résultats dans l’onglet Security du dépôt, avec leur historique d’une exécution à l’autre, écrivez-les au format SARIF et téléversez le fichier :

- run: djlint . --lint --sarif > djlint.sarif
  continue-on-error: true
- uses: github/codeql-action/upload-sarif@v4
  with:
    sarif_file: djlint.sarif

L’étape de téléversement nécessite la permission security-events: write sur le job ou le workflow.

--sarif écrit sur stdout un document SARIF 2.1.0 et rien d’autre, la sortie peut donc être redirigée comme ci-dessus. Chaque règle activée y figure avec un lien vers sa documentation, chaque résultat indique sa ligne et sa colonne, et avec --check un fichier qui serait reformaté est signalé sous une règle formatting. Azure DevOps, GitLab et la plupart des éditeurs lisent le même format.

∞ Pre-Commit

djLint peut être utilisé comme un hook pre-commit en tant que linter et formatter.

Le repo fournit de multiples hooks pré-configurés pour des profils djLint spécifiques (il suffit de prédéfinir l’argument --profile et d’indiquer à pre-commit les extensions de fichiers à rechercher) :

Notez que ces hooks prédéfinis sont parfois trop conservateurs dans les entrées qu’ils acceptent (vos templates peuvent utiliser une extension différente) donc pre-commit vous permet explicitement de remplacer n’importe laquelle de ces options prédéfinies. Consultez la docs pre-commit pour une configuration supplémentaire.

∞ Exemple de Django par défaut

repos:
  - repo: https://github.com/djlint/djLint
    rev: v1.46.6
    hooks:
      - id: djlint-reformat-django
      - id: djlint-django

∞ Handlebars avec l’extension .html au lieu de .hbs

repos:
  - repo: https://github.com/djlint/djLint
    rev: v1.46.6
    hooks:
      - id: djlint-reformat-handlebars
        files: "\\.html"
        types_or: ["html"]
      - id: djlint-handlebars
        files: "\\.html"
        types_or: ["html"]

Vous pouvez utiliser les paramètres files ou exclude pour contraindre chaque hook à son propre répertoire, ce qui vous permet de supporter plusieurs langages de template dans le même repo.

∞ Linter SublimeText

djLint peut être utilisé comme un plugin SublimeText Linter. Il peut être installé via package-control.

Assurez-vous que djLint est installé dans votre python global, ou sur votre PATH.

∞ Visual Studio Code

∞ neovim

djLint peut être utilisé comme linter et formateur dans neovim.

Avec le plugin none-ls.

Avec coc.nvim.

Avec efm-langserver.

local djlint = {
    formatCommand = "djlint --reformat --quiet --warn -",
    formatStdin = true,
}

local djlint = {
    formatCommand = "djlint --reformat --quiet --warn -",
    formatStdin = true,
}

require("lspconfig").efm.setup({
    filetypes = { "htmldjango" },
    init_options = { documentFormatting = true },
    settings = {
        rootMarkers = { ".git/" },
        languages = {
            htmldjango = { djlint },
        },
    },
})

∞ MegaLinter

djLint est intégré nativement parmi les plus de 100 linters de MegaLinter.

Pour l’installer, lancez npx mega-linter-runner --install et suivez les instructions.