├── .dockerignore ├── .gitignore ├── .markdownlint.json ├── .yamllint ├── .circleci └── config.yml ├── hooks └── build ├── Dockerfile ├── Makefile ├── README.md └── LICENSE /.dockerignore: -------------------------------------------------------------------------------- 1 | * 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # IntelliJ 2 | .idea/ 3 | -------------------------------------------------------------------------------- /.markdownlint.json: -------------------------------------------------------------------------------- 1 | { 2 | "line-length": false 3 | } 4 | -------------------------------------------------------------------------------- /.yamllint: -------------------------------------------------------------------------------- 1 | extends: default 2 | 3 | rules: 4 | document-start: disable 5 | -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | # https://circleci.com/docs/2.0/building-docker-images/ 2 | version: 2 3 | jobs: 4 | build: 5 | machine: true 6 | steps: 7 | - checkout 8 | - run: 9 | name: Install requirements 10 | command: make install 11 | - run: 12 | name: Lint code 13 | command: make lint 14 | - run: 15 | name: Build docker image 16 | command: make build 17 | -------------------------------------------------------------------------------- /hooks/build: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # https://docs.docker.com/docker-cloud/builds/advanced/ 4 | 5 | set -x 6 | 7 | BUILD_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ") 8 | VCS_REF=$(git rev-parse --short HEAD) 9 | VERSION=${DOCKER_TAG} 10 | REPO_NAME=$(echo "${DOCKER_REPO}" | cut -d / -f 2,3) 11 | 12 | docker build \ 13 | --build-arg BUILD_DATE="${BUILD_DATE}" \ 14 | --build-arg VCS_REF="${VCS_REF}" \ 15 | --build-arg VERSION="${VERSION}" \ 16 | --build-arg REPO_NAME="${REPO_NAME}" \ 17 | -t "${IMAGE_NAME}" . 18 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | ARG SRC_PATH=/go/src/mvdan.cc/sh 2 | 3 | FROM golang:alpine AS builder 4 | 5 | ARG MODULE_VERSION=2.6.4 6 | 7 | ARG GITHUB_URI=https://github.com/mvdan/sh.git 8 | ARG BUILD_DIR=./cmd/shfmt 9 | ARG SRC_PATH 10 | 11 | WORKDIR ${SRC_PATH} 12 | 13 | # https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds 14 | RUN set -x && \ 15 | apk add --no-cache git=2.20.1-r0 && \ 16 | git clone ${GITHUB_URI} ./ && \ 17 | git fetch origin v${MODULE_VERSION} && \ 18 | git checkout -b tag-${MODULE_VERSION} refs/tags/v${MODULE_VERSION} && \ 19 | CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -ldflags="-s -w" ${BUILD_DIR} 20 | 21 | 22 | FROM scratch 23 | 24 | # Build-time metadata as defined at http://label-schema.org 25 | ARG BUILD_DATE 26 | ARG VCS_REF 27 | ARG VERSION 28 | ARG REPO_NAME 29 | LABEL org.label-schema.vendor="tmknom" \ 30 | org.label-schema.name=$REPO_NAME \ 31 | org.label-schema.description="Format shell script." \ 32 | org.label-schema.build-date=$BUILD_DATE \ 33 | org.label-schema.version=$VERSION \ 34 | org.label-schema.vcs-ref=$VCS_REF \ 35 | org.label-schema.vcs-url="https://github.com/$REPO_NAME" \ 36 | org.label-schema.usage="https://github.com/$REPO_NAME/blob/master/README.md#usage" \ 37 | org.label-schema.docker.cmd="docker run --rm -v \$PWD:/work $REPO_NAME -i 2 -ci -kp foo.sh" \ 38 | org.label-schema.schema-version="1.0" 39 | 40 | ARG SRC_PATH 41 | COPY --from=builder ${SRC_PATH}/shfmt /shfmt 42 | 43 | WORKDIR /work 44 | ENTRYPOINT ["/shfmt"] 45 | CMD ["--help"] 46 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .DEFAULT_GOAL := help 2 | 3 | # https://gist.github.com/tadashi-aikawa/da73d277a3c1ec6767ed48d1335900f3 4 | .PHONY: $(shell grep -E '^[a-zA-Z_-]+:' $(MAKEFILE_LIST) | sed 's/://') 5 | 6 | 7 | # Constant definitions 8 | REPO_NAME := tmknom/shfmt 9 | DOCKER_REPO := index.docker.io/${REPO_NAME} 10 | IMAGE_TAG := latest 11 | IMAGE_NAME := $(shell echo ${DOCKER_REPO} | cut -d / -f 2,3):${IMAGE_TAG} 12 | 13 | # Macro definitions 14 | define list_shellscript 15 | grep '^#!' -rn . | grep ':1:#!' | cut -d: -f1 | grep -v .git 16 | endef 17 | 18 | # Phony Targets 19 | install: ## Install requirements 20 | @type docker >/dev/null 2>&1 || (echo "ERROR: docker not found (brew install docker)"; exit 1) 21 | docker pull hadolint/hadolint 22 | docker pull tmknom/markdownlint 23 | docker pull koalaman/shellcheck 24 | docker pull tmknom/shfmt 25 | docker pull tmknom/prettier 26 | docker pull tmknom/yamllint 27 | 28 | build: ## Build docker image 29 | DOCKER_REPO=${DOCKER_REPO} DOCKER_TAG=${IMAGE_TAG} IMAGE_NAME=${IMAGE_NAME} hooks/build 30 | docker images ${REPO_NAME} 31 | 32 | lint: lint-dockerfile lint-shellscript lint-markdown lint-yaml ## Lint code 33 | 34 | lint-dockerfile: 35 | docker run --rm -i hadolint/hadolint < Dockerfile 36 | 37 | lint-shellscript: 38 | $(call list_shellscript) | xargs -I {} docker run --rm -v "$(CURDIR):/mnt" koalaman/shellcheck {} 39 | 40 | lint-markdown: 41 | docker run --rm -i -v "$(CURDIR):/work" tmknom/markdownlint 42 | 43 | lint-yaml: 44 | docker run --rm -v "$(CURDIR):/work" tmknom/yamllint --strict . 45 | 46 | format: format-shellscript format-markdown format-json format-yaml ## Format code 47 | 48 | format-shellscript: 49 | $(call list_shellscript) | xargs -I {} docker run --rm -v "$(CURDIR):/work" -w /work tmknom/shfmt -i 2 -ci -kp -w {} 50 | 51 | format-markdown: 52 | docker run --rm -v "$(CURDIR):/work" tmknom/prettier --parser=markdown --write '**/*.md' 53 | 54 | format-json: 55 | docker run --rm -v "$(CURDIR):/work" tmknom/prettier --parser=json --write '**/*.json' 56 | 57 | format-yaml: 58 | docker run --rm -v "$(CURDIR):/work" tmknom/prettier --parser=yaml --write '**/*.y*ml' 59 | 60 | 61 | # https://postd.cc/auto-documented-makefile/ 62 | help: ## Show help 63 | @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' 64 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # shfmt 2 | 3 | [![CircleCI](https://circleci.com/gh/tmknom/shfmt.svg?style=svg)](https://circleci.com/gh/tmknom/shfmt) 4 | [![Docker Build Status](https://img.shields.io/docker/cloud/build/tmknom/shfmt.svg)](https://hub.docker.com/r/tmknom/shfmt/builds/) 5 | [![Docker Automated build](https://img.shields.io/docker/cloud/automated/tmknom/shfmt.svg)](https://hub.docker.com/r/tmknom/shfmt/) 6 | [![MicroBadger Size](https://img.shields.io/microbadger/image-size/tmknom/shfmt.svg)](https://microbadger.com/images/tmknom/shfmt) 7 | [![MicroBadger Layers](https://img.shields.io/microbadger/layers/tmknom/shfmt.svg)](https://microbadger.com/images/tmknom/shfmt) 8 | [![License](https://img.shields.io/github/license/tmknom/shfmt.svg)](https://opensource.org/licenses/Apache-2.0) 9 | 10 | Format shell script based on Docker. 11 | 12 | This is [shfmt](https://github.com/mvdan/sh) wrapper. 13 | 14 | ## Requirements 15 | 16 | - [Docker](https://www.docker.com/) 17 | 18 | ## Usage 19 | 20 | ### Format a file 21 | 22 | ```sh 23 | docker run --rm -v $PWD:/work tmknom/shfmt foo.sh 24 | ``` 25 | 26 | ### Format all .sh extension 27 | 28 | Use `-w` to write result to file instead of stdout. 29 | 30 | ```sh 31 | docker run --rm -v $PWD:/work tmknom/shfmt -w **/*.sh 32 | ``` 33 | 34 | ### Format Google's Shell Style Guide 35 | 36 | Use `-i N` to indent with a number of spaces instead of tabs. 37 | Get the formatting appropriate for [Google's Shell Style Guide](https://google.github.io/styleguide/shell.xml). 38 | 39 | ```sh 40 | docker run --rm -v $PWD:/work tmknom/shfmt -i 2 -ci -w **/*.sh 41 | ``` 42 | 43 | ### Help 44 | 45 | For details, refer to [mvdan/sh](https://github.com/mvdan/sh). 46 | 47 | ```sh 48 | docker run --rm -v $PWD:/work tmknom/shfmt 49 | ``` 50 | 51 | ## Makefile targets 52 | 53 | ```text 54 | build Build docker image 55 | format Format code 56 | help Show help 57 | install Install requirements 58 | lint Lint code 59 | ``` 60 | 61 | ## Development 62 | 63 | ### Installation 64 | 65 | ```shell 66 | git clone git@github.com:tmknom/shfmt.git 67 | cd shfmt 68 | make install 69 | ``` 70 | 71 | ### Deployment 72 | 73 | Automatically deployed by "[DockerHub Automated Build](https://docs.docker.com/docker-hub/builds/)" after merge. 74 | 75 | ### Deployment Pipeline 76 | 77 | 1. GitHub - Version Control System 78 | - 79 | 2. CircleCI - Continuous Integration 80 | - 81 | 3. Docker Hub - Docker Registry 82 | - 83 | 4. MicroBadger - Docker Inspection 84 | - 85 | 86 | ## License 87 | 88 | Apache 2 Licensed. See LICENSE for full details. 89 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------