prettier-plugin-sh

v0.14.0

An opinionated `shellscript` formatter plugin for Prettier, also support simple format of `Dockerfile`, `properties`, `gitignore`, `dotenv`, `hosts`, `jvmoptions`... For more information about how to use this package see README

Latest version published 11 months ago

License: MIT

NPM

GitHub

Package Health Score

77 / 100

security
No known security issues
popularity
Popular
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.14.0	\|	01/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.13.1	\|	07/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.12.8	\|	07/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.11.0	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.10.2	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (205,171)

GitHub Stars: 279
Forks: 26
Contributors: 20

Direct Usage Popularity

The npm package prettier-plugin-sh receives a total of 205,171 downloads a week. As such, we scored prettier-plugin-sh popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package prettier-plugin-sh, we found that it has been starred 279 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: Yes

With more than 10 contributors for the prettier-plugin-sh repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like prettier-plugin-sh is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 11
Open PR: 2
Last Release: 11 months ago
Last Commit: 21 days ago

Further analysis of the maintenance status of prettier-plugin-sh based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that prettier-plugin-sh demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=16.0.0

Age: 5 years
Dependencies: 2 Direct
Versions: 42
Install Size: 50.7 kB
Dist-tags: 2
# of Files: 10
Maintainers: 2
TS Typings: Yes

prettier-plugin-sh has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

prettier-plugin-sh

> An opinionated shellscript formatter plugin for Prettier, also support simple format of Dockerfile, properties, gitignore, dotenv, hosts, jvmoptions...

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 (v16.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 must be added to .prettierrc:

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

Then:

# 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

  // use `sh-syntax` instead
  experimentalWasm: boolean
}

More details on godoc

Backers

1stG	RxTS	UnTS

Changelog

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

License

prettier-plugin-sh dependencies

mvdan-sh sh-syntax

FAQs

What is prettier-plugin-sh?

An opinionated `shellscript` formatter plugin for Prettier, also support simple format of `Dockerfile`, `properties`, `... Visit Snyk Advisor to see a full health score report for prettier-plugin-sh, including popularity, security, maintenance & community analysis.

Is prettier-plugin-sh popular?

The npm package prettier-plugin-sh receives a total of 205,171 weekly downloads. As such, prettier-plugin-sh popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is prettier-plugin-sh well maintained?

We found indications that prettier-plugin-sh maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is prettier-plugin-sh safe to use?

The npm package prettier-plugin-sh was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 16 December-2024, at 09:36 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (205,171)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

prettier-plugin-sh

Notice

Requirements

Install

Usage

Parser Options

Sponsors

Backers

Changelog

License

prettier-plugin-sh dependencies

FAQs

What is prettier-plugin-sh?

Is prettier-plugin-sh popular?

Is prettier-plugin-sh well maintained?

Is prettier-plugin-sh safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues