diff --git a/.gitignore b/.gitignore new file mode 100644 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.phutil_module_cache diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +Linter for shellcheck + +ShellCheck is a comprehensive linter for shell scripts to highlight +syntax issues, seantic problems and more subtle caveats, to avoid +scripts to behave counter-intuitively or stop to work in some odd +conditions. + +For more information about ShellCheck, see http://www.shellcheck.net/ + +**REQUIREMENTS** + +This library requires Arcanist and ShellCheck installed. + +**INSTALLATION** + +Clone this repository or deploy to the same folder where you've +arcanist and libphutil. For example if they live in /opt/phabricator +you should deploy this as /opt/phabricator/shellcheck-linter. + +**USE** + +1. Add to your .arcconfig the requirements to load the extra library: + +```lang=json + "load": [ + "shellcheck-linter" + ] +``` + +Replace the absolute value by a relative path to the folder +if you aren't able to install globally as instructed above: + +```lang=json + "load": [ + "./vendor/shellcheck-linter" + ] +``` + +2. Configure .arclint to lint shell: + +``` +{ + "linters": { + "shell": { + "type": "shellcheck", + "include": [ + "(\\.sh$)" + ] + } + } +} +``` + +**TIPS** + +As Arcanist currently doesn't detect file formats or doesn't parse +shebangs, you can find useful to enforce a convention scripts MUST +be appended by an extension like .py .sh in your repository. +This may be more convenient for other CI tasks too. + +That doesn't mean you have to install them with the extension, both +cp and install commands are happy to accept an arbitray filename as +target, including a target without the extension. + +**LICENSE** + +This linter for Arcanist is released under the Apache 2.0 license. diff --git a/__phutil_library_init__.php b/__phutil_library_init__.php new file mode 100644 --- /dev/null +++ b/__phutil_library_init__.php @@ -0,0 +1,3 @@ +<?php + +phutil_register_library('shellcheck-linter', __FILE__); diff --git a/__phutil_library_map__.php b/__phutil_library_map__.php new file mode 100644 --- /dev/null +++ b/__phutil_library_map__.php @@ -0,0 +1,18 @@ +<?php + +/** + * This file is automatically generated. Use 'arc liberate' to rebuild it. + * + * @generated + * @phutil-library-version 2 + */ +phutil_register_library_map(array( + '__library_version__' => 2, + 'class' => array( + 'ArcanistShellCheckLinter' => 'lint/linter/ArcanistShellCheckLinter.php', + ), + 'function' => array(), + 'xmap' => array( + 'ArcanistShellCheckLinter' => 'ArcanistExternalLinter', + ), +)); diff --git a/lint/linter/ArcanistShellCheckLinter.php b/lint/linter/ArcanistShellCheckLinter.php new file mode 100644 --- /dev/null +++ b/lint/linter/ArcanistShellCheckLinter.php @@ -0,0 +1,141 @@ +<?php + +final class ArcanistShellCheckLinter extends ArcanistExternalLinter { + + private $shell; + + public function getInfoName() { + return 'ShellCheck'; + } + + public function getInfoURI() { + return 'http://www.shellcheck.net/'; + } + + public function getInfoDescription() { + return pht( + 'ShellCheck is a static analysis and linting tool for %s scripts.', + 'sh/bash'); + } + + public function getLinterName() { + return 'SHELLCHECK'; + } + + public function getLinterConfigurationName() { + return 'shellcheck'; + } + + public function getLinterConfigurationOptions() { + $options = array( + 'shellcheck.shell' => array( + 'type' => 'optional string', + 'help' => pht( + 'Specify shell dialect (%s, %s, %s, %s).', + 'bash', + 'sh', + 'ksh', + 'zsh'), + ), + ); + + return $options + parent::getLinterConfigurationOptions(); + } + + public function setLinterConfigurationValue($key, $value) { + switch ($key) { + case 'shellcheck.shell': + $this->setShell($value); + return; + + default: + return parent::setLinterConfigurationValue($key, $value); + } + } + + public function setShell($shell) { + $this->shell = $shell; + return $this; + } + + public function getDefaultBinary() { + return 'shellcheck'; + } + + public function getInstallInstructions() { + return pht( + 'Install ShellCheck with `%s`.', + 'cabal install shellcheck'); + } + + protected function getMandatoryFlags() { + $options = array(); + + $options[] = '--format=checkstyle'; + + if ($this->shell) { + $options[] = '--shell='.$this->shell; + } + + return $options; + } + + public function getVersion() { + list($stdout, $stderr) = execx( + '%C --version', $this->getExecutableCommand()); + + $matches = null; + if (preg_match('/^version: (\d(?:\.\d){2})$/', $stdout, $matches)) { + return $matches[1]; + } + + return null; + } + + protected function parseLinterOutput($path, $err, $stdout, $stderr) { + $report_dom = new DOMDocument(); + $ok = @$report_dom->loadXML($stdout); + + if (!$ok) { + return false; + } + + $files = $report_dom->getElementsByTagName('file'); + $messages = array(); + + foreach ($files as $file) { + foreach ($file->getElementsByTagName('error') as $child) { + $code = str_replace('ShellCheck.', '', $child->getAttribute('source')); + + $message = id(new ArcanistLintMessage()) + ->setPath($path) + ->setLine($child->getAttribute('line')) + ->setChar($child->getAttribute('column')) + ->setCode($code) + ->setDescription($child->getAttribute('message')); + + switch ($child->getAttribute('severity')) { + case 'error': + $message->setSeverity(ArcanistLintSeverity::SEVERITY_ERROR); + break; + + case 'warning': + $message->setSeverity(ArcanistLintSeverity::SEVERITY_WARNING); + break; + + case 'info': + $message->setSeverity(ArcanistLintSeverity::SEVERITY_ADVICE); + break; + + default: + $message->setSeverity(ArcanistLintSeverity::SEVERITY_ERROR); + break; + } + + $messages[] = $message; + } + } + + return $messages; + } +}