prettier-plugin-elm weekly downloads statistics

<p align="center"> &nbsp;&nbsp;<img alt="Prettier" src="https://cdn.rawgit.com/prettier/prettier-logo/master/images/prettier-icon-light.svg">&nbsp;&nbsp; &nbsp;&nbsp;<img alt="Elm" height="210" src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/f3/Elm_logo.svg/1024px-Elm_logo.svg.png">&nbsp;&nbsp; </p> <h2 align="center">Prettier Elm plugin</h2> <p align="center"> <a href="https://github.com/gicentre/prettier-plugin-elm/blob/main/LICENSE"> <img alt="license: BSD-3-Clause" src="https://img.shields.io/github/license/gicentre/prettier-plugin-elm.svg?style=flat-square"><!-- --></a> <a href="https://www.npmjs.com/package/prettier-plugin-elm"> <img alt="NPM package" src="https://img.shields.io/npm/v/prettier-plugin-elm.svg?style=flat-square"><!-- --></a> <a href="https://github.com/gicentre/prettier-plugin-elm/actions/workflows/ci.yml"> <img alt="GitHub Workflow Status (CI)" src="https://img.shields.io/github/actions/workflow/status/gicentre/prettier-plugin-elm/ci.yml?label=CI&style=flat-square"><!-- --></a> <a href="https://codecov.io/gh/gicentre/prettier-plugin-elm"> <img alt="Codecov" src="https://img.shields.io/codecov/c/github/gicentre/prettier-plugin-elm?style=flat-square&token=38aa3a14f00b4d3cbb8e39a9d69e6c64"><!-- --></a> <br> <a href="https://www.npmjs.com/package/prettier-plugin-elm"> <img alt="downloads" src="https://img.shields.io/npm/dt/prettier-plugin-elm.svg?style=flat-square"><!-- --></a> <a href="#badge"> <img alt="code style: Prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"><!-- --></a> <a href="https://twitter.com/giCentre"> <img alt="giCentre on Twitter" src="https://img.shields.io/badge/follow-%40giCentre-1DA1F2?logo=twitter&style=flat-square"><!-- --></a> </p>

This plugin integrates elm-format into Prettier. In addition to dealing with .elm files via Prettier API, this plugin lets you format Elm code blocks inside markdown documents.

For example,

<!-- prettier-ignore -->

#    Hello world in Elm
```elm
import  Html exposing     (text)

main = text      "Hello, World!"
```

becomes:

# Hello world in Elm

```elm
import Html exposing (text)


main =
    text "Hello, World!"
```

You can disable code formatting for a particular code block by adding <nobr><!-- prettier-ignore --></nobr> before ```elm.

Elm code with custom formatting:

<!-- prettier-ignore -->
```elm
main = text      "Hello, World!"
```

Prettified code:

```elm
main =
    text "Hello, World!"
```

The latest version of prettier-plugin-elm assumes that you are using Elm 0.19. For compatibility with Elm 0.18, please install prettier-plugin-elm@0.3.

Getting started

The instructions assume that you have already installed Node.js on your machine. To check its presence, open the terminal and type these two commands:

node --version
## ≥ 18.20

npm --version
## ≥ 9

If you see errors or if the displayed versions are too old, follow the instructions on nodejs.org to download this software. By installing Node.js you also get NPM, so there is no need to obtain it separately. You might need to restart the terminal or the whole machine to see the new versions.

Global install

The easiest way to get started with Prettier and its Elm plugin is to globally install two NPM packages:

npm install --global prettier@2 prettier-plugin-elm

Global install is preferred in simple scenarios, especially when you are working alone on small projects.

Prettier v3 does has dropped support for automatic plugin search so we need to install prettier@2 globally. If you want to use Prettier v3, you need to install it locally and mention prettier-plugin-elm in the config file.

Local install

When collaborating on a group project, it is useful to keep versions of Prettier and its Elm plugin in sync within the team. This avoids frequent unwanted changes in source files, which can be caused by formatting differences between tool versions.

1. Open a terminal and ensure you are located at the root of your project:

   pwd
   ## prints something like /path/to/my/project
   

2. If there is no package.json file in your project directory, initialize it:

   ## if you use npm
   npm init --yes
   

   ## if you use pnpm
   pnpm init --yes
   

   ## if you use yarn
   yarn init --yes
   

3. Run the install command:

   ## if you use npm
   npm install --only=dev prettier prettier-plugin-elm
   

   ## if you use pnpm
   pnpm add --dev prettier prettier-plugin-elm
   

   ## if you use yarn
   yarn add --dev prettier prettier-plugin-elm
   

   Versions of Prettier and its Elm plugin will be written to package.json and package-lock.json / pnpm-lock.yaml / yarn.lock. If you share these files with the rest of your source code, others will be able to get the exact same versions of the tools by running:

   ## if you use npm
   npm install
   

   ## if you use pnpm
   pnpm install
   

   ## if you use yarn
   yarn install
   

4. Mention the plugin in the config file:

   1. Create a file named .prettierrc.json in the root of your project. If you already have this file, open it instead. Note that it can be called differently because Prettier supports several config file names.

   2. Add the following content to the file:

      {
        "plugins": ["prettier-plugin-elm"]
      }
      

      This tells Prettier to use the Elm plugin when formatting files.…