はじめに
インストール
Section titled “インストール”djLint は PyPI と npm で公開されています。PyPI 版には Python 3.11 以降が必要で、npm 版は独自の Python を同梱しています。Python プロジェクトでは uv か pip で、Angular アプリや Eleventy のサイト、Shopify テーマなどの JavaScript プロジェクトでは npm で追加してください。
uv を使う場合は、開発用の依存関係としてプロジェクトに追加します:
uv add --dev djlintまたは、単独のツールとしてインストールします:
uv tool install djlintpip install djlintnpm パッケージは独自の Python を同梱しているため、必要なのは Node.js 16.9 以降だけです。Linux(x64、Arm64、ppc64le、s390x、riscv64)、macOS(x64、Arm64)、Windows(x64、x86、Arm64)向けのビルドがあります。Alpine などの musl を使う Linux では x64 と Arm64 で動きます。開発用の依存関係としてプロジェクトに追加します:
npm i -D djlintまたは、グローバルにインストールします:
npm i -g djlintpipx でインストールします:
pipx install djlintmacOS や Linux では、コミュニティが管理している Homebrew formula でインストールします:
brew install djlintエディターで、またはコミットのたびに djLint を実行するには、連携と pre-commit を参照してください。
はじめての実行
Section titled “はじめての実行”テンプレートのあるフォルダーを djLint に渡し、--profile にテンプレート言語を指定します。どのリンタールールを実行し、テンプレート構文をどうフォーマットするかはプロファイルで決まります。Django プロジェクトの場合:
テンプレートをリントします(リントはデフォルトのモードなので、--lint は省略できます):
djlint templates --lint --profile=djangoフォーマットで何が変わるかを確認します。--check を付けると、djLint は差分を表示するだけでファイルは変更しません:
djlint templates --check --profile=djangoファイルをその場でフォーマットします:
djlint templates --reformat --profile=djangoすべてのプロファイルは profile オプションに一覧があります。テンプレート言語ごとのページもあり(例:Django、Jinja、Handlebars)、毎回指定しなくて済むように設定ファイルでプロファイルを設定する方法も載っています。
uv add --dev でプロジェクトに追加した場合、djLint はプロジェクトの環境に入っています。コマンドの前に uv run を付けてください(例:uv run djlint templates --lint --profile=django)。 npm i -D で追加した場合は、代わりに npx を付けます(例:npx djlint templates --lint --profile=django)。
パスと標準入力の使い分け
Section titled “パスと標準入力の使い分け”djLint はパスと標準入力のどちらでも動作します。
パスを指定して実行する場合:
djlint /path/to/templates --lint特定のファイルを指定する場合:
djlint /path/to/this.mustache --lint標準入力を使う場合:
echo "<div></div>" | djlint -標準入力はコードの再フォーマットにも使えます。出力はフォーマット済みのコードだけで、メッセージは含まれません。
echo "<div></div>" | djlint - --reformat出力:
<div></div>標準入力から読み込む場合、djLint には per-file-ignores との照合やメッセージの表示に使う実際のパスがないため、デフォルトで - を使います。エディターとの連携機能が保存時にファイルの内容をパイプで渡す場合などは、--stdin-filename を指定して、パイプで渡した内容の実際のパスを djLint に伝えてください。
echo "<div></div>" | djlint - --stdin-filename templates/index.html| コード | 意味 |
|---|---|
0 |
djLint にチェックを指示したものすべてに問題がないか、見つかったファイルがすべて設定によってスキップされました。 |
1 |
djLint がリントエラー、または再フォーマットが必要なファイルを見つけました。--warn を指定すると、これらを警告として報告し、代わりに 0 で終了します。 |
2 |
djLint は指示したものをチェックしませんでした。パスに一致するファイルがなかったか、ファイルを読めなかったか(UTF-8 でない、または権限がない)、コマンドラインや設定が無効だったか、djLint が失敗しました。 |
djLint がテンプレートを調べて問題を見つけたことを意味するのは、コード 1 だけです。そのため、パイプラインは失敗したチェックと、何もチェックしなかった実行(パスの誤りや、もう一致しなくなった --extension など)を区別できます。
djLint が見つけたうえで、exclude、extend_exclude、use_gitignore、require_pragma によって意図的にスキップしたファイルはエラーではありません。pre-commit で exclude が機能するのはこのためです。テンプレートがないパスがパイプラインにとって正常な場合は、allow_empty_input でコード 2 を無効にしてください:
djlint /path/to/templates --lint --allow-empty-inputCLI の使い方
Section titled “CLI の使い方”Usage: djlint [OPTIONS] SRC ...
djLint · HTML template linter and formatter.
Modes: --lint Lint the files. This is the default when neither --reformat nor --check is given. --reformat Format the files in place. --check Show what formatting would change, without changing the files. --lsp Run as a language server over stdio, for editors.
Files: -e, --extension EXT Extension of the files to look for in folders. [default: html] --exclude PATHS Regexes of the paths to skip, comma-separated, in place of the default list. --extend-exclude PATHS Regexes of the paths to skip on top of the exclude list, comma-separated. --use-gitignore Also skip the paths that the .gitignore in the project root lists. --require-pragma Only format or lint files whose first line is a djlint:on comment. --stdin-filename PATH Path that stands for stdin in messages, excludes and per-file ignores. [default: -] --allow-empty-input Exit with 0 instead of 2 when the given paths match no files.
Configuration: --profile NAME Template language: html, django, jinja, nunjucks, handlebars, liquid, golang, angular, tera, askama, mako or all. It decides which linter rules run and how template syntax is formatted. Without one, formatting follows all and the linter runs the rules of html. --configuration FILE Global config file: a pyproject.toml, djlint.toml or .djlintrc. The project's own config file wins where both set an option. --prefer-configuration Let the --configuration file win over the project's own config file.
Linter: -i, --ignore CODES Linter codes to skip, comma-separated, for example H014,H017. --include CODES Linter codes to turn on, comma-separated, for example H017. Works for rules that are off by default and for rules the profile leaves out. --per-file-ignores <PATTERN CODES>... Skip linter codes in the files whose path matches a regex. Can be repeated. --rules FILE Custom linter rules, in the .djlint_rules.yaml format.
Output: --quiet Do not print diffs, the progress bar or the summary. --warn Exit with 0 instead of 1 when there are lint errors or files to reformat. --statistics After linting, print how many times each code was found. --linter-output-format FORMAT Layout of each lint message, from {filename}, {line}, {end}, {code}, {message} and {match}. [default: {code} {line} {message} {match}] --github-output / --no-github-output Print results as GitHub Actions annotations. On by default inside GitHub Actions. --sarif Print findings as a SARIF 2.1.0 JSON document, for GitHub code scanning and other tools.
Layout: --indent N Spaces per indent level. [default: 4, or indent_size from .editorconfig] --max-line-length N Join tags onto one line only when the line fits within this length. [default: 120, or max_line_length from .editorconfig] --max-attribute-length N Spread a tag's attributes over lines once they are longer than this. [default: 70] --single-attribute-per-line When an opening tag wraps, put each attribute on its own line. --line-break-after-multiline-tag When a tag's attributes are spread over lines, start its content on a new line. --no-indent-inner-html Do not indent <head> and <body> inside <html>. --keep-br-inline Keep <br> on the line of the text it breaks. --custom-blocks TAGS Names of the custom template blocks to indent, comma-separated, for example toc. --custom-html TAGS Names of the custom HTML tags to indent, comma-separated, for example mjml. --ignore-blocks TAGS Template blocks that do not indent their contents, comma-separated. --blank-line-after-tag TAGS Template tags to follow with a blank line, comma-separated, for example load,extends. --blank-line-before-tag TAGS Template tags to precede with a blank line, comma-separated, for example load,extends. --max-blank-lines N Keep at most this many blank lines in a row. Has no effect with --preserve-blank-lines. [default: 0] --preserve-blank-lines Keep blank lines where possible. --preserve-leading-space Keep the leading spaces of text lines where possible. --no-line-after-yaml Do not add a blank line after YAML front matter.
Rewrites: --close-void-tags Close void tags with a slash, so <img> becomes <img />. --ignore-case Do not fix the case of known HTML tags. --sort-attributes Sort attributes by name, with id first and class second. --sort-load-tags Sort the libraries in {% load %} tags and drop repeated ones. --name-endblocks Name the block in its {% endblock %} when the block spans lines. --quote-style [double|single] Quotes for strings inside template tags. [default: double] --no-entity-formatting Do not rewrite entity references such as © as the characters they name. --no-function-formatting Do not format the arguments of function calls inside {{ }}. --no-set-formatting Do not format the contents of {% set %} tags. --preserve-class-newlines Keep the line breaks in class attributes written across lines. --format-attribute-template-tags Format template syntax inside tag attributes.
CSS and JavaScript: --format-css Also format the contents of <style> tags, with css-beautify. --indent-css N Indent width inside <style> tags, for --format-css. [default: 4] --format-js Also format JavaScript and JSON in <script> tags, with js-beautify. --indent-js N Indent width inside <script> tags, for --format-js. [default: 4] --format-attribute-js-json Also format JavaScript and JSON in attributes such as onclick and x-data. --format-attribute-js-json-pattern REGEX Regex for the names of the attributes to format as JavaScript or JSON. [default: on* event handlers and Alpine, Vue, Angular and Aurelia bindings] --format-attribute-js-json-min-props N Format an object only when it has at least this many properties. [default: 2]
Other: --version Show the version and exit. -h, --help Show this message and exit.