prettier-plugin-elm weekly downloads statistics

Prettier Elm plugin

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,

elm import Html exposing (text)

main = text "Hello, World!" `

becomes:

elm import Html exposing (text)

main = text "Hello, World!" `

You can disable code formatting for a particular code block by adding before markdown Elm code with custom formatting:

Prettified code:

sh node --version

≥ 18.20

npm --version

≥ 9

sh npm install --global prettier@2 prettier-plugin-elm sh pwd ## prints something like /path/to/my/project sh ## if you use npm npm init --yes sh ## if you use pnpm pnpm init --yes sh ## if you use yarn yarn init --yes sh ## if you use npm npm install --only=dev prettier prettier-plugin-elm sh ## if you use pnpm pnpm add --dev prettier prettier-plugin-elm sh ## if you use yarn yarn add --dev prettier prettier-plugin-elm sh ## if you use npm npm install sh ## if you use pnpm pnpm install sh ## if you use yarn yarn install json { "plugins": ["prettier-plugin-elm"] } sh

if you use npm

• Lint (i.e. check) if all source files are formatted

npm run lint:prettier

• Fix formatting in all files

npm run fix:prettier sh

if you use pnpm

• Lint (i.e. check) if all source files are formatted

pnpm run lint:prettier

• Fix formatting in all files

pnpm run fix:prettier sh

if you use yarn

Lint (i.e. check) if all source files are formatted

yarn lint:prettier

Fix formatting in all files

yarn fix:prettier ```

Implementation details

This plugin is written in TypeScript. The quality of the codebase is checked using Prettier, Jest and ESLint via Github Actions. Tests run on Linux, macOS and Windows.

Unlike most other Prettier plugins, prettier-plugin-elm does not contain logic to parse code blocks into syntax trees to then stringify them. Both of these tasks are delegated to elm-format by making a call to a sub-process. Thus, the result of formatting is compatible with what Elm community is used to see.

The only difference to elm-format introduced by prettier-plugin-elm is related to handling fragments of Elm modules, which is not supported upstream yet. See src/parser.ts for details on the workaround.

Contributing

If you’re interested in contributing to the development of Prettier Elm plugin, please follow the CONTRIBUTING guide from Prettier as it all applies to this repository too.

To run the development version of prettier-plugin-elm:

• Clone this repository • Ensure pnpm is installed on your machine (any version above v10.0 will work) • Run pnpm install • Run pnpm lint to make sure that the codebase passes linting • Run pnpm test to make sure that TypeScript successfully compiles into JavaScript and and all unit tests pass • To test the plugin manually, create a file named prettier-test.elm (or .md). Then run pnpm prettier --ignore-path= --plugin=./dist/main.js prettier-test.elm (or .md) and check the output.

Credits

This project was inspired by . Big thanks to Aaron VonderHaar (@avh4) and contributors for creating elm-format!

Description from the npm listing.