dillonkearns/elm-pages-v3-beta
1
1
Fork 0
mirror of https://github.com/dillonkearns/elm-pages-v3-beta.git synced 2024-11-25 09:21:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Try a new File API.

Browse Source
This commit is contained in:
Dillon Kearns 2021-05-29 13:42:57 -07:00
parent 43509610d2
commit 9a0dd86919
7 changed files with 184 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs.json
View File

File diff suppressed because one or more lines are too long

4
examples/docs/src/Article.elm
View File

@ -2,7 +2,7 @@ module Article exposing (..)
import Cloudinary
import DataSource
import DataSource.File as StaticFile
import DataSource.File as File
import DataSource.Glob as Glob
import Date exposing (Date)
import OptimizedDecoder
@ -37,7 +37,7 @@ allMetadata =
(\{ filePath, slug } ->
DataSource.map2 Tuple.pair
(DataSource.succeed <| Route.Blog__Slug_ { slug = slug })
(StaticFile.read filePath (StaticFile.frontmatter frontmatterDecoder))
(File.onlyFrontmatter filePath frontmatterDecoder)
)
)
|> DataSource.resolve

11
examples/docs/src/Page/Blog/Slug_.elm
View File

@ -231,21 +231,18 @@ type alias Data =
data : RouteParams -> DataSource.DataSource Data
data route =
StaticFile.read
StaticFile.bodyWithFrontmatter
("content/blog/" ++ route.slug ++ ".md")
(OptimizedDecoder.map2 Data
(StaticFile.body
|> OptimizedDecoder.andThen
(\rawBody ->
rawBody
OptimizedDecoder.map2 Data
(rawBody
|> Markdown.Parser.parse
|> Result.mapError (\_ -> "Couldn't parse markdown.")
|> Result.andThen (Markdown.Renderer.render TailwindMarkdownRenderer.renderer)
--|> Result.map Tuple.second
|> OptimizedDecoder.fromResult
)
)
(StaticFile.frontmatter frontmatterDecoder)
frontmatterDecoder
)

25
examples/docs/src/Page/Docs/Section__.elm
View File

@ -132,9 +132,10 @@ titleForSection section =
Glob.expectUniqueMatch (findBySlug section.slug)
|> DataSource.andThen
(\filePath ->
DataSource.File.read filePath
(markdownBodyDecoder
|> OptimizedDecoder.map
DataSource.File.bodyWithoutFrontmatter filePath
|> DataSource.andThen
markdownBodyDecoder
|> DataSource.map
(\blocks ->
List.Extra.findMap
(\block ->
@ -151,7 +152,6 @@ titleForSection section =
blocks
)
)
)
|> DataSource.andThen
(\maybeTitle ->
maybeTitle
@ -287,11 +287,8 @@ pageBody routeParams =
|> Maybe.withDefault "what-is-elm-pages"
in
Glob.expectUniqueMatch (findBySlug slug)
|> DataSource.andThen
(\filePath ->
DataSource.File.read filePath
markdownBodyDecoder
)
|> DataSource.andThen DataSource.File.bodyWithoutFrontmatter
|> DataSource.andThen markdownBodyDecoder
findBySlug : String -> Glob String
@ -305,13 +302,9 @@ findBySlug slug =
|> Glob.match (Glob.literal ".md")
markdownBodyDecoder : OptimizedDecoder.Decoder (List Block)
markdownBodyDecoder =
DataSource.File.body
|> OptimizedDecoder.andThen
(\rawBody ->
markdownBodyDecoder : String -> DataSource (List Block)
markdownBodyDecoder rawBody =
rawBody
|> Markdown.Parser.parse
|> Result.mapError (\_ -> "Markdown parsing error")
|> OptimizedDecoder.fromResult
)
|> DataSource.fromResult

2
examples/docs/src/Page/Projects.elm
View File

@ -91,7 +91,7 @@ data =
Glob.succeed
(\projectName filePath ->
DataSource.map2 (Project projectName)
(DataSource.File.read filePath DataSource.File.body)
(DataSource.File.rawFile filePath)
(repo projectName)
)
|> Glob.match (Glob.literal "projects/")

14
examples/docs/src/TableOfContents.elm
View File

@ -23,27 +23,23 @@ dataSource docFiles =
sections
|> List.map
(\section ->
DataSource.File.read
DataSource.File.bodyWithoutFrontmatter
section.filePath
(headingsDecoder section.slug)
|> DataSource.andThen (headingsDecoder section.slug)
)
)
|> DataSource.resolve
|> DataSource.map List.reverse
headingsDecoder : String -> OptimizedDecoder.Decoder (Entry Data)
headingsDecoder slug =
DataSource.File.body
|> OptimizedDecoder.andThen
(\rawBody ->
headingsDecoder : String -> String -> DataSource (Entry Data)
headingsDecoder slug rawBody =
rawBody
|> Markdown.Parser.parse
|> Result.mapError (\_ -> "Markdown parsing error")
|> Result.map gatherHeadings
|> Result.andThen (nameAndTopLevel slug)
|> OptimizedDecoder.fromResult
)
|> DataSource.fromResult
nameAndTopLevel :

171
src/DataSource/File.elm
View File

@ -1,32 +1,14 @@
module DataSource.File exposing
( read
, body, frontmatter
( bodyWithFrontmatter, bodyWithoutFrontmatter, onlyFrontmatter
, jsonFile, rawFile
)
{-| This module lets you read files from the local filesystem as a [`DataSource`](DataSource#DataSource).
@docs read
## Files With Frontmatter
## Reading Frontmatter
@docs body, frontmatter
## Reading Files
@docs jsonFile, rawFile
-}
import DataSource exposing (DataSource)
import DataSource.Http
import OptimizedDecoder exposing (Decoder)
import Secrets
{-| Frontmatter is a convention used to keep metadata in a file between `---`'s.
Frontmatter is a convention used to keep metadata at the top of a file between `---`'s.
For example, you might have a file called `blog/hello-world.md` with this content:
@ -38,55 +20,164 @@ draft: true
Hey there! This is my first post :)
```
The frontmatter is in the [YAML format](https://en.wikipedia.org/wiki/YAML) here.
You can also use JSON in your elm-pages frontmatter.
The frontmatter is in the [YAML format](https://en.wikipedia.org/wiki/YAML) here. You can also use JSON in your elm-pages frontmatter.
```markdown
---
{"title": "Hello, World!", "draft": true}
---
Hey there! This is my first post :)
```
Whether it's YAML or JSON, you use an `OptimizedDecoder` to decode your frontmatter, so it feels just like using
plain old JSON in Elm.
@docs bodyWithFrontmatter, bodyWithoutFrontmatter, onlyFrontmatter
## Reading Files Without Frontmatter
@docs jsonFile, rawFile
-}
import DataSource exposing (DataSource)
import DataSource.Http
import OptimizedDecoder exposing (Decoder)
import Secrets
frontmatter : Decoder frontmatter -> Decoder frontmatter
frontmatter frontmatterDecoder =
OptimizedDecoder.field "parsedFrontmatter" frontmatterDecoder
{-|
import DataSource exposing (DataSource)
import DataSource.File as File
import OptimizedDecoder as Decode exposing (Decoder)
blogPost : DataSource ( String, BlogPostMetadata )
blogPost =
File.read "blog/hello-world.md"
(Decode.map2 Tuple.pair
(File.frontmatter blogPostDecoder)
File.body
)
File.bodyWithFrontmatter "blog/hello-world.md"
blogPostDecoder
type alias BlogPostMetadata =
{ title : String
{ body : String
, title : String
, draft : Bool
}
blogPostDecoder : Decoder BlogPostMetadata
blogPostDecoder =
Decode.map2 BlogPostMetadata
blogPostDecoder body =
Decode.map2 (BlogPostMetadata body)
(Decode.field "title" Decode.string)
(Decode.field "draft" Decode.bool)
This will give us a DataSource that results in the following value:
value =
( "Hey there! This is my first post :)"
, { title = "Hello, World!"
{ body = "Hey there! This is my first post :)"
, title = "Hello, World!"
, draft = True
}
It's common to parse the body with a markdown parser or other format.
import DataSource exposing (DataSource)
import DataSource.File as File
import Html exposing (Html)
import OptimizedDecoder as Decode exposing (Decoder)
example :
DataSource
{ title : String
, body : List (Html msg)
}
example =
File.bodyWithFrontmatter "foo.md"
(\markdownString ->
Decode.map2
(\title renderedMarkdown ->
{ title = title
, body = renderedMarkdown
}
)
(Decode.field "title" Decode.string)
(markdownString |> markdownToView |> Decode.fromResult)
)
markdownToView : String -> Result String (List (Html msg))
markdownToView markdownString =
markdownString
|> Markdown.Parser.parse
|> Result.mapError (\_ -> "Markdown parsing error.")
|> Result.andThen
(\blocks ->
Markdown.Renderer.render
Markdown.Renderer.defaultHtmlRenderer
blocks
)
-}
frontmatter : Decoder frontmatter -> Decoder frontmatter
frontmatter frontmatterDecoder =
OptimizedDecoder.field "parsedFrontmatter" frontmatterDecoder
bodyWithFrontmatter : String -> (String -> Decoder frontmatter) -> DataSource frontmatter
bodyWithFrontmatter filePath frontmatterDecoder =
read filePath
(body
|> OptimizedDecoder.andThen
(\bodyString ->
frontmatter (frontmatterDecoder bodyString)
)
)
{-| Gives us the file's content without stripping off frontmatter.
{-| Same as `bodyWithFrontmatter` except it doesn't include the body.
-}
rawFile : Decoder String
rawFile =
OptimizedDecoder.field "rawFile" OptimizedDecoder.string
onlyFrontmatter : String -> Decoder frontmatter -> DataSource frontmatter
onlyFrontmatter filePath frontmatterDecoder =
read filePath
(frontmatter frontmatterDecoder)
{-| Same as `bodyWithFrontmatter` except it doesn't include the frontmatter.
For example, if you have a file called `blog/hello-world.md` with
```markdown
---
{"title": "Hello, World!", "draft": true}
---
Hey there! This is my first post :)
```
import DataSource exposing (DataSource)
data : DataSource String
data =
bodyWithoutFrontmatter "blog/hello-world.md"
Then data will yield the value `"Hey there! This is my first post :)"`.
-}
bodyWithoutFrontmatter : String -> DataSource String
bodyWithoutFrontmatter filePath =
read filePath
body
{-| Get the raw file content. Unlike the frontmatter helpers in this module, this function will not strip off frontmatter if there is any.
This is the function you want if you are reading in a file directly. For example, if you read in a CSV file, a raw text file, or any other file that doesn't
have frontmatter.
There's a special function for reading in JSON files, [`jsonFile`](#jsonFile). If you're reading a JSON file then be sure to
use `jsonFile` to get the benefits of the `OptimizedDecoder` here.
-}
rawFile : String -> DataSource String
rawFile filePath =
read filePath (OptimizedDecoder.field "rawFile" OptimizedDecoder.string)
{-| Read a file as JSON.