prettier-plugin-sh
An opinionated `shellscript、Dockerfile、properties、gitignore、dotenv、hosts、jvmoptions...` formatter plugin for Prettier
Last updated 24 days ago by i1stg .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install prettier-plugin-sh 
SYNC missed versions from official npm registry.

prettier-plugin-sh npm bundle size npm bundle size

An opinionated shellscript、Dockerfile、properties、gitignore、dotenv、hosts、jvmoptions... formatter plugin for Prettier

Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing, taking various rules into account.

This plugin adds support for a lot of files through mvdan-sh.

Notice

This plugin is still under development, its printer just wraps mvdan-sh's default printer. Of course it should just work, but may not match prettier's format sometimes.

Requirements

prettier-plugin-sh is an evergreen module. ???? This module requires an LTS Node version (v8.0.0+).

Install

Using npm:

# npm
npm i -D prettier prettier-plugin-sh

# yarn
yarn add -D prettier prettier-plugin-sh

Usage

Once installed, Prettier plugins should be automatically recognized by Prettier. To use this plugin, confirm that it's installed and run Prettier using your preferred method. For example:

# npx
npx prettier --write script.sh

# yarn
yarn prettier --write script.sh

Parser Options

interface ShOptions {
  // parser
  keepComments: boolean // default `true`
  stopAt: string
  variant: LangVariant

  // printer
  indent: number
  binaryNextLine: boolean // default `true`
  switchCaseIndent: boolean
  spaceRedirects: boolean
  keepPadding: boolean
  minify: boolean
  functionNextLine: boolean
}

More details on godoc

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

MIT © JounQin@1stG.me

Current Tags

  • 0.6.0                                ...           latest (24 days ago)

15 Versions

  • 0.6.0                                ...           24 days ago
  • 0.5.0                                ...           2 months ago
  • 0.4.0                                ...           5 months ago
  • 0.3.2                                ...           5 months ago
  • 0.3.1                                ...           5 months ago
  • 0.3.0                                ...           6 months ago
  • 0.2.8                                ...           8 months ago
  • 0.2.7                                ...           8 months ago
  • 0.2.6                                ...           8 months ago
  • 0.2.4                                ...           10 months ago
  • 0.2.3                                ...           10 months ago
  • 0.2.2                                ...           a year ago
  • 0.2.1                                ...           a year ago
  • 0.2.0                                ...           a year ago
  • 0.1.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 48
This Month 157
Last Day 7
Last Week 46
Last Month 357
Dependencies (1)
Dev Dependencies (0)
None

Copyright 2014 - 2016 © taobao.org |