Various fixes for leaving a messy git state

.github/workflows/ci.yml

@@ -84,6 +84,7 @@ jobs:
           options: --limit 3
       - uses: restyled-io/actions/run@v2
         with:
+          paths: .
           log-level: debug
 
   release:
@@ -112,4 +113,3 @@ jobs:
       - uses: actions/checkout@v4
       - run: ./install
       - run: restyle --help
-      - run: restyle-gha --help

README.md

@@ -14,8 +14,8 @@ curl --proto '=https' --tlsv1.2 -sSf \
 ```console
 Usage: restyle [--debug] [--trace] [--color WHEN] [--dry-run]
                [--fail-on-differences] [--host-directory DIRECTORY]
-               [--image-cleanup] [--manifest FILE] [--no-commit] [--no-pull]
-               PATH [PATH]
+               [--image-cleanup] [--manifest FILE] [--no-commit] [--no-clean]
+               [--no-pull] PATH [PATH]
 
   Restyle local files
 
@@ -30,6 +30,7 @@ Available options:
   --image-cleanup          Remove pulled restyler images after restyling
   --manifest FILE          Restylers manifest to use
   --no-commit              Don't make commits for restyle changes
+  --no-clean               Don't run git-clean after restyling
   --no-pull                Don't docker-pull images before docker-run
   -h,--help                Show this help text
 
@@ -50,6 +51,8 @@ Available environment variables:
   LOG_FORMAT
   LOG_LEVEL
   MANIFEST               Restylers manifest to use
+  NO_CLEAN               Don't run git-clean after
+                         restyling
   NO_COLOR
   NO_COMMIT              Don't make commits for restyle
                          changes

install

@@ -44,7 +44,12 @@ done
 shift $((OPTIND - 1))
 
 if [ -z "$tag" ]; then
-  tag=$(curl -sSf https://api.github.com/repos/restyled-io/restyler/releases |
+  tag=$(curl \
+    --max-time 10 \
+    --retry 5 \
+    --retry-delay 0 \
+    --retry-max-time 30 \
+    -sSf https://api.github.com/repos/restyled-io/restyler/releases |
     grep -o '"tag_name": ".*"' |
     sed 's/^.*: "//; s/"$//' |
     grep -v -- '-rc$' |

package.yaml

@@ -1,5 +1,5 @@
 name: restyler
-version: 0.5.0.1
+version: 0.5.2.0
 license: AGPL-3
 
 language: GHC2021

restyler.cabal

@@ -5,7 +5,7 @@ cabal-version: 1.12
 -- see: https://github.com/sol/hpack
 
 name:           restyler
-version:        0.5.0.1
+version:        0.5.2.0
 license:        AGPL-3
 build-type:     Simple
 
@@ -47,6 +47,7 @@ library
       Restyler.Options.ImageCleanup
       Restyler.Options.LogSettings
       Restyler.Options.Manifest
+      Restyler.Options.NoClean
       Restyler.Options.NoCommit
       Restyler.Options.NoPull
       Restyler.Options.Repository

src/Restyler/Local.hs

@@ -19,13 +19,14 @@ import Restyler.Ignore
 import Restyler.Monad.Directory
 import Restyler.Monad.Docker (MonadDocker)
 import Restyler.Monad.DownloadFile
-import Restyler.Monad.Git (MonadGit)
+import Restyler.Monad.Git (MonadGit (..))
 import Restyler.Monad.ReadFile
 import Restyler.Monad.WriteFile
 import Restyler.Options.DryRun
 import Restyler.Options.HostDirectory
 import Restyler.Options.ImageCleanup
 import Restyler.Options.Manifest
+import Restyler.Options.NoClean
 import Restyler.Options.NoCommit
 import Restyler.Options.NoPull
 import Restyler.Restrictions
@@ -49,6 +50,7 @@ run
      , HasImageCleanupOption env
      , HasManifestOption env
      , HasNoCommitOption env
+     , HasNoCleanOption env
      , HasNoPullOption env
      , HasRestrictions env
      , HasPullRequestState pr
@@ -90,4 +92,7 @@ run pr paths = do
              , "sha" .= result.sha
              ]
 
+      noClean <- getNoClean
+      unless noClean gitClean
+
       pure $ maybe RestyleNoDifference (const RestyleDifference) mresults

src/Restyler/Local/App.hs

@@ -23,6 +23,7 @@ import Restyler.Options.HostDirectory
 import Restyler.Options.ImageCleanup
 import Restyler.Options.LogSettings
 import Restyler.Options.Manifest
+import Restyler.Options.NoClean
 import Restyler.Options.NoCommit
 import Restyler.Options.NoPull
 import Restyler.Restrictions
@@ -39,6 +40,7 @@ data App = App
   deriving (HasImageCleanupOption) via (ThroughOptions App)
   deriving (HasManifestOption) via (ThroughOptions App)
   deriving (HasNoCommitOption) via (ThroughOptions App)
+  deriving (HasNoCleanOption) via (ThroughOptions App)
   deriving (HasNoPullOption) via (ThroughOptions App)
   deriving (HasRestrictions) via (ThroughOptions App)
 

src/Restyler/Local/Options.hs

@@ -27,6 +27,7 @@ import Restyler.Options.HostDirectory
 import Restyler.Options.ImageCleanup
 import Restyler.Options.LogSettings
 import Restyler.Options.Manifest
+import Restyler.Options.NoClean
 import Restyler.Options.NoCommit
 import Restyler.Options.NoPull
 import Restyler.Restrictions
@@ -39,6 +40,7 @@ data Options = Options
   , imageCleanup :: ImageCleanupOption
   , manifest :: ManifestOption
   , noCommit :: NoCommitOption
+  , noClean :: NoCleanOption
   , noPull :: NoPullOption
   , restrictions :: Restrictions
   }
@@ -63,6 +65,9 @@ instance HasManifestOption Options where
 instance HasNoCommitOption Options where
   getNoCommitOption = (.noCommit)
 
+instance HasNoCleanOption Options where
+  getNoCleanOption = (.noClean)
+
 instance HasNoPullOption Options where
   getNoPullOption = (.noPull)
 
@@ -79,6 +84,7 @@ envParser =
     <*> envImageCleanupOption
     <*> envManifestOption
     <*> envNoCommitOption
+    <*> envNoCleanOption
     <*> envNoPullOption
     <*> envRestrictions
 
@@ -92,6 +98,7 @@ optParser =
     <*> optImageCleanupOption
     <*> optManifestOption
     <*> optNoCommitOption
+    <*> optNoCleanOption
     <*> optNoPullOption
     <*> pure mempty -- Restrictions are ENV-only
 
@@ -124,6 +131,9 @@ instance HasOptions a => HasManifestOption (ThroughOptions a) where
 instance HasOptions a => HasNoCommitOption (ThroughOptions a) where
   getNoCommitOption = getNoCommitOption . getOptions
 
+instance HasOptions a => HasNoCleanOption (ThroughOptions a) where
+  getNoCleanOption = getNoCleanOption . getOptions
+
 instance HasOptions a => HasNoPullOption (ThroughOptions a) where
   getNoPullOption = getNoPullOption . getOptions
 

src/Restyler/Monad/Git.hs

@@ -25,7 +25,9 @@ import System.Process.Typed
 class Monad m => MonadGit m where
   isGitRepository :: HasCallStack => m Bool
   gitDiffNameOnly :: HasCallStack => Maybe String -> m [FilePath]
-  gitCommitAll :: HasCallStack => String -> m String
+  gitCommit :: HasCallStack => String -> NonEmpty FilePath -> m String
+  gitClean :: HasCallStack => m ()
+  gitResetHard :: HasCallStack => String -> m ()
 
 -- | An instance that invokes the real @git@
 newtype ActualGit m a = ActualGit
@@ -47,9 +49,11 @@ instance
   where
   isGitRepository = (== ExitSuccess) <$> runGitExitCode ["rev-parse"]
   gitDiffNameOnly mRef = readGitLines $ ["diff", "--name-only"] <> maybeToList mRef
-  gitCommitAll msg = do
-    runGit_ ["commit", "-a", "--message", msg]
+  gitCommit msg paths = do
+    runGit_ $ ["commit", "--message", msg, "--"] <> toList paths
     readGitChomp ["rev-parse", "HEAD"]
+  gitClean = runGit_ ["clean", "-d", "--force"]
+  gitResetHard ref = runGit_ ["reset", "--hard", ref]
 
 runGit_
   :: ( MonadUnliftIO m
@@ -121,4 +125,6 @@ newtype NullGit m a = NullGit
 instance Monad m => MonadGit (NullGit m) where
   isGitRepository = pure False
   gitDiffNameOnly _ = pure []
-  gitCommitAll _ = pure ""
+  gitCommit _ _ = pure ""
+  gitClean = pure ()
+  gitResetHard _ = pure ()

src/Restyler/Options/NoClean.hs

@@ -0,0 +1,42 @@
+-- |
+--
+-- Module      : Restyler.Options.NoClean
+-- Copyright   : (c) 2024 Patrick Brisbin
+-- License     : AGPL-3
+-- Maintainer  : [email protected]
+-- Stability   : experimental
+-- Portability : POSIX
+module Restyler.Options.NoClean
+  ( NoCleanOption (..)
+  , HasNoCleanOption (..)
+  , getNoClean
+  , envNoCleanOption
+  , optNoCleanOption
+  ) where
+
+import Restyler.Prelude
+
+import Env qualified
+import Options.Applicative
+
+newtype NoCleanOption = NoCleanOption
+  { unwrap :: Any
+  }
+  deriving newtype (Semigroup, Monoid)
+
+class HasNoCleanOption a where
+  getNoCleanOption :: a -> NoCleanOption
+
+getNoClean :: (MonadReader env m, HasNoCleanOption env) => m Bool
+getNoClean = asks $ getAny . (.unwrap) . getNoCleanOption
+
+envNoCleanOption :: Env.Parser Env.Error NoCleanOption
+envNoCleanOption =
+  NoCleanOption . Any <$> Env.switch "NO_CLEAN" (Env.help optionHelp)
+
+optNoCleanOption :: Parser NoCleanOption
+optNoCleanOption =
+  NoCleanOption . Any <$> switch (long "no-clean" <> help optionHelp)
+
+optionHelp :: String
+optionHelp = "Don't run git-clean after restyling"

src/Restyler/Restyler/Run.hs

@@ -137,11 +137,31 @@ runRestylers config@Config {..} argPaths = do
        ]
 
   for_ cRemoteFiles $ \rf -> downloadFile rf.url rf.path
-  withFilteredPaths restylers paths $ runRestyler config
+
+  mResults <- withFilteredPaths restylers paths $ runRestyler config
+  mResetTo <- join <$> traverse checkForNoop mResults
+
+  case mResetTo of
+    Nothing -> pure mResults
+    Just ref -> do
+      logInfo "Restylers offset each other, resetting git state"
+      Nothing <$ gitResetHard ref
  where
   included path = none (`match` path) cExclude
   restylers = filter rEnabled cRestylers
 
+-- | See if multiple restylers offset each other
+--
+-- Returns the git ref to reset to if they did.
+checkForNoop :: MonadGit m => NonEmpty RestylerResult -> m (Maybe String)
+checkForNoop results = runMaybeT $ do
+  sha <- hoistMaybe result.sha
+  let parent = sha <> "^"
+  changed <- lift $ gitDiffNameOnly $ Just parent
+  parent <$ guard (null changed)
+ where
+  result = head results
+
 -- | Run each @'Restyler'@ with appropriate paths out of the given set
 --
 -- Input is expected to be files (not directories), filtered for existence, and
@@ -233,7 +253,7 @@ runRestyler config r = \case
     isGit <- isGitRepository
 
     if isGit
-      then getRestylerResult config r
+      then getRestylerResult config paths r
       else do
         Nothing <$ logWarn "Unable to determine Restyler result (not a git repository)"
 

src/Restyler/RestylerResult.hs

@@ -33,17 +33,18 @@ data RestylerResult = RestylerResult
 getRestylerResult
   :: (MonadGit m, MonadReader env m, HasNoCommitOption env)
   => Config
+  -> [FilePath]
   -> Restyler
   -> m (Maybe RestylerResult)
-getRestylerResult config restyler = do
+getRestylerResult config paths restyler = do
   noCommit <- getNoCommit
-  mRestyled <- nonEmpty <$> gitDiffNameOnly Nothing
+  mRestyled <- nonEmpty . filter (`elem` paths) <$> gitDiffNameOnly Nothing
 
   for mRestyled $ \restyled -> do
     sha <-
       if noCommit
         then pure Nothing
-        else Just <$> gitCommitAll commitMessage
+        else Just <$> gitCommit commitMessage restyled
 
     pure
       $ RestylerResult

test/SpecHelper.hs

@@ -64,6 +64,7 @@ import Restyler.Options.FailOnDifferences
 import Restyler.Options.HostDirectory
 import Restyler.Options.ImageCleanup
 import Restyler.Options.Manifest
+import Restyler.Options.NoClean
 import Restyler.Options.NoCommit
 import Restyler.Options.NoPull
 import Restyler.Restrictions
@@ -154,6 +155,7 @@ testOptions =
     , imageCleanup = ImageCleanupOption $ Any False
     , manifest = ManifestOption $ Last Nothing
     , noCommit = NoCommitOption $ Any False
+    , noClean = NoCleanOption $ Any False
     , noPull = NoPullOption $ Any False
     , restrictions = fullRestrictions
     }