Add more useful comments in spago.dhall (#778)

purescript · Apr 21, 2021 · 1d247ba · 1d247ba
1 parent 41ad739
commit 1d247ba
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 14 deletions.
diff --git a/templates/packages.dhall b/templates/packages.dhall
@@ -4,13 +4,6 @@ Welcome to your new Dhall package-set!
 Below are instructions for how to edit this file for most use
 cases, so that you don't need to know Dhall to use it.
 
-## Warning: Don't Move This Top-Level Comment!
-
-Due to how `dhall format` currently works, this comment's
-instructions cannot appear near corresponding sections below
-because `dhall format` will delete the comment. However,
-it will not delete a top-level comment like this one.
-
 ## Use Cases
 
 Most will want to do one or both of these options:
@@ -49,6 +42,7 @@ in  upstream
   with halogen.repo = "https://example.com/path/to/git/repo.git"
 
   with halogen-vdom.version = "v4.0.0"
+  with halogen-vdom.dependencies = [ "extra-dependency" ] # halogen-vdom.dependencies
 -------------------------------
 
 ### Additions

diff --git a/templates/spago.dhall b/templates/spago.dhall
@@ -1,6 +1,14 @@
 {-
 Welcome to a Spago project!
 You can edit this file as you like.
+
+Need help? See the following resources:
+- Spago documentation: https://github.com/purescript/spago
+- Dhall language tour: https://docs.dhall-lang.org/tutorials/Language-Tour.html
+
+When creating a new Spago project, you can use
+`spago init --no-comments` or `spago init -C`
+to generate this file without the comments in this block.
 -}
 { name = "my-project"
 , dependencies = [ "console", "effect", "prelude", "psci-support" ]

diff --git a/test/fixtures/packages-older-tag.dhall b/test/fixtures/packages-older-tag.dhall
@@ -4,13 +4,6 @@ Welcome to your new Dhall package-set!
 Below are instructions for how to edit this file for most use
 cases, so that you don't need to know Dhall to use it.
 
-## Warning: Don't Move This Top-Level Comment!
-
-Due to how `dhall format` currently works, this comment's
-instructions cannot appear near corresponding sections below
-because `dhall format` will delete the comment. However,
-it will not delete a top-level comment like this one.
-
 ## Use Cases
 
 Most will want to do one or both of these options:
@@ -49,6 +42,7 @@ in  upstream
   with halogen.repo = "https://example.com/path/to/git/repo.git"
 
   with halogen-vdom.version = "v4.0.0"
+  with halogen-vdom.dependencies = [ "extra-dependency" ] # halogen-vdom.dependencies
 -------------------------------
 
 ### Additions

diff --git a/test/fixtures/spago-bower-import.dhall b/test/fixtures/spago-bower-import.dhall
@@ -1,6 +1,14 @@
 {-
 Welcome to a Spago project!
 You can edit this file as you like.
+
+Need help? See the following resources:
+- Spago documentation: https://github.com/purescript/spago
+- Dhall language tour: https://docs.dhall-lang.org/tutorials/Language-Tour.html
+
+When creating a new Spago project, you can use
+`spago init --no-comments` or `spago init -C`
+to generate this file without the comments in this block.
 -}
 { name = "simple-json"
 , dependencies =

diff --git a/test/fixtures/spago-install-failure.dhall b/test/fixtures/spago-install-failure.dhall
@@ -1,6 +1,14 @@
 {-
 Welcome to a Spago project!
 You can edit this file as you like.
+
+Need help? See the following resources:
+- Spago documentation: https://github.com/purescript/spago
+- Dhall language tour: https://docs.dhall-lang.org/tutorials/Language-Tour.html
+
+When creating a new Spago project, you can use
+`spago init --no-comments` or `spago init -C`
+to generate this file without the comments in this block.
 -}
 { name = "aaa"
 , dependencies = [ "console", "effect", "prelude", "psci-support" ]

diff --git a/test/fixtures/spago-install-success.dhall b/test/fixtures/spago-install-success.dhall
@@ -1,6 +1,14 @@
 {-
 Welcome to a Spago project!
 You can edit this file as you like.
+
+Need help? See the following resources:
+- Spago documentation: https://github.com/purescript/spago
+- Dhall language tour: https://docs.dhall-lang.org/tutorials/Language-Tour.html
+
+When creating a new Spago project, you can use
+`spago init --no-comments` or `spago init -C`
+to generate this file without the comments in this block.
 -}
 { name = "aaa"
 , dependencies =

diff --git a/test/fixtures/spago-psc-failure.dhall b/test/fixtures/spago-psc-failure.dhall
@@ -1,6 +1,14 @@
 {-
 Welcome to a Spago project!
 You can edit this file as you like.
+
+Need help? See the following resources:
+- Spago documentation: https://github.com/purescript/spago
+- Dhall language tour: https://docs.dhall-lang.org/tutorials/Language-Tour.html
+
+When creating a new Spago project, you can use
+`spago init --no-comments` or `spago init -C`
+to generate this file without the comments in this block.
 -}
 { name = "aaa"
 , dependencies = [ "console", "effect", "prelude", "psci-support" ]

diff --git a/test/fixtures/spago-psc-success.dhall b/test/fixtures/spago-psc-success.dhall
@@ -1,6 +1,14 @@
 {-
 Welcome to a Spago project!
 You can edit this file as you like.
+
+Need help? See the following resources:
+- Spago documentation: https://github.com/purescript/spago
+- Dhall language tour: https://docs.dhall-lang.org/tutorials/Language-Tour.html
+
+When creating a new Spago project, you can use
+`spago init --no-comments` or `spago init -C`
+to generate this file without the comments in this block.
 -}
 { name = "aaa"
 , dependencies = [ "console", "effect", "prelude", "psci-support" ]