qml-format

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 13 Open GitHub ↗

A VS Code extension to beautify QML files

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# QML Format

*A Visual Studio Code extension to beautify Qt QML files.*

[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/delgan.qml-format)](https://marketplace.visualstudio.com/items?itemName=delgan.qml-format) [![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/Delgan/qml-format/tests.yml?branch=main)](https://github.com/Delgan/qml-format/actions/workflows/tests.yml?query=branch:main) [![License](https://img.shields.io/github/license/Delgan/qml-format)](https://github.com/Delgan/qml-format/blob/main/LICENSE)

</div>

## Features

This extension calls [`qmlformat`](https://doc-snapshots.qt.io/qt6-dev/qtquick-tools-and-utilities.html#qmlformat) command to automatically format your QML files in accordance with the [QML Coding Conventions](https://doc-snapshots.qt.io/qt6-dev/qml-codingconventions.html).

[![Formatting demo](https://raw.githubusercontent.com/Delgan/qml-format/main/assets/demo.gif)](https://raw.githubusercontent.com/Delgan/qml-format/main/assets/demo.gif)

## Requirements

You **must** have the `qmlformat` command installed on your development environment.

This utility was added to the [Qt Quick](https://doc-snapshots.qt.io/qt6-dev/qtquick-index.html) module starting with **Qt 5.15**.

## Settings

If desired, you can optionally configure some parameters:

```jsonc
{
    // You can specify the path toward the "qmlformat" executable,
    // if it's not available by default in your PATH.
    "qmlFormat.command": "/usr/lib/qt6/bin/qmlformat",

// You can specify additional arguments that will be passed
    // to the "qmlformat" command while formatting a file.
    "qmlFormat.extraArguments": ["--normalize"]
}
```

qml-format

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README