Format all files in `src/` by `cabal run -- src/**/*.hs` #599

toku-sa-n · 2022-09-22T08:02:30Z

The purpose is - To test `HIndent` with an actual project. - To minimize commit diffs. This commit's one is huge, but then consecutive diffs should be minimized because all sources are formatted in the same way.

See mihaimaruseac#600. The second one is not affected, but I have decided to remove it. Having a headline at the middle of a list and not having at the top of it is somewhat strange.

…to format_with_hindent

toku-sa-n · 2022-11-03T15:06:57Z

@mihaimaruseac If you have time, could you look at this PR (and #598 if ok)? This PR should reduce a few diffs in #593 because some of the diffs in the PR are due to the formatter application. Of course, I can remove these diffs from the PR, though.

mihaimaruseac

Looks good, I only had a few minor suggestions to keep the same intent behind comments.

mihaimaruseac · 2022-11-03T16:43:49Z

src/HIndent.hs

+{-# LANGUAGE OverloadedStrings, ScopedTypeVariables, PatternGuards
+  #-}


Let's split these to one per line

mihaimaruseac · 2022-11-03T16:44:04Z

src/HIndent.hs

+  ( reformat
+  , prettyPrint
+  , parseMode
+  , test
+  , testFile
+  , testAst
+  , testFileAst
+  , defaultExtensions
+  , getExtensions
+  ) where


Can we keep the comments for separation here?

I removed the first comment because of #600 and the rest because I thought it was somewhat strange to have headlines in the middle of a list and not have one at the first line. Should we first resolve #600?

I think so, I'd prefer to keep the documentation blocks

mihaimaruseac · 2022-11-03T16:47:28Z

src/HIndent.hs


 --------------------------------------------------------------------------------
 -- Extensions stuff stolen from hlint
-


Let's keep this empty line. The above comment is for an entire section in the file whereas the one below is just for the function

Unfortunately, HIndent doesn't preserve empty lines between comments; fixing it requires modifying the source code, and I don't think it's an easy task.

Hmm, let's open an issue for this too (if there isn't any)

mihaimaruseac · 2022-11-03T16:47:41Z

src/HIndent.hs


 --------------------------------------------------------------------------------
 -- Comments
-


Same here, let's keep this empty line

mihaimaruseac · 2022-11-03T16:51:04Z

src/HIndent/Pretty.hs


 --------------------------------------------------------------------------------
 -- * Pretty printing class
-


I think we need this emtpy line

mihaimaruseac · 2022-11-03T16:55:55Z

src/HIndent/Pretty.hs

 instance Pretty DataOrNew where
  prettyInternal = pretty'

 instance Pretty FunDep where
  prettyInternal = pretty'
-


Let's keep this one, we're just adding a new instance in some conditions

mihaimaruseac · 2022-11-03T16:56:03Z

src/HIndent/Pretty.hs

 #if !MIN_VERSION_haskell_src_exts(1,21,0)
 instance Pretty Kind where
  prettyInternal = pretty'
 #endif
-


mihaimaruseac · 2022-11-03T16:56:13Z

src/HIndent/Pretty.hs

      Special _ s -> pretty s

-


mihaimaruseac · 2022-11-03T16:57:11Z

src/HIndent/Pretty.hs

@@ -2026,10 +2135,9 @@ recUpdateExpr expWriter updates = do

 --------------------------------------------------------------------------------
 -- Predicates
-


mihaimaruseac · 2022-11-03T16:57:49Z

src/HIndent/Types.hs

@@ -70,46 +79,37 @@ data Config = Config
    , configExtensions :: [Extension]
      -- ^ Extra language extensions enabled by default.
    }
-


Let's keep this line

toku-sa-n · 2022-11-04T00:06:32Z

Thank you for the review. Unfortunately, most suggestions can't be applied due to the current HIndent implementation. Do I modify the current implementation to apply them, or close this PR and include them in #593?

mihaimaruseac · 2022-11-04T14:07:48Z

Let's keep it open for now and wait on fixing the blocking issues.

For #593, let's go ahead with it without focusing on auto-formatting for now, unless required by testing.

toku-sa-n added 3 commits September 21, 2022 23:41

Format the code with cabal run -- src/**/*.hs

8704f06

The purpose is - To test `HIndent` with an actual project. - To minimize commit diffs. This commit's one is huge, but then consecutive diffs should be minimized because all sources are formatted in the same way.

Merge remote-tracking branch 'upstream/master' into format_with_hindent

e50ee30

Merge branch 'mihaimaruseac:master' into format_with_hindent

0312c6a

toku-sa-n mentioned this pull request Sep 22, 2022

Check the format of source files in src/ on CI #598

Merged

toku-sa-n added 3 commits September 22, 2022 23:17

Remove haddock comments from the module declaration

ac9f6ab

See mihaimaruseac#600. The second one is not affected, but I have decided to remove it. Having a headline at the middle of a list and not having at the top of it is somewhat strange.

Merge branch 'format_with_hindent' of github.com:toku-sa-n/hindent in…

ec7e0e8

…to format_with_hindent

Merge branch 'master' into format_with_hindent

dc74529

mihaimaruseac reviewed Nov 3, 2022

View reviewed changes

toku-sa-n mentioned this pull request Nov 6, 2022

Switch from haskell-src-exts to ghc-lib-parser #593

Merged

mihaimaruseac closed this in #593 Dec 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Format all files in `src/` by `cabal run -- src/**/*.hs` #599

Format all files in `src/` by `cabal run -- src/**/*.hs` #599

toku-sa-n commented Sep 22, 2022

toku-sa-n commented Nov 3, 2022

mihaimaruseac left a comment

mihaimaruseac Nov 3, 2022

mihaimaruseac Nov 3, 2022

toku-sa-n Nov 3, 2022

mihaimaruseac Nov 4, 2022

mihaimaruseac Nov 3, 2022

toku-sa-n Nov 4, 2022

mihaimaruseac Nov 4, 2022

mihaimaruseac Nov 3, 2022

mihaimaruseac Nov 3, 2022

mihaimaruseac Nov 3, 2022

mihaimaruseac Nov 3, 2022

mihaimaruseac Nov 3, 2022

mihaimaruseac Nov 3, 2022

mihaimaruseac Nov 3, 2022

toku-sa-n commented Nov 4, 2022

mihaimaruseac commented Nov 4, 2022

		{-# LANGUAGE OverloadedStrings, ScopedTypeVariables, PatternGuards
		#-}


		--------------------------------------------------------------------------------
		-- Extensions stuff stolen from hlint


		--------------------------------------------------------------------------------
		-- Comments


		--------------------------------------------------------------------------------
		-- * Pretty printing class

		@@ -2026,10 +2135,9 @@ recUpdateExpr expWriter updates = do

		--------------------------------------------------------------------------------
		-- Predicates

Format all files in src/ by cabal run -- src/**/*.hs #599

Format all files in src/ by cabal run -- src/**/*.hs #599

Conversation

toku-sa-n commented Sep 22, 2022

toku-sa-n commented Nov 3, 2022

mihaimaruseac left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toku-sa-n commented Nov 4, 2022

mihaimaruseac commented Nov 4, 2022

Format all files in `src/` by `cabal run -- src/**/*.hs` #599

Format all files in `src/` by `cabal run -- src/**/*.hs` #599