# vs-shell-format

**Repository Path**: mirrors_opencollective/vs-shell-format

## Basic Information

- **Project Name**: vs-shell-format
- **Description**: the shellscript、Dockerfile、properties ...... format extension
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# <a class="github-button" href="https://github.com/foxundermoon/vs-shell-format" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star foxundermoon/vs-shell-format on GitHub">star 🚀 ⭐️ ⭐️ ⭐️ ⭐️ ⭐️</a>

<a class="github-button" href="https://github.com/foxundermoon/vs-shell-format/issues" data-icon="octicon-issue-opened" data-size="large" data-show-count="true" aria-label="Issue foxundermoon/vs-shell-format on GitHub">Issue</a>

[Get it on the VS Code Marketplace!](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format)

# supported file types or languages

| language    | extension                | describe              |
| ----------- | ------------------------ | --------------------- |
| shellscript | .sh .bash                | shell script files    |
| dockerfile  | Dockerfile               | docker files          |
| ignore      | .gitignore .dockerignore | ignore files          |
| properties  | .properties              | java properties files |
| jvmoptions  | .vmoptions , jvm.options | jvm options file      |
| hosts       | /etc/hosts               | hosts file            |

---

|                                                                                              |                                                                                                  |                                                                                               |                                                                                             |
| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| ![version](https://vsmarketplacebadge.apphb.com/version-short/foxundermoon.shell-format.svg) | ![donwloads](https://vsmarketplacebadge.apphb.com/downloads-short/foxundermoon.shell-format.svg) | ![install](https://vsmarketplacebadge.apphb.com/installs-short/foxundermoon.shell-format.svg) | ![ratings](https://vsmarketplacebadge.apphb.com/rating-short/foxundermoon.shell-format.svg) |
| ![LICENSE](https://img.shields.io/badge/license-mit-blue.svg)                                | ![LICENSE](https://img.shields.io/badge/license-Anti%20996-blue.svg)                             | ![star](https://img.shields.io/github/stars/foxundermoon/vs-shell-format.svg)                 | ![forks](https://img.shields.io/github/forks/foxundermoon/vs-shell-format.svg)              |

---

|                                                                                                                 build                                                                                                                  |                                                                                                                release                                                                                                                 |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [![Build Status](https://foxundermoon.visualstudio.com/vs-shell-format/_apis/build/status/vs-shell-format-CI?branchName=master)](https://foxundermoon.visualstudio.com/vs-shell-format/_build/latest?definitionId=1&branchName=master) | [![release Status](https://dev.azure.com/foxundermoon/vs-shell-format/_apis/build/status/vs-shell-format-deploy?branchName=master)](https://dev.azure.com/foxundermoon/vs-shell-format/_build/latest?definitionId=4&branchName=master) |

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/vs-shell-format/community)

---

![screenshot](https://github.com/foxundermoon/vs-shell-format/raw/master/image/shell_format.gif)

## usage

<kbd>shift</kbd>+<kbd>option</kbd>+<kbd>f</kbd>

<kbd>shift</kbd>+<kbd>command</kbd>+<kbd>p</kbd> then type `Format Document`

## dependencies

- [shfmt](https://github.com/mvdan/sh#shfmt)

## custom configuration

- `shellformat.path`the shfmt fullpath example [mac,linux]: `/usr/local/bin/shfmt` [windows]: `C:\\bin\\shfmt.exe`
- `shellformat.flag`shfmt -h to see detailed usage.

---

## Links

### [self source code](https://github.com/foxundermoon/vs-shell-format)

### [shfmt](https://github.com/mvdan/sh)

**Enjoy shellscript!**