| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Git.Vogue
- data VogueOptions = Options {}
- data VogueCommand
- = CmdInit { }
- | CmdVerify
- | CmdPlugins
- | CmdRunCheck
- | CmdRunFix
- newtype Vogue m x = Vogue {}
- runVogue :: [Plugin] -> Vogue m a -> m a
- runCommand :: (MonadIO m, Functor m) => VogueCommand -> SearchMode -> Vogue m ()
- runFix :: (MonadIO m, Functor m) => SearchMode -> Vogue m ()
- runCheck :: MonadIO m => SearchMode -> Vogue m ()
- runWithRepoPath :: MonadIO m => (FilePath -> m a) -> m a
- preCommitCommand :: String
- gitAddHook :: MonadIO m => Maybe FilePath -> FilePath -> Vogue m ()
- copyHookTemplateTo :: Maybe FilePath -> FilePath -> IO ()
- gitCheckHook :: MonadIO m => (FilePath -> IO Bool) -> FilePath -> Vogue m ()
- runsVogue :: FilePath -> IO Bool
- listPlugins :: MonadIO m => Vogue m ()
- disabledPlugins :: (Monad m, Functor m, MonadIO m) => m [String]
Documentation
data VogueCommand Source
Commands, with parameters, to be executed.
Constructors
| CmdInit | Add git-vogue support to a git repository. |
Fields | |
| CmdVerify | Verify that support is installed and plugins happen. |
| CmdPlugins | List the plugins that git-vogue knows about. |
| CmdRunCheck | Run check plugins on files in a git repository. |
| CmdRunFix | Run fix plugins on files in a git repository. |
Instances
Plugins that git-vogue knows about. FIXME: this will become the fix/check modules
Instances
| MonadTrans Vogue | |
| Monad m => Monad (Vogue m) | |
| Functor m => Functor (Vogue m) | |
| Applicative m => Applicative (Vogue m) | |
| MonadIO m => MonadIO (Vogue m) | |
| Monad m => MonadReader [Plugin] (Vogue m) |
runCommand :: (MonadIO m, Functor m) => VogueCommand -> SearchMode -> Vogue m () Source
Execute a git-vogue command.
runFix :: (MonadIO m, Functor m) => SearchMode -> Vogue m () Source
Try to fix the broken things. We first do one pass to check what's broken, then only run fix on those.
runCheck :: MonadIO m => SearchMode -> Vogue m () Source
Check for broken things.
runWithRepoPath :: MonadIO m => (FilePath -> m a) -> m a Source
Find the git repository path and pass it to an action.
Throws an error if the PWD is not in a git repo.
Add the git pre-commit hook.
copyHookTemplateTo :: Maybe FilePath -> FilePath -> IO () Source
Copy the template pre-commit hook to a git repo.
gitCheckHook :: MonadIO m => (FilePath -> IO Bool) -> FilePath -> Vogue m () Source
Use a predicate to check a git commit hook.
listPlugins :: MonadIO m => Vogue m () Source
Print a list of all plugins.