hit-on (empty) → 0.0.0
raw patch · 11 files changed
+1407/−0 lines, 11 filesdep +ansi-terminaldep +basedep +base-noprelude
Dependencies added: ansi-terminal, base, base-noprelude, github, gitrev, hit-on, optparse-applicative, relude, shellmet, text, vector
Files
- CHANGELOG.md +12/−0
- LICENSE +373/−0
- README.md +304/−0
- app/Main.hs +9/−0
- hit-on.cabal +103/−0
- src/Hit.hs +5/−0
- src/Hit/Cli.hs +162/−0
- src/Hit/ColorTerminal.hs +92/−0
- src/Hit/Git.hs +174/−0
- src/Hit/Issue.hs +166/−0
- src/Prelude.hs +7/−0
+ CHANGELOG.md view
@@ -0,0 +1,12 @@+# Changelog++`hit-on` uses [PVP Versioning][1].+The changelog is available [on GitHub][2].++0.0.0+=====++* Initially created.++[1]: https://pvp.haskell.org+[2]: https://github.com/kowainik/hit-on/releases
+ LICENSE view
@@ -0,0 +1,373 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+ means Covered Software of a particular Contributor.++1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in+ a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.
+ README.md view
@@ -0,0 +1,304 @@+# Hit On+++[](https://hackage.haskell.org/package/hit-on)+[](LICENSE)+[](http://stackage.org/lts/package/hit-on)+[](http://stackage.org/nightly/package/hit-on)+[](https://travis-ci.org/kowainik/hit-on)++**Kowainik Git Workflow Helper Tool.**++You can find the description of the workflow here:++* [Kowainik Git Workflow](https://github.com/kowainik/org#workflow)++`hit-on` provides the `hit` binary with a convenient command-line interface to improve the interaction with [`git`][git] in a compatible way with the described working methods. It saves time for people who use this workflow on a daily basis, helps beginners expand their insight of the core VCS processes and makes collaboration between team members easier during development.++Here is an example of how you can see the list of issues and the issue description with `hit`:++++## Getting started++### Prerequisites++To start using `hit` make sure that you have the following tools installed on your machine:++* [ `git`][git] — `hit` is a wrapper around `git`++### Installation++There are several methods to install the `hit` tool. You can choose the one that you are most comfortable with.++#### Download from releases++You can download the `hit` binary directly from the GitHub releases:++* [`hit` releases](https://github.com/kowainik/hit-on/releases)++After downloading, make it executable and copy it to a convenient location, for example:++```shell+chmod +x hit-linux+mv hit-linux ~/.local/bin/hit+```++#### Build from source++> **NOTE:** the project is written in Haskell, so you need to have one of the Haskell build tools installed. See this [blog post](https://kowainik.github.io/posts/2018-06-21-haskell-build-tools) for installation and usage instructions.++You need to follow these steps:++1. Clone the repository from GitHub++ ```shell+ git clone https://github.com/kowainik/hit-on.git+ ```+2. Step into the directory++ ```shell+ cd hit-on+ ```++3. Install the project with one of the build tools+ * [Cabal](https://www.haskell.org/cabal/users-guide/)+ ```shell+ cabal new-install hit-on+ ```+ **Note:** make sure you have `~/.cabal/bin` in your $PATH+ * [Stack](https://docs.haskellstack.org/en/stable/README/)+ ```shell+ stack install hit-on+ ```+4. Make sure that `hit` is installed:++ ```shell+ hit --version+ ```++#### macOS package manager++Currently, this method of installation is not supported. See [this issue](https://github.com/kowainik/hit-on/issues/41) for more details or if you want to help.++#### Ubuntu package manager++Currently, this method of installation is not supported. See [this issue](https://github.com/kowainik/hit-on/issues/42) for more details or if you want to help.++### Setting up++Follow the steps below to configure `hit` :++1. Specify your GitHub login in the global `.gitconfig`+```shell+git config --global user.login <your_login>+```+2. **This step is only required if you want to use `hit` with private repositories**.+ 1. [Create OAuth token on GitHub.](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) The following scopes for the token should be specified:+ ++ 2. Copy the generated token.+ 3. Export token as an environment variable+ ```shell+ export GITHUB_TOKEN=<paste_generated_token_here>+ ```++## Usage++The best way to demonstrate the power of the `hit` tool on a day-to-day basis with our workflow is to go through the entire workflow step by step, solving an ordinary problem of the typical [`git`][git] user.++> Here we assume that you work with `origin` remote with the main branch set to `master`.++### hit clone++If you don't have the repository locally, you need to clone it. With the `git`+tool you would need to specify the full URL which you can get from the+repository GitHub page.++```shell+git clone git@github.com:username/project-name.git+```++`hit` can simplify this process a bit. If you want to clone the project which is+under your GitHub username you can write:++```shell+hit clone my-project+```++If this is not your personal repository then you can use `clone` command in the+following way:++```shell+hit clone owner-name/project-name+```++### hit hop++When you want to start working on a new issue, you usually want to make sure you're using the latest version of your project. As a `git` user you may use the following commands:++```shell+git checkout master+git pull --rebase --prune+```++With `hit` you can just:++```shell+hit hop+```++### hit issue++Now you need to decide which issue you want to work on. You can use the `hit issue` command to see the full list of all open issues. After choosing the number of the issue, let's say 42, call `hit issue 42` to see the details of that issue.++### hit new++Start your work in a new branch. According to our workflow, branch names should have the following form:++```+<user_login>/<issue_number>-<short_issue_description>+```++With `git` you can create a branch using the following command:++```shell+git checkout -b my-login/42-short-desc+```++`hit` allows you to accomplish this task in an easier manner:++```shell+hit new 42+```++It uses the issue title to generate a short description.++### hit commit++After finishing your work on that issue, you need to commit your changes. With `git` you would do the following:++```shell+git add .+git commit -m "[#42] Implement my feature++Resolves #42"+```++With `hit` you need only to specify the text of the commit to get the same result:++```shell+hit commit "Implement my feature"+```++Note that you don't need to keep in mind the current issue number. However, if you want to refresh the context about the issue, use the `hit current` command.++### hit push++After committing your changes locally, you need to push them to the remote repository. It's usually a good practice to push only the current branch.++The `git` command for this is a little bit verbose:++```shell+git push -u origin my-login/42-short-desc+```++`hit` allows you to save several keystrokes:++```shell+hit push+```++### hit sync++After opening the pull request, some of the reviewers suggested changes that you applied as commits to the remote branch via GitHub interface. Now you need to sync your local branch with the remote one.++With `git` you can do the following:++```shell+git pull --rebase origin my-login/42-short-desc+```++However, with `hit` you can just:++```shell+hit sync+```++### hit fresh++While you were waiting for the second round of reviews, another pull request was merged to the `master` branch. Now you need to apply the new `master` changes to your local branch.++With `git` you can do the following:++```shell+git fetch origin master+git rebase origin/master+```++Again, with `hit` you can do better:++```shell+hit fresh+```++### hit fix++Now you need to make changes to your work locally according to the code review and push them to the remote repository.++`git` requires from you to do several steps to accomplish this simple task:++```shell+git add .+git commit -m "Fix after review"+git push origin my-login/42-short-desc+```++`hit` helps you with this as well:++```shell+hit fix+```++### hit amend++Oops, you've just realised that you have made a typo in your work! So you fixed the typo. But now you want to update the remote branch without creating a new unnecessary commit.++With `git` you can do the following:++```shell+git commit -a --amend --no-edit+git push origin my-login/42-short-desc --force+```++With `hit` you can simply:++```shell+hit amend+```++### hit resolve++Hooray, your PR just got merged! It's time to clean your local repository and start working on a new issue!++With `git` you would do the following:++```shell+git checkout master+git pull --rebase --prune+git branch -D my-login/42-short-desc+```++With `hit` you can finish your work faster:++```shell+hit resolve+```++[git]: https://git-scm.com/++## Acknowledgement++Icons made by [Freepik](http://www.freepik.com) from+[www.flaticon.com](https://www.flaticon.com/) is licensed by+[CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/).
+ app/Main.hs view
@@ -0,0 +1,9 @@+module Main (main) where+++import System.IO (hSetEncoding, stdout, utf8)++import Hit (hit)++main :: IO ()+main = hSetEncoding stdout utf8 >> hit
+ hit-on.cabal view
@@ -0,0 +1,103 @@+cabal-version: 2.0+name: hit-on+version: 0.0.0+synopsis: Haskell Git Helper Tool+description: Haskell Git Helper Tool+homepage: https://github.com/kowainik/hit-on+bug-reports: https://github.com/kowainik/hit-on/issues+license: MPL-2.0+license-file: LICENSE+author: Kowainik+maintainer: xrom.xkov@gmail.com+copyright: 2019 Kowainik+category: Git, CLI Tool+build-type: Simple+extra-doc-files: README.md+ , CHANGELOG.md+tested-with: GHC == 8.6.3++source-repository head+ type: git+ location: https://github.com/kowainik/hit-on.git++library+ hs-source-dirs: src+ exposed-modules: Hit+ Hit.Cli+ Hit.ColorTerminal+ Hit.Git+ Hit.Issue++ autogen-modules: Paths_hit_on+ other-modules: Paths_hit_on+ Prelude++ build-depends: base-noprelude ^>= 4.12.0.0+ , ansi-terminal >= 0.8+ , github ^>= 0.20+ , gitrev ^>= 1.3+ , optparse-applicative ^>= 0.14+ , relude ^>= 0.4+ , shellmet >= 0.0.0+ , text+ , vector ^>= 0.12++ ghc-options: -Wall+ -Wincomplete-uni-patterns+ -Wincomplete-record-updates+ -Wcompat+ -Widentities+ -Wredundant-constraints+ -fhide-source-paths+ -Wmissing-export-lists+ -Wpartial-fields++ default-language: Haskell2010+ default-extensions: ConstraintKinds+ DeriveGeneric+ GeneralizedNewtypeDeriving+ InstanceSigs+ KindSignatures+ LambdaCase+ OverloadedStrings+ RecordWildCards+ ScopedTypeVariables+ StandaloneDeriving+ TupleSections+ TypeApplications+ ViewPatterns++executable hit+ hs-source-dirs: app+ main-is: Main.hs++ build-depends: base ^>= 4.12.0.0+ , hit-on++ ghc-options: -Wall+ -threaded+ -rtsopts+ -with-rtsopts=-N+ -Wincomplete-uni-patterns+ -Wincomplete-record-updates+ -Wcompat+ -Widentities+ -Wredundant-constraints+ -fhide-source-paths+ -Wmissing-export-lists+ -Wpartial-fields++ default-language: Haskell2010+ default-extensions: ConstraintKinds+ DeriveGeneric+ GeneralizedNewtypeDeriving+ InstanceSigs+ KindSignatures+ LambdaCase+ OverloadedStrings+ RecordWildCards+ ScopedTypeVariables+ StandaloneDeriving+ TupleSections+ TypeApplications+ ViewPatterns
+ src/Hit.hs view
@@ -0,0 +1,5 @@+module Hit+ ( module Hit+ ) where++import Hit.Cli as Hit
+ src/Hit/Cli.hs view
@@ -0,0 +1,162 @@+{-# LANGUAGE ApplicativeDo #-}+{-# LANGUAGE TemplateHaskell #-}++-- | Command line interface for @hit@ executable.++module Hit.Cli+ ( hit+ ) where++import Data.Version (showVersion)+import Development.GitRev (gitCommitDate, gitDirty, gitHash)+import Options.Applicative (Parser, ParserInfo, argument, auto, command, execParser, fullDesc, help,+ helper, info, infoOption, long, metavar, progDesc, short, strArgument,+ subparser, switch)++import Hit.ColorTerminal (arrow, blueCode, boldCode, redCode, resetCode)+import Hit.Git (getUsername, runAmend, runClone, runCommit, runCurrent, runFix, runFresh, runHop,+ runNew, runPush, runResolve, runSync)+import Hit.Issue (runIssue)++import qualified Data.Text as T+import qualified Paths_hit_on as Meta (version)+++hit :: IO ()+hit = execParser cliParser >>= \case+ Hop branchName -> runHop branchName+ Fresh branchName -> runFresh branchName+ New issueNum -> runNew issueNum+ Issue issueNum me -> if me+ then getUsername >>= runIssue issueNum . Just+ else runIssue issueNum Nothing+ Commit message noIssue -> runCommit message noIssue+ Fix message -> runFix message+ Amend -> runAmend+ Resolve branchName -> runResolve branchName+ Push isForce -> runPush isForce+ Sync -> runSync+ Current -> runCurrent >>= flip whenJust (flip runIssue Nothing . Just)+ Clone name -> runClone name++----------------------------------------------------------------------------+-- Parsers+----------------------------------------------------------------------------++-- | Main parser of the app.+cliParser :: ParserInfo HitCommand+cliParser = info ( helper <*> versionP <*> hitP )+ $ fullDesc <> progDesc "Haskell Git Helper Tool"++-- | Commands for @hit@ executable.+data HitCommand+ = Hop (Maybe Text)+ | Fresh (Maybe Text)+ | New Int+ | Issue (Maybe Int) Bool+ | Commit Text Bool+ | Fix (Maybe Text)+ | Amend+ | Resolve (Maybe Text)+ | Push Bool+ | Sync+ | Current+ | Clone Text++-- | Commands parser.+hitP :: Parser HitCommand+hitP = subparser+ $ command "hop" (info (helper <*> hopP) $ progDesc "Switch to branch and sync it")+ <> command "fresh" (info (helper <*> freshP) $ progDesc "Rebase current branch on remote one")+ <> command "new" (info (helper <*> newP) $ progDesc "Create new branch from current one")+ <> command "commit" (info (helper <*> commitP) $ progDesc "Commit all local changes and prepend issue number")+ <> command "fix" (info (helper <*> fixP) $ progDesc "Fix requested changes to the last commit")+ <> command "amend" (info (helper <*> amendP) $ progDesc "Amend changes to the last commit and force push")+ <> command "issue" (info (helper <*> issueP) $ progDesc "Show the information about the issue")+ <> command "push" (info (helper <*> pushP) $ progDesc "Push the current branch")+ <> command "sync" (info (helper <*> syncP) $ progDesc "Sync local branch with its remote")+ <> command "resolve" (info (helper <*> resolveP) $ progDesc "Switch to master, sync and delete the branch")+ <> command "current" (info (helper <*> currentP) $ progDesc "Show info about current branch and issue (if applicable)")+ <> command "clone" (info (helper <*> cloneP) $ progDesc "Clone the repo. Use 'reponame' or 'username/reponame' formats")++hopP :: Parser HitCommand+hopP = Hop <$> maybeBranchP++freshP :: Parser HitCommand+freshP = Fresh <$> maybeBranchP++newP :: Parser HitCommand+newP = New <$> issueNumP++issueP :: Parser HitCommand+issueP = do+ num <- optional issueNumP+ me <- switch+ $ long "me"+ <> short 'm'+ <> help "Assigned to me"+ pure $ Issue num me++commitP :: Parser HitCommand+commitP = do+ msg <- strArgument (metavar "COMMIT_MESSAGE")+ noIssue <- switch+ $ long "no-issue"+ <> short 'n'+ <> help "Do not add [#ISSUE_NUMBER] prefix when specified"+ pure $ Commit msg noIssue++fixP :: Parser HitCommand+fixP = Fix <$> commitMessageP++amendP :: Parser HitCommand+amendP = pure Amend++pushP :: Parser HitCommand+pushP = Push <$> switch+ ( long "force"+ <> short 'f'+ <> help "Force push"+ )++syncP :: Parser HitCommand+syncP = pure Sync++currentP :: Parser HitCommand+currentP = pure Current++resolveP :: Parser HitCommand+resolveP = Resolve <$> maybeBranchP++cloneP :: Parser HitCommand+cloneP = Clone <$> strArgument (metavar "REPOSITORY")++-- | Parse optional branch name as an argument.+maybeBranchP :: Parser (Maybe Text)+maybeBranchP = optional $ strArgument (metavar "BRANCH_NAME")++-- / Parse optional commit message as an argument+commitMessageP :: Parser (Maybe Text)+commitMessageP = optional $ strArgument (metavar "COMMIT_MESSAGE")++-- | Parse issue number as an argument.+issueNumP :: Parser Int+issueNumP = argument auto $ metavar "ISSUE_NUMBER"++-- | Show the version of the tool.+versionP :: Parser (a -> a)+versionP = infoOption hitVersion+ $ long "version"+ <> short 'v'+ <> help "Show hit's version"++hitVersion :: String+hitVersion = toString+ $ T.intercalate "\n"+ $ [sVersion, sHash, sDate] ++ [sDirty | $(gitDirty)]+ where+ blueBold txt = blueCode <> boldCode <> txt <> resetCode+ sVersion = blueBold "Hit " <> "v" <> toText (showVersion Meta.version)+ sHash = arrow <> blueBold "Git revision: " <> $(gitHash)+ sDate = arrow <> blueBold "Commit date: " <> $(gitCommitDate)+ sDirty = redCode <> "There are non-committed files." <> resetCode
+ src/Hit/ColorTerminal.hs view
@@ -0,0 +1,92 @@+-- | This module contains functions for colorful printing into terminal.++module Hit.ColorTerminal+ ( Color (..)+ , putStrFlush+ , beautyPrint+ , boldCode+ , blueCode+ , blueBg+ , bold+ , boldText+ , boldDefault+ , greenCode+ , italic+ , redCode+ , reset+ , resetCode+ , setColor+ , successMessage+ , warningMessage+ , errorMessage+ , infoMessage+ , skipMessage++ , arrow+ ) where++import System.Console.ANSI (Color (..), ColorIntensity (Dull, Vivid),+ ConsoleIntensity (BoldIntensity), ConsoleLayer (Background, Foreground),+ SGR (..), setSGR, setSGRCode)+import System.IO (hFlush)+++-- | Explicit flush ensures prompt messages are in the correct order on all systems.+putStrFlush :: Text -> IO ()+putStrFlush msg = do+ putText msg+ hFlush stdout++setColor :: Color -> IO ()+setColor color = setSGR [SetColor Foreground Vivid color]++-- | Starts bold printing.+bold :: IO ()+bold = setSGR [SetConsoleIntensity BoldIntensity]++italic :: IO ()+italic = setSGR [SetItalicized True]++-- | Resets all previous settings.+reset :: IO ()+reset = do+ setSGR [Reset]+ hFlush stdout++-- | Takes list of formatting options, prints text using this format options.+beautyPrint :: [IO ()] -> Text -> IO ()+beautyPrint formats msg = do+ sequence_ formats+ putText msg+ reset++boldText :: Text -> IO ()+boldText message = bold >> putStrFlush message >> reset++boldDefault :: Text -> IO ()+boldDefault message = boldText (" [" <> message <> "]")++colorMessage :: Color -> Text -> IO ()+colorMessage color message = do+ setColor color+ putTextLn $ " " <> message+ reset++errorMessage, warningMessage, successMessage, infoMessage, skipMessage :: Text -> IO ()+errorMessage = colorMessage Red+warningMessage = colorMessage Yellow+successMessage = colorMessage Green+infoMessage = colorMessage Blue+skipMessage = colorMessage Cyan++blueCode, greenCode, boldCode, redCode, resetCode, blueBg :: Text+redCode = toText $ setSGRCode [SetColor Foreground Vivid Red]+blueCode = toText $ setSGRCode [SetColor Foreground Vivid Blue]+greenCode = toText $ setSGRCode [SetColor Foreground Vivid Green]+boldCode = toText $ setSGRCode [SetConsoleIntensity BoldIntensity]+resetCode = toText $ setSGRCode [Reset]+blueBg = toText $ setSGRCode [SetColor Foreground Dull White, SetColor Background Dull Blue]++-- | Arrow symbol+arrow :: Text+arrow = " ➤ "
+ src/Hit/Git.hs view
@@ -0,0 +1,174 @@+{-# LANGUAGE ViewPatterns #-}++-- | Logic for CLI commands to make GitHub workflows easier.++module Hit.Git+ ( runHop+ , runFresh+ , runNew+ , runPush+ , runResolve+ , runCommit+ , runFix+ , runAmend+ , runSync+ , runCurrent+ , runClone++ , getUsername+ ) where++import Data.Char (isAlphaNum, isDigit, isSpace)+import Shellmet (($|))++import Hit.ColorTerminal (arrow, errorMessage, greenCode, resetCode)+import Hit.Issue (getIssueTitle, mkIssueId)++import qualified Data.Text as T+++-- | @hit hop@ command.+runHop :: Maybe Text -> IO ()+runHop (nameOrMaster -> branch) = do+ "git" ["checkout", branch]+ "git" ["pull", "--rebase", "--prune"]++-- | @hit fresh@ command.+runFresh :: Maybe Text -> IO ()+runFresh (nameOrMaster -> branch) = do+ "git" ["fetch", "origin", branch]+ "git" ["rebase", "origin/" <> branch]++-- | @hit new@ command.+runNew :: Int -> IO ()+runNew issueNum = do+ login <- getUsername+ let issueId = mkIssueId issueNum+ issueTitle <- getIssueTitle issueId+ let shortDesc = mkShortDesc issueTitle+ let branchName = login <> "/" <> show issueNum <> "-" <> shortDesc+ "git" ["checkout", "-b", branchName]+ where+ mkShortDesc :: Text -> Text+ mkShortDesc =+ T.intercalate "-"+ . take 5+ . words+ . T.filter (\c -> isAlphaNum c || isDigit c || isSpace c)++-- | @hit commit@ command.+runCommit :: Text -> Bool -> IO ()+runCommit (T.strip -> msg) (not -> hasIssue)+ | msg == "" = errorMessage "Commit message cannot be empty"+ | otherwise = do+ branch <- getCurrentBranch+ let issueNum = issueFromBranch branch+ "git" ["add", "."]+ "git" ["commit", "-m", showMsg $ guard hasIssue *> issueNum]+ where+ showMsg :: Maybe Int -> Text+ showMsg = \case+ Nothing -> msg+ Just n ->+ let issue = "#" <> show n+ in "[" <> issue <> "] " <> msg <> "\n\nResolves " <> issue++-- / @hit fix@ command+runFix :: Maybe Text -> IO ()+runFix msg = do+ "git" ["add", "."]+ "git" ["commit", "-m", message]+ runPush False+ where+ message = fromMaybe "Fix after review" msg+++-- | @hit amend@ command.+runAmend :: IO ()+runAmend = do+ "git" ["add", "."]+ "git" ["commit", "--amend", "--no-edit"]+ runPush True++-- | @hit push@ command.+runPush :: Bool -> IO ()+runPush isForce = getCurrentBranch >>= \branch ->+ "git" $ ["push", "--set-upstream", "origin", branch]+ ++ ["--force" | isForce]++-- | @hit sync@ command.+runSync :: IO ()+runSync = getCurrentBranch >>= \branch -> "git" ["pull", "--rebase", "origin", branch]++-- | @hit resolve@ command.+runResolve :: Maybe Text -> IO ()+runResolve (nameOrMaster -> master)= do+ curBranch <- getCurrentBranch+ runHop $ Just master+ when (curBranch /= master) $ "git" ["branch", "-D", curBranch]++{- | Part of the @hit current@ command. Prints the current branch and returns+the current issue number if possible.+-}+runCurrent :: IO (Maybe Int)+runCurrent = do+ branchName <- getCurrentBranch+ putTextLn $ arrow <> "Current branch: " <> greenCode <> branchName <> resetCode+ pure $ issueFromBranch branchName++{- | @hit clone@ command receives the name of the repo in the following+formats:++* @reponame@ — current user's username is used to clone the repo from.+* @name/reponame@ — specified GitHub username is used to clone the repo from.++__Note__ that the @ssh@ strategy is used for cloning from GitHub. See the corresponding @git@ command:++@+git clone git@github.com:username/project-name.git+@+-}+runClone :: Text -> IO ()+runClone txt = do+ name <- case T.splitOn "/" txt of+ [reponame] -> getUsername >>= \u -> pure $ u <> "/" <> reponame+ [username, reponame] -> pure $ username <> "/" <> reponame+ _ -> do+ errorMessage ("Incorrect name: " <> txt <> ". Use 'repo' or 'user/repo' formats")+ exitFailure+ let gitLink = "git@github.com:" <> name <> ".git"+ "git" ["clone", gitLink]++----------------------------------------------------------------------------+-- Internal helpers+----------------------------------------------------------------------------++-- | Get current user name from the local global git config.+getUsername :: IO Text+getUsername = do+ login <- "git" $| ["config", "user.login"]+ if login == ""+ then errorMessage "user.login is not specified" >> exitFailure+ else pure login+++nameOrMaster :: Maybe Text -> Text+nameOrMaster = fromMaybe "master"++-- | Get the name of the current branch.+getCurrentBranch :: IO Text+getCurrentBranch = "git" $| ["rev-parse", "--abbrev-ref", "HEAD"]++{- | Extracts issue number from the branch in form like:++@+kowainik/<n>-short-description+@+-}+issueFromBranch :: Text -> Maybe Int+issueFromBranch =+ readMaybe+ . toString+ . T.takeWhile isDigit+ . T.drop 1+ . T.dropWhile (/= '/')
+ src/Hit/Issue.hs view
@@ -0,0 +1,166 @@+module Hit.Issue+ ( runIssue++ -- * Internal helpers+ , mkIssueId+ , getIssueTitle+ , getOwnerRepo+ , parseOwnerRepo+ ) where++import Data.Vector (Vector)+import GitHub (Error (..), Id, Issue (..), IssueLabel (..), IssueState (..), Name, Owner, Repo,+ SimpleUser (..), User, getUrl, mkId, mkName, untagName)+import GitHub.Auth (Auth (OAuth))+import GitHub.Data.Options (stateOpen)+import GitHub.Endpoints.Issues (issue', issuesForRepo')+import Shellmet (($|))+import System.Environment (lookupEnv)++import Hit.ColorTerminal (arrow, blueBg, blueCode, boldCode, errorMessage, greenCode, redCode,+ resetCode)++import qualified Data.Text as T+import qualified Data.Vector as V+++-- | Run the @issue@ command.+runIssue :: Maybe Int -> Maybe Text -> IO ()+runIssue issue me = case issue of+ Just num -> getIssue $ mkIssueId num+ Nothing -> getAllIssues me++-- | Get the list of the opened issues for the current project.+getAllIssues :: Maybe Text -> IO ()+getAllIssues me = withOwnerRepo (\t o r -> issuesForRepo' t o r stateOpen) >>= \case+ Left err -> errorMessage $ show err+ Right is -> for_ (my is) (putTextLn . showIssueName blueCode)+ where+ my :: Vector Issue -> Vector Issue+ my issues = case me of+ Just (makeName -> username) -> V.filter (assignedTo username . issueAssignees) issues+ Nothing -> issues++ -- Is the username an element of assignees vector?+ assignedTo :: Name User -> Vector SimpleUser -> Bool+ assignedTo user = isJust . V.find ((user ==) . simpleUserLogin)++-- | Get the 'Issue' by given issue number.+getIssue :: Id Issue -> IO ()+getIssue num = fetchIssue num >>= \case+ Left err -> errorMessage $ show err+ Right is -> putTextLn $ showIssueFull is++showIssueName :: Text -> Issue -> Text+showIssueName colorCode Issue{..} =+ arrow <> colorCode <> " [#" <> show @Text issueNumber <> "] " <> resetCode <> issueTitle++showIssueFull :: Issue -> Text+showIssueFull i@Issue{..} = T.intercalate "\n" $+ showIssueName (statusToCode issueState) i+ : [ highlight " Assignees: " <> assignees | not $ null issueAssignees]+ ++ [ highlight " Labels: " <> labels | not $ null issueLabels]+ ++ [ highlight " URL: " <> getUrl url | Just url <- [issueHtmlUrl]]+ ++ [ indentDesc desc | Just (T.strip -> desc) <- [issueBody], desc /= ""]+ where+ statusToCode :: IssueState -> Text+ statusToCode = \case+ StateOpen -> blueCode+ StateClosed -> redCode++ indentDesc :: Text -> Text+ indentDesc = unlines+ . map (" " <> )+ . (highlight "Description:" :)+ . lines++ assignees :: Text+ assignees = T.intercalate ", "+ $ map (untagName . simpleUserLogin)+ $ toList issueAssignees++ labels :: Text+ labels = T.intercalate " "+ $ map (putLabel . untagName . labelName)+ $ toList issueLabels++ putLabel :: Text -> Text+ putLabel x = blueBg <> x <> resetCode++ highlight :: Text -> Text+ highlight x = boldCode <> greenCode <> x <> resetCode++mkIssueId :: Int -> Id Issue+mkIssueId = mkId $ Proxy @Issue++makeName :: forall a . Text -> Name a+makeName = mkName (Proxy @a)++fetchIssue :: Id Issue -> IO (Either Error Issue)+fetchIssue iNum = withOwnerRepo (\t o r -> issue' t o r iNum)++getIssueTitle :: Id Issue -> IO Text+getIssueTitle num = fetchIssue num >>= \case+ Left err -> errorMessage (show err) >> exitFailure+ Right Issue{..} -> pure issueTitle++withOwnerRepo+ :: (Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error a))+ -> IO (Either Error a)+withOwnerRepo action = getOwnerRepo >>= \case+ Just (owner, repo) -> do+ token <- lookupEnv "GITHUB_TOKEN"+ let gitHubToken = OAuth . encodeUtf8 <$> token+ action gitHubToken owner repo+ Nothing -> do+ let errTxt = "Can not get the owner/repo names"+ errorMessage errTxt+ pure $ Left $ ParseError errTxt+++-- | Get the owner and the repository name.+getOwnerRepo :: IO (Maybe (Name Owner, Name Repo))+getOwnerRepo = parseOwnerRepo <$> "git" $| ["remote", "get-url", "origin"]++{- |+__Note:__ this works with GitHub projects!++This function supports four kinds of the URLs:++SSH one:++@+git@github.com:kowainik/hit-on.git+@++or++@+git@github.com:kowainik/hit-on+@++And HTTPS one:++@+https://github.com/kowainik/hit-on.git+@++or++@+https://github.com/kowainik/hit-on+@+-}+parseOwnerRepo :: Text -> Maybe (Name Owner, Name Repo)+parseOwnerRepo url =+ ( T.stripPrefix "git@github.com:" url+ <|> T.stripPrefix "https://github.com/" url+ ) >>= stripGitSuffix >>= separateName+ where+ separateName :: Text -> Maybe (Name Owner, Name Repo)+ separateName nm =+ let (owner, T.drop 1 -> repo) = T.breakOn "/" nm in+ guard (owner /= "" && repo /= "") *> Just (makeName owner, makeName repo)++ stripGitSuffix :: Text -> Maybe Text+ stripGitSuffix x = whenNothing (T.stripSuffix ".git" x) (Just x)
+ src/Prelude.hs view
@@ -0,0 +1,7 @@+-- | Uses [relude](https://hackage.haskell.org/package/relude) as default Prelude.++module Prelude+ ( module Relude+ ) where++import Relude