-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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
Refactor to prepare for release #14
Merged
Merged
Changes from 9 commits
Commits
Show all changes
32 commits
Select commit
Hold shift + click to select a range
c6fb555
Refactor to prepare for full release
robertdp f8454fc
Update CI
robertdp 3d32e6d
Split up reexports
robertdp 005f117
Expose routing DSL commands
robertdp a516321
Remove unnecessary braces
robertdp be98328
Update readme
robertdp aab911c
Export Driver' alias
robertdp 8a1f9a6
Loosen internal exports
robertdp 6d6af59
More explicit naming
robertdp aa7ee22
Change Driver to a type alias
robertdp 70b35fb
Add back fiber tracking and killing
robertdp 77f7ec1
Update to purs-tidy
robertdp bb5091d
Strip commends from Dhall files
robertdp c644c8e
Flesh out readme
robertdp 606c49f
Add note about symmetry
robertdp ea06c35
Language
robertdp 5bfd1b5
Update routes
robertdp a88f04c
Mention React
robertdp ea47f6f
Fix qualified example
robertdp 249ba1a
Update var name
robertdp ac05db9
Update var name
robertdp 663bef8
Language
robertdp 1147522
Language
robertdp ede2647
Fix hidden code blocks
robertdp 2efb416
Ix qualified exports
robertdp a4f6fdd
Switch to mkInterface pattern
robertdp 54caf80
Fix example bug
robertdp 767d3e3
More detailed nav example
robertdp 27f858c
Fix naming
robertdp 7f3c38f
Clearer language
robertdp 632be04
Simplify the example structure
robertdp 0729dbc
Update example
robertdp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,9 @@ | ||
| # purescript-web-router | ||
|
|
||
| A basic pushstate router for React with support for asynchronous routing logic, built using [react-basic-hooks](https://github.com/spicydonuts/purescript-react-basic-hooks). I recommend [routing-duplex](https://github.com/natefaubion/purescript-routing-duplex) for easy parsing and printing. | ||
| A basic pushstate router for React with support for asynchronous routing logic. I recommend [routing-duplex](https://github.com/natefaubion/purescript-routing-duplex) for easy parsing and printing. | ||
|
|
||
| For a basic example see [here](https://github.com/robertdp/purescript-web-router-example/tree/master/src). | ||
|
|
||
| ## How to use with Spago | ||
|
|
||
| Add `web-router` to your `packages.dhall`: | ||
|
|
||
| ```dhall | ||
| let additions = | ||
| { web-router = | ||
| { dependencies = | ||
| [ "aff" | ||
| , "effect" | ||
| , "freet" | ||
| , "indexed-monad" | ||
| , "prelude" | ||
| , "profunctor-lenses" | ||
| , "routing" | ||
| ] | ||
| , repo = "https://github.com/robertdp/purescript-web-router.git" | ||
| , version = "v0.3.0" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| And then install with | ||
| `$ spago install web-router` | ||
| Install with `$ spago install web-router` (coming soon) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The readme looks... a little different now 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README looks great :-)
Do you think that making a README part of a "test suite" (so we verify whether it still compiles) is feasible and desired?
I mean I use this strategy across my libs just by using something like:
https://github.com/paluh/purescript-homogeneous/blob/master/package.json#L10 (
litpsis really a tool written by @Thimoteus).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If PS supported literate code I'd consider it, but I don't think it's worth the extra effort. The example project using React has also been updated and it compiles, so most of the code in the updated readme was tested there first.
Some unit tests would be good, but can come a bit later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This
litpsprovides support for "literate PS". Maybe I will play around that idea in my... spare time ;-)