https://github.com/foxundermoon/vs-shell-format

the shellscript、Dockerfile、properties ...... format extension
https://github.com/foxundermoon/vs-shell-format

bash-format dockerfile dotenv hosts hostsfile properties shell-extension shell-format shfmt vmoptions vscode-extension vscode-plugin

Last synced: 11 days ago
JSON representation

the shellscript、Dockerfile、properties ...... format extension

• Host: GitHub
• URL: https://github.com/foxundermoon/vs-shell-format
• Owner: foxundermoon
• License: mit
• Created: 2017-01-05T15:18:14.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-04-01T19:10:30.000Z (13 days ago)
• Last Synced: 2025-04-02T02:56:22.699Z (13 days ago)
• Topics: bash-format, dockerfile, dotenv, hosts, hostsfile, properties, shell-extension, shell-format, shfmt, vmoptions, vscode-extension, vscode-plugin
• Language: Shell
• Homepage:
• Size: 5.29 MB
• Stars: 477
• Watchers: 8
• Forks: 56
• Open Issues: 65
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome - foxundermoon/vs-shell-format - the shellscript、Dockerfile、properties ...... format extension (Shell)

README

        
[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            |

| bats        | .bats                    | Bats test file        |

---

|                                                                                                                                                                                                                                   |                                                                                                              |                                                                                                            |                                                                                                                |

| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |

| ![version](https://img.shields.io/visual-studio-marketplace/v/foxundermoon.shell-format?style=flat-square)                                                                                                                        | ![downloads](https://img.shields.io/visual-studio-marketplace/d/foxundermoon.shell-format?style=flat-square) | ![install](https://img.shields.io/visual-studio-marketplace/i/foxundermoon.shell-format?style=flat-square) | ![ratings](https://img.shields.io/visual-studio-marketplace/stars/foxundermoon.shell-format?style=flat-square) |

| [![Financial Contributors on Open Collective](https://opencollective.com/vsformat/all/badge.svg?label=financial+contributors)](https://opencollective.com/vsformat) ![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                                                                                   |

| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

| [![CI](https://github.com/foxundermoon/vs-shell-format/actions/workflows/CI.yml/badge.svg)](https://github.com/foxundermoon/vs-shell-format/actions/workflows/CI.yml) | [![RELEASE](https://github.com/foxundermoon/vs-shell-format/actions/workflows/CD.yml/badge.svg)](https://github.com/foxundermoon/vs-shell-format/actions/workflows/CD.yml) |

[![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

shift+option+f

shift+command+p 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

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

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

**Enjoy shellscript!**

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].



### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/vsformat/contribute)]

#### Individuals



#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/vsformat/contribute)]