qml_formatter 0.2.0

QML formatter
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

# QML Formatter
This repository is simple project which implements basic qml formatter, which is used internally inside my projects.

It is alternative for default QML formatter which sometimes broke ours code, so we want to create own app to format files only with needed rules.

I don't expect to add any options to configure it in runtime.

For now formatter can:
- remove empty lines from start and end of file
- connect multiple empty lines into one
- add at the end empty line
- add spaces before and after ? :
- format if/else/for oneliners
- handle strings inside ', " and `
- format classes inside other classes

## Usage
Formatter checks for qml files recursively inside provided folders:
```commandline
qml_formatter folder_with_files_to_check folder_with_files_to_check2 -efolder_with_excluded_files -efolder_with_excluded_files2
```
e.g.
```commandline
qml_formatter /home/a /home/b -e/home/a/not_to_check -e/home/a/completelly
```
will list all files inside folder `/home/a` and `/home/b` that are not inside `/home/a/not_to_check` and `/home/a/completelly`.

By default, app runs in interactive mode which require to confirm formatting, but there is additional argument `NO_QUESTION` which format files without questions e.g.
```commandline
qml_formatter /home/a NO_QUESTION
```

## Conversion example
Before:
```qml


import QtQuick
import "../../commons/elements"
import "../preparationScreen" as ExamCommons


Text {
    id     : root
    property var able: is_able? no_able: very_able
    signal pressed()
    image       :       "qrc://image.svg"
    layer.effect: ElevationEffect 
    
    {
        elevation: elevation
    }

}


```
After
```qml
import QtQuick
import "../../commons/elements"
import "../preparationScreen" as ExamCommons

Text {
    id: root
    property var able: is_able ? no_able : very_able
    signal pressed()
    image: "qrc://image.svg"
    layer.effect: ElevationEffect {
        elevation: elevation
    }
}

```

# TODO
- support for Javascript/HTML/C++ comments
- switch/case
- better multi-line support

# Limitations
## Multiline for/if/else without {}
```
for(abcd)
    if(abcd)
        DBCC()
```
will be formatted into
```
for(abcd)
    if(abcd)
    DBCC()
```
as workaround use always brackets, which are fully supported
```
for(abcd) {
    if(abcd) {
        DBCC()
    }
}
```
it works fine with simple oneliners
```
for(ABCD)
BCDF()
```
will become
```
for(ABCD)
    BCDF()
```