Downloads:
3,508
Downloads of v 3.9.0:
416
Last Update:
22 Aug 2024
Package Maintainer(s):
Software Author(s):
- mvdan
Tags:
sh bash formatter go- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Shfmt
- 1
- 2
- 3
3.9.0 | Updated: 22 Aug 2024
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
3,508
Downloads of v 3.9.0:
416
Maintainer(s):
Software Author(s):
- mvdan
Shfmt 3.9.0
Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by mvdan. The inclusion of mvdan trademark(s), if any, upon this webpage is solely to identify mvdan goods or services and not for commercial purposes.
- 1
- 2
- 3
Some Checks Have Failed or Are Not Yet Complete
Not All Tests Have Passed
Deployment Method: Individual Install, Upgrade, & Uninstall
To install Shfmt, run the following command from the command line or from PowerShell:
To upgrade Shfmt, run the following command from the command line or from PowerShell:
To uninstall Shfmt, run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download shfmt --internalize --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade shfmt -y --source="'INTERNAL REPO URL'" [other options]
See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade shfmt -y --source="'INTERNAL REPO URL'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install shfmt
win_chocolatey:
name: shfmt
version: '3.9.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'shfmt' do
action :install
source 'INTERNAL REPO URL'
version '3.9.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller shfmt
{
Name = "shfmt"
Version = "3.9.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'shfmt':
ensure => '3.9.0',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
Private CDN cached downloads available for licensed customers. Never experience 404 breakages again! Learn more...
This package was approved as a trusted package on 30 Sep 2024.
Shfmt
SYNOPSIS
shfmt [flags] [path...]
DESCRIPTION
shfmt formats shell programs. If the only argument is a dash (-) or no
arguments are given, standard input will be used. If a given path is a
directory, all shell scripts found under that directory will be used.
If any EditorConfig files are found, they will be used to apply formatting
options. If any parser or printer flags are given to the tool, no EditorConfig
files will be used. A default like -i=0
can be used for this purpose.
shfmt's default shell formatting was chosen to be consistent, common, and
predictable. Some aspects of the format can be configured via printer flags.
OPTIONS
Generic flags
-version
-
Show version and exit.
-l
-
List files whose formatting differs from shfmt's.
-w
-
Write result to file instead of stdout.
-d
-
Error with a diff when the formatting differs.
The diff uses color when the output is a terminal.
To never use color, set a non-empty *NO_COLOR* or *TERM=dumb*.
To always use color, set a non-empty *FORCE_COLOR*.
-s
-
Simplify the code.
-mn
-
Minify the code to reduce its size (implies -s
).
Parser flags
-ln<str>
-
Language dialect (bash/posix/mksh/bats, default auto).
When set to *auto*, the language is detected from the input filename,
as long as it has a shell extension like *foo.mksh*. Otherwise, if the input
begins with a shell shebang like *#!/bin/sh*, that's used instead.
If neither come up with a result, *bash* is used as a fallback.
The filename extension *.sh* is a special case: it implies *posix*,
but may be overriden by a valid shell shebang.
-p
-
Shorthand for -ln=posix
.
-filename
str -
Provide a name for the standard input file.
Printer flags
-i <uint>
-
Indent: 0 for tabs (default), >0 for number of spaces.
-bn
-
Binary ops like && and | may start a line.
-ci
-
Switch cases will be indented.
-sr
-
Redirect operators will be followed by a space.
-kp
-
Keep column alignment paddings.
-fn
-
Function opening braces are placed on a separate line.
Utility flags
-f
Recursively find all shell files and print the paths.
-tojson
Print syntax tree to stdout as a typed JSON.
EXAMPLES
Format all the scripts under the current directory, printing which are modified:
shfmt -l -w .
For CI, one can use a variant where formatting changes are just shown as diffs:
shfmt -d .
The following formatting flags closely resemble Google's shell style defined in
<https://google.github.io/styleguide/shell.xml>:
shfmt -i 2 -ci -bn
Below is a sample EditorConfig file as defined by <https://editorconfig.org/>
,
showing how to set any option:
[*.sh]
# like -i=4
indent_style = space
indent_size = 4
shell_variant = posix # like -ln=posix
binary_next_line = true # like -bn
switch_case_indent = true # like -ci
space_redirects = true # like -sr
keep_padding = true # like -kp
function_next_line = true # like -fn
# Ignore the entire "third_party" directory.
[third_party/**]
ignore = true
shfmt can also replace bash -n to check shell scripts for syntax errors. It is
more exhaustive, as it parses all syntax statically and requires valid UTF-8:
$ echo '${foo:1 2}' | bash -n
$ echo '${foo:1 2}' | shfmt >/dev/null
1:9: not a valid arithmetic operator: 2
$ echo 'foo=(1 2)' | bash --posix -n
$ echo 'foo=(1 2)' | shfmt -p >/dev/null
1:5: arrays are a bash feature
Log in or click on link to see number of positives.
- shfmt.3.9.0.nupkg (898f231d51fa) - ## / 69
- shfmt_v3.9.0_windows_amd64.exe (4ea136134248) - ## / 73
- shfmt_v3.9.0_windows_386.exe (61ad0af789b3) - ## / 75
In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).
Chocolatey Pro provides runtime protection from possible malware.
Add to Builder | Version | Downloads | Last Updated | Status |
---|---|---|---|---|
Shfmt 3.9.0 | 416 | Thursday, August 22, 2024 | Approved | |
Shfmt 3.8.0 | 1081 | Sunday, February 11, 2024 | Approved | |
Shfmt 3.7.0 | 1189 | Sunday, June 18, 2023 | Approved | |
Shfmt 3.6.0 | 454 | Monday, December 12, 2022 | Approved | |
Shfmt 3.5.1 | 180 | Tuesday, June 7, 2022 | Approved | |
Shfmt 3.5.0 | 84 | Wednesday, May 11, 2022 | Approved | |
Shfmt 3.4.3 | 104 | Sunday, April 10, 2022 | Approved |
Copyright (c) 2016, Daniel Martí. All rights reserved.
This package has no dependencies.
Ground Rules:
- This discussion is only about Shfmt and the Shfmt package. If you have feedback for Chocolatey, please contact the Google Group.
- This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
- The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
- Tell us what you love about the package or Shfmt, or tell us what needs improvement.
- Share your experiences with the package, or extra configuration or gotchas that you've found.
- If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.