Format Package.juvix when formatting project (#3219)

- Closes #3217, #2898
anoma · Dec 6, 2024 · 3e367aa · 3e367aa
1 parent 4eb7509
commit 3e367aa
Show file tree

Hide file tree

Showing 19 changed files with 52 additions and 27 deletions.
diff --git a/app/App.hs b/app/App.hs
@@ -188,6 +188,9 @@ getEntryPointStdin' RunAppIOArgs {..} = do
         | otherwise -> return Nothing
   set entryPointStdin estdin <$> entryPointFromGlobalOptionsNoFile root opts
 
+askPackageDotJuvixPath :: (Members '[App] r) => Sem r (Path Abs File)
+askPackageDotJuvixPath = mkPackagePath . (^. rootRootDir) <$> askRoot
+
 fromRightGenericError :: (Members '[App] r, ToGenericError err, Typeable err) => Either err a -> Sem r a
 fromRightGenericError = fromRightJuvixError . mapLeft JuvixError
 

diff --git a/app/Commands/Format.hs b/app/Commands/Format.hs
@@ -49,15 +49,22 @@ targetFromOptions opts = do
 -- | Formats the project on the root
 formatProject ::
   forall r.
-  (Members '[App, EmbedIO, TaggedLock, Logger, Files, Output FormattedFileInfo] r) =>
+  (Members '[App, EmbedIO, TaggedLock, Logger, ScopeEff, Files, Output FormattedFileInfo] r) =>
   Sem r FormatResult
 formatProject = silenceProgressLog . runPipelineOptions . runPipelineSetup $ do
   res :: [(ImportNode, PipelineResult ModuleInfo)] <- processProject
-  res' :: [(ImportNode, SourceCode)] <- forM res $ \(node, nfo) -> do
-    pkgId :: PackageId <- (^. entryPointPackageId) <$> ask
-    src <- runReader pkgId (formatModuleInfo node nfo)
+  pkgId :: PackageId <- (^. entryPointPackageId) <$> ask
+  res' :: [(ImportNode, SourceCode)] <- runReader pkgId $ forM res $ \(node, nfo) -> do
+    src <- formatModuleInfo node nfo
     return (node, src)
-  formatProjectSourceCode res'
+  formatRes <- formatProjectSourceCode res'
+  formatPkgRes <- formatPackageDotJuvix
+  return (formatRes <> formatPkgRes)
+
+formatPackageDotJuvix :: forall r. (Members '[App, Files, Logger, Output FormattedFileInfo, ScopeEff] r) => Sem r FormatResult
+formatPackageDotJuvix = do
+  pkgDotJuvix <- askPackageDotJuvixPath
+  ifM (fileExists' pkgDotJuvix) (format pkgDotJuvix) (return mempty)
 
 runCommand :: forall r. (Members AppEffects r) => FormatOptions -> Sem r ()
 runCommand opts = do

diff --git a/examples/demo/Package.juvix b/examples/demo/Package.juvix
@@ -5,5 +5,5 @@ import PackageDescription.V2 open;
 package : Package :=
   defaultPackage@{
     name := "Demo";
-    version := mkVersion 0 1 0
+    version := mkVersion 0 1 0;
   };
diff --git a/examples/midsquare/Package.juvix b/examples/midsquare/Package.juvix
@@ -5,5 +5,5 @@ import PackageDescription.V2 open;
 package : Package :=
   defaultPackage@{
     name := "midsquare";
-    version := mkVersion 0 1 0
+    version := mkVersion 0 1 0;
   };
diff --git a/examples/milestone/Bank/Package.juvix b/examples/milestone/Bank/Package.juvix
@@ -4,5 +4,5 @@ import PackageDescription.V2 open;
 
 package : Package :=
   defaultPackage@{
-    name := "bank"
+    name := "bank";
   };
diff --git a/examples/milestone/Collatz/Package.juvix b/examples/milestone/Collatz/Package.juvix
@@ -6,5 +6,5 @@ package : Package :=
   defaultPackage@{
     name := "Collatz";
     version := mkVersion 0 1 0;
-    main := just "Collatz.juvix"
+    main := just "Collatz.juvix";
   };
diff --git a/examples/milestone/Fibonacci/Package.juvix b/examples/milestone/Fibonacci/Package.juvix
@@ -6,5 +6,5 @@ package : Package :=
   defaultPackage@{
     name := "Fibonacci";
     version := mkVersion 0 1 0;
-    main := just "Fibonacci.juvix"
+    main := just "Fibonacci.juvix";
   };
diff --git a/examples/milestone/Hanoi/Package.juvix b/examples/milestone/Hanoi/Package.juvix
@@ -6,5 +6,5 @@ package : Package :=
   defaultPackage@{
     name := "Hanoi";
     version := mkVersion 0 1 0;
-    main := just "Hanoi.juvix"
+    main := just "Hanoi.juvix";
   };
diff --git a/examples/milestone/HelloWorld/Package.juvix b/examples/milestone/HelloWorld/Package.juvix
@@ -6,5 +6,5 @@ package : Package :=
   defaultPackage@{
     name := "HelloWorld";
     version := mkVersion 0 1 0;
-    main := just "HelloWorld.juvix"
+    main := just "HelloWorld.juvix";
   };
diff --git a/examples/milestone/PascalsTriangle/Package.juvix b/examples/milestone/PascalsTriangle/Package.juvix
@@ -6,5 +6,5 @@ package : Package :=
   defaultPackage@{
     name := "PascalsTriangle";
     version := mkVersion 0 1 0;
-    main := just "PascalsTriangle.juvix"
+    main := just "PascalsTriangle.juvix";
   };
diff --git a/examples/milestone/TicTacToe/Package.juvix b/examples/milestone/TicTacToe/Package.juvix
@@ -6,5 +6,5 @@ package : Package :=
   defaultPackage@{
     name := "TicTacToe";
     version := mkVersion 0 1 0;
-    main := just "CLI/TicTacToe.juvix"
+    main := just "CLI/TicTacToe.juvix";
   };
diff --git a/examples/milestone/Tutorial/Package.juvix b/examples/milestone/Tutorial/Package.juvix
@@ -5,5 +5,5 @@ import PackageDescription.V2 open;
 package : Package :=
   defaultPackage@{
     name := "Tutorial";
-    version := mkVersion 0 1 0
+    version := mkVersion 0 1 0;
   };
diff --git a/src/Juvix/Formatter.hs b/src/Juvix/Formatter.hs
@@ -94,7 +94,7 @@ format p = do
 -- contents of a file) for every processed file.
 --
 -- NB: This function does not traverse into Juvix sub-projects, i.e into
--- subdirectories that contain a juvix.yaml file.
+-- subdirectories that contain a Package.juvix file.
 formatProjectSourceCode ::
   forall r.
   (Members '[Output FormattedFileInfo] r) =>
@@ -178,12 +178,11 @@ formatResultSourceCode filepath src = do
     mkResult :: FormatResult -> Sem r FormatResult
     mkResult res = do
       output
-        ( FormattedFileInfo
-            { _formattedFileInfoPath = filepath,
-              _formattedFileInfoContents = src ^. sourceCodeFormatted,
-              _formattedFileInfoContentsModified = res == FormatResultNotFormatted
-            }
-        )
+        FormattedFileInfo
+          { _formattedFileInfoPath = filepath,
+            _formattedFileInfoContents = src ^. sourceCodeFormatted,
+            _formattedFileInfoContentsModified = res == FormatResultNotFormatted
+          }
       return res
 
 formatScoperResult' ::

diff --git a/tests/positive/Internal/Positivity2/Package.juvix b/tests/positive/Internal/Positivity2/Package.juvix
@@ -5,5 +5,5 @@ import PackageDescription.V2 open;
 package : Package :=
   defaultPackage@{
     name := "positivity2";
-    dependencies := []
+    dependencies := [];
   };
diff --git a/tests/positive/PackageLoader/PackageJuvixEmptyDependencies/Package.juvix b/tests/positive/PackageLoader/PackageJuvixEmptyDependencies/Package.juvix
@@ -6,5 +6,5 @@ import PackageDescription.V1 open;
 package : Package :=
   defaultPackage@{
     name := "package-juvix";
-    dependencies := []
+    dependencies := [];
   };
diff --git a/tests/positive/PackageLoader/YamlEmptyDependencies/Package.juvix b/tests/positive/PackageLoader/YamlEmptyDependencies/Package.juvix
@@ -5,5 +5,5 @@ import PackageDescription.V1 open;
 package : Package :=
   defaultPackage@{
     name := "abc";
-    dependencies := []
+    dependencies := [];
   };
diff --git a/tests/positive/PackageLoaderV2/PackageJuvixEmptyDependencies/Package.juvix b/tests/positive/PackageLoaderV2/PackageJuvixEmptyDependencies/Package.juvix
@@ -5,5 +5,5 @@ import PackageDescription.V2 open;
 package : Package :=
   defaultPackage@{
     name := "package-juvix";
-    dependencies := []
+    dependencies := [];
   };
diff --git a/tests/positive/issue3068/Package.juvix b/tests/positive/issue3068/Package.juvix
@@ -5,5 +5,5 @@ import PackageDescription.V2 open;
 package : Package :=
   defaultPackage@{
     name := "issue3068";
-    dependencies := []
+    dependencies := [];
   };
diff --git a/tests/smoke/Commands/format.smoke.yaml b/tests/smoke/Commands/format.smoke.yaml
@@ -168,6 +168,22 @@ tests:
     stderr: ''
     exit-status: 1
 
+  - name: format-project-package-dot-juvix
+    command:
+      shell:
+        - bash
+      script: |
+        temp=$(mktemp -d)
+        trap 'rm -rf -- "$temp"' EXIT
+        cd $temp
+        juvix init
+        echo "" >> Package.juvix
+        juvix format
+    stderr: ''
+    stdout:
+      contains: 'Package.juvix'
+    exit-status: 1
+
   - name: format-project-containing-unformatted-from-subdir
     command:
       shell: