aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst
blob: ba27414d7b990bfbab9fd4538a47d55b2dc32112 (plain)
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
.. _pyside6-qmlimportscanner:

pyside6-qmlimportscanner
========================

``pyside6-qmlimportscanner`` is a command line tool that wraps the
``qmlimportscanner`` tool of Qt.


The tool is automatically run by the :ref:`pyside6-project` tool
when passing the ``qmllint`` argument instructing it to check
the QML source files.

Usage
-----

Invoking the tool in the directory of the :ref:`filesystemexplorer_example`
example using:

.. code-block:: bash

    pyside6-qmlimportscanner -rootPath .

produces:

.. code-block:: json

    [
        {
            "name": "QtQuick",
            "type": "module"
        },
        {
            "name": "QtQuick.Controls.Basic",
            "type": "module"
        },
        {
            "name": "QtQuick.Layouts",
            "type": "module"
        },
        {
            "name": "FileSystemModule",
            "type": "module"
        },
        {
            "name": "QtQuick.Controls",
            "type": "module"
        },
        {
            "name": "QtQuick.Effects",
            "type": "module"
        }
    ]