Skip to content

Add more useful comments in spago.dhall #778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 21, 2021
Merged

Add more useful comments in spago.dhall #778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b24cb44
Add more useful info to the `spago.dhall` file
JordanMartinez Apr 19, 2021
9e60706
No longer warn about moving top-level comment
JordanMartinez Apr 19, 2021
af0930d
Include example of adding a new dependency to a list of dependencies
JordanMartinez Apr 19, 2021
99156b8
Merge branch 'master' into updateSpagoComments
f-f Apr 20, 2021
439964c
Address feedback on default spago.dhall file:
JordanMartinez Apr 20, 2021
d395203
Address feedback on `packages.dhall` file
JordanMartinez Apr 20, 2021
866b267
Merge branch 'master' into updateSpagoComments
f-f Apr 20, 2021
2c62301
Update test fixtures
JordanMartinez Apr 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions templates/packages.dhall
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions templates/spago.dhall
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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" ]
Expand Down
8 changes: 1 addition & 7 deletions test/fixtures/packages-older-tag.dhall
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions test/fixtures/spago-bower-import.dhall
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 =
Expand Down
8 changes: 8 additions & 0 deletions test/fixtures/spago-install-failure.dhall
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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" ]
Expand Down
8 changes: 8 additions & 0 deletions test/fixtures/spago-install-success.dhall
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 =
Expand Down
8 changes: 8 additions & 0 deletions test/fixtures/spago-psc-failure.dhall
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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" ]
Expand Down
8 changes: 8 additions & 0 deletions test/fixtures/spago-psc-success.dhall
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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" ]
Expand Down