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-pretext

v1.0.3

Published

A Prettier plugin for PreTeXt XML

Downloads

5

Readme

prettier-plugin-pretext

prettier-plugin-pretext is a prettier plugin for PreTeXt XML dialect. prettier is an opinionated code formatter that supports multiple languages and integrates with most editors. The idea is to eliminate discussions of style in code review and allow developers to get back to thinking about code design instead. It is based off of @prettier/plugin-xml.

Getting started

To run prettier with the XML plugin, you're going to need node.

If you're using the npm CLI, then add the plugin by:

npm install --save-dev prettier @prettier/plugin-xml

Or if you're using yarn, then add the plugin by:

yarn add --dev prettier @prettier/plugin-xml

The prettier executable is now installed and ready for use:

./node_modules/.bin/prettier --write '**/*.xml'

Configuration

Below are the options (from src/plugin.ts) that @prettier/plugin-xml currently supports:

| API Option | CLI Option | Default | Description | | -------------------------- | ------------------------------ | :--------: | ------------------------------------------------------------------------------------------------------------- | | printWidth | --print-width | 80 | Same as in Prettier (see prettier docs). | | singleAttributePerLine | --single-attribute-per-line | false | Same as in Prettier (see prettier docs) | | tabWidth | --tab-width | 4 | Same as in Prettier (see prettier docs). | | useTabs | --use-tabs | true | Same as in Prettier (see prettier docs). |

Any of these can be added to your existing prettier configuration file. For example:

{
    "tabWidth": 4
}

Or, they can be passed to prettier as arguments:

prettier --tab-width 4 --write '**/*.ptx'

Whitespace

In XML, by default, all whitespace inside elements has semantic meaning. This plugin uses assumptions about the PreTeXt schema to insert/delete whitespace to assist in pretty printing. However, some xml elements are treated specially (for example, elements that contain code). A list of these can be found in src/pretext/special-nodes.

Ignore ranges

You can use two special comments to get prettier to ignore formatting a specific piece of the document, as in the following example:

<foo>
  <!-- prettier-ignore-start -->
    <this-content-will-not-be-formatted     />
  <!-- prettier-ignore-end -->
</foo>

License

The package is available as open source under the terms of the MIT License.