diff options
Diffstat (limited to 'sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst')
-rw-r--r-- | sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst b/sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst new file mode 100644 index 000000000..ba27414d7 --- /dev/null +++ b/sources/pyside6/doc/tools/pyside6-qmlimportscanner.rst @@ -0,0 +1,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" + } + ] |