mirror of
https://github.com/anoma/juvix.git
synced 2024-12-12 14:28:08 +03:00
1ab3aa06da
This PR adds `juvix format` that can be used to format either a single
Juvix file or all files in a Juvix project.
## Usage
```
$ juvix format --help
Usage: juvix format JUVIX_FILE_OR_PROJECT [--check] [--in-place]
Format a Juvix file or Juvix project
When the command is run with an unformatted file it prints the reformatted source to standard output.
When the command is run with a project directory it prints a list of unformatted files in the project.
Available options:
JUVIX_FILE_OR_PROJECT Path to a .juvix file or to a directory containing a
Juvix project.
--check Do not print reformatted sources or unformatted file
paths to standard output.
--in-place Do not print reformatted sources to standard output.
Overwrite the target's contents with the formatted
version if the formatted version differs from the
original content.
-h,--help Show this help text
```
## Location of main implementation
The implementation is split into two components:
* The src API: `format` and `formatProject`
73952ba15c/src/Juvix/Formatter.hs
* The CLI interface:
73952ba15c/app/Commands/Format.hs
## in-place uses polysemy Resource effect
The `--in-place` option makes a backup of the target file and restores
it if there's an error during processing to avoid data loss. The
implementation of this uses the polysemy [Resource
effect](https://hackage.haskell.org/package/polysemy-1.9.0.0/docs/Polysemy-Resource.html).
The recommended way to interpret the resource effect is to use
`resourceToIOFinal` which makes it necessary to change the effects
interpretation in main to use `Final IO`:
73952ba15c/app/Main.hs (L15)
## Format input is `FilePath`
The format options uses `FilePath` instead of `AppFile f` for the input
file/directory used by other commands. This is because we cannot
determine if the input string is a file or directory in the CLI parser
(we require IO). I discussed some ideas with @janmasrovira on how to
improve this in a way that would also solve other issues with CLI input
file/parsing but I want to defer this to a separate PR as this one is
already quite large.
One consequence of Format using `FilePath` as the input option is that
the code that changes the working directory to the root of the project
containing the CLI input file is changed to work with `FilePath`:
f715ef6a53/app/TopCommand/Options.hs (L33)
## New dependencies
This PR adds new dependencies on `temporary` and `polysemy-zoo`.
`temporary` is used for `emptySystemTempFile` in the implementation of
the TempFile interpreter for IO:
73952ba15c/src/Juvix/Data/Effect/Files/IO.hs (L49)
`polysemy-zoo` is used for the `Fresh` effect and `absorbMonadThrow` in
the implementation of the pure TempFile interpreter:
73952ba15c/src/Juvix/Data/Effect/Files/Pure.hs (L91)
NB: The pure TempFile interpreter is not used, but it seemed a good idea
to include it while it's fresh in my mind.
* Closes https://github.com/anoma/juvix/issues/1777
---------
Co-authored-by: Jonathan Cubides <jonathan.cubides@uib.no>
50 lines
1.0 KiB
Haskell
50 lines
1.0 KiB
Haskell
module Main (main) where
|
|
|
|
import Arity qualified
|
|
import Asm qualified
|
|
import BackendGeb qualified
|
|
import Base
|
|
import Compilation qualified
|
|
import Core qualified
|
|
import Examples qualified
|
|
import Format qualified
|
|
import Formatter qualified
|
|
import Internal qualified
|
|
import Parsing qualified
|
|
import Reachability qualified
|
|
import Runtime qualified
|
|
import Scope qualified
|
|
import Termination qualified
|
|
import Typecheck qualified
|
|
|
|
slowTests :: TestTree
|
|
slowTests =
|
|
testGroup
|
|
"Juvix slow tests"
|
|
[ BackendGeb.allTests,
|
|
Runtime.allTests,
|
|
Asm.allTests,
|
|
Core.allTests,
|
|
Internal.allTests,
|
|
Compilation.allTests,
|
|
Examples.allTests
|
|
]
|
|
|
|
fastTests :: TestTree
|
|
fastTests =
|
|
testGroup
|
|
"Juvix fast tests"
|
|
[ Parsing.allTests,
|
|
Scope.allTests,
|
|
Termination.allTests,
|
|
Arity.allTests,
|
|
Typecheck.allTests,
|
|
Reachability.allTests,
|
|
Format.allTests,
|
|
Formatter.allTests
|
|
]
|
|
|
|
main :: IO ()
|
|
main = do
|
|
defaultMain (testGroup "Juvix tests" [fastTests, slowTests])
|