npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

prettier-plugin-qml

v0.14.0

Published

Prettier QML Plugin

Downloads

25

Readme

WORK IN PROGRESS

Please note that this plugin is currently in alpha stage and still under active development. We encourage everyone to try it and give feedback, but we don't recommend it for production use yet.

Intro

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.

This plugin adds support for the QML language to Prettier.

Install

yarn:

yarn add --dev prettier prettie-plugin-qml
# or globally
yarn global add prettier prettie-plugin-qml

npm:

npm install --save-dev prettier prettie-plugin-qml
# or globally
npm install --global prettier prettie-plugin-qml

Use

If you installed prettier as a local dependency, you can add prettier as a script in your package.json,

"scripts": {
  "prettier": "prettier"
}

and then run it via

yarn run prettier path/to/file.qml --write
# or
npm run prettier -- path/to/file.qml --write

If you installed globally, run

prettier path/to/file.qml --write

Editor integration

Atom

The official prettier plugin for atom supports plugins.

VScode

Regarding plugin support in the official plugin prettier-vscode see this issue.

Alternatively, install Run on Save and add the following section to your settings:

"emeraldwalk.runonsave": {
  "commands": [
    {
      "match": "\\.qml$",
        "cmd": "prettier ${file} --write"
    }
  ]
}

Vim

Regarding plugin support in the official plugin vim-prettier see this issue.

ALE

The linting plugin ALE has built-in support for prettier and its plugins. Just add prettier to your list of fixers. For example:

let g:ale_fixers={
  \'javascript': ['prettier'],
  \'json': ['prettier'],
  \'qml': ['prettier'],
\}

Custom

Alternatively, adding the following to .vimrc will define a custom command :PrettierQml that runs the plugin while preserving the cursor position and run it on save.

" Prettier for QML
function PrettierQmlCursor()
  let save_pos = getpos(".")
  %! prettier --stdin --parser=qml
  call setpos('.', save_pos)
endfunction
" define custom command
command PrettierQml call PrettierQmlCursor()
" format on save
autocmd BufwritePre *.qml PrettierQml

Contributing

If you're interested in contributing to the development of Prettier for QML, you can follow the CONTRIBUTING guide from Prettier, as it all applies to this repository too.

To test it out on a QML file:

  • Clone this repository.
  • Run yarn.
  • Create a file called test.qml.
  • Run yarn prettier test.qml to check the output.

Maintainers