diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +1.0.1 + +* Improved jump to definition support + * [Jump to definition on `let` bindings](https://github.com/dhall-lang/dhall-haskell/pull/1966) + * [Jump to definition on `λ` bindings](https://github.com/dhall-lang/dhall-haskell/pull/1982) + * [Jump to definition on record fields](https://github.com/dhall-lang/dhall-haskell/pull/1991) +* [BUG FIX: Support for long path names](https://github.com/dhall-lang/dhall-haskell/pull/1976) +* [BUG FIX: Support for large directory trees](https://github.com/dhall-lang/dhall-haskell/pull/2006) +* [Add `dhall-docs` `man` page](https://github.com/dhall-lang/dhall-haskell/pull/2010) + 1.0.0 * [Generate documentation from header comment](https://github.com/dhall-lang/dhall-haskell/pull/1929) diff --git a/dhall-docs.cabal b/dhall-docs.cabal --- a/dhall-docs.cabal +++ b/dhall-docs.cabal @@ -1,5 +1,5 @@ Name: dhall-docs -Version: 1.0.0 +Version: 1.0.1 Cabal-Version: >=1.10 Build-Type: Simple Tested-With: GHC == 8.6.1 @@ -41,9 +41,10 @@ tasty/data/comments/invalid/*.txt tasty/data/comments/valid/*.txt Data-Files: - *.css - *.js - *.svg + assets/*.css + assets/*.js + assets/*.svg + man/dhall-docs.1 Data-Dir: src/Dhall/data @@ -62,21 +63,23 @@ base >= 4.11.0.0 && < 5 , bytestring < 0.11, containers , + cryptonite < 0.28, directory >= 1.3.0.0 && < 1.4 , - dhall >= 1.34.0 && < 1.35, + dhall >= 1.35.0 && < 1.36, file-embed >= 0.0.10.0 , filepath >= 1.4 && < 1.5 , lens-family-core >= 1.0.0 && < 2.2 , lucid >= 2.9.12 && < 2.10, mmark >= 0.0.7.0 && < 0.8 , - megaparsec >= 7 && < 8.1 , + megaparsec >= 7 && < 9.1 , + memory < 0.16, path >= 0.7.0 && < 0.9 , path-io >= 1.6.0 && < 1.7 , prettyprinter >= 1.5.1 && < 1.8 , - tar >= 0.5.1.0 && < 0.6 , text >= 0.11.1.0 && < 1.3 , + transformers >= 0.2.0.0 && < 0.6 , mtl >= 2.2.1 && < 2.3 , - optparse-applicative >= 0.14.0.0 && < 0.16 + optparse-applicative >= 0.14.0.0 && < 0.17 Exposed-Modules: Dhall.Docs Dhall.Docs.Core diff --git a/src/Dhall/Docs/CodeRenderer.hs b/src/Dhall/Docs/CodeRenderer.hs --- a/src/Dhall/Docs/CodeRenderer.hs +++ b/src/Dhall/Docs/CodeRenderer.hs @@ -1,9 +1,28 @@ +{-# LANGUAGE LambdaCase #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE ViewPatterns #-} {-| Contains the logic to render the source code inside a HTML. It also provides - context-sensitive features such as jump-to-definition + context-sensitive features such as jump-to-definition. + + Rendering an expression consists on the following steps: + + * An 'Expr Src Import' with its parsed 'Text' is processed into + a '[SourceCodeFragment]' + * Each 'SourceCodeFragment' tells the 'renderSourceCodeFragment' how to + render that function as HTML including the injected information through + HTML data-attributes + + To render a Dhall file you should use 'renderCodeWithHyperLinks' which + takes a 'Text' that was used to parse the 'Expr Src Import', and returns + the generated 'Html ()' with the same structure (i.e. whitespaces) + from the 'Text' argument. + + To render code-snippets (e.g. assertions from examples, type from source code) + you should use 'renderCodeSnippet' which uses the output of @dhall format@ + as the 'Text' argument to call later 'renderCodeWithHyperLinks' -} module Dhall.Docs.CodeRenderer ( renderCodeWithHyperLinks @@ -11,26 +30,40 @@ , ExprType(..) ) where -import Data.Text (Text) -import Data.Void (Void) +import Control.Monad.Trans.Writer.Strict (Writer) +import Data.Text (Text) +import Data.Void (Void) +import Dhall.Context (Context) import Dhall.Core - ( Expr (..) + ( Binding (..) + , Expr (..) + , FieldSelection (..) , File (..) , FilePrefix (..) + , FunctionBinding (..) , Import (..) , ImportHashed (..) , ImportType (..) + , RecordField (..) , Scheme (..) , URL (..) + , Var (..) ) import Dhall.Docs.Util -import Dhall.Src (Src (..)) +import Dhall.Src (Src (..)) import Lucid +import Text.Megaparsec.Pos (SourcePos (..)) -import qualified Data.Text +import qualified Control.Monad.Trans.Writer.Strict as Writer +import qualified Data.Maybe as Maybe +import qualified Data.List +import qualified Data.Set as Set +import qualified Data.Text as Text import qualified Data.Text.Prettyprint.Doc as Pretty import qualified Data.Text.Prettyprint.Doc.Render.Text as Pretty.Text +import qualified Dhall.Context as Context import qualified Dhall.Core as Core +import qualified Dhall.Map as Map import qualified Dhall.Parser import qualified Dhall.Pretty import qualified Lens.Family as Lens @@ -40,108 +73,321 @@ -- >>> :set -XOverloadedStrings -- >>> import Dhall.Core (Directory (..)) --- | Given a Dhall expression return all imports with their location on the file. --- Contents are already sorted by 'Src', which allows 'renderAsHtml' to traverse --- the return of this function to inject anchors -getImports :: Expr Src Import -> [(Src, Import)] -getImports (Note src (Embed a)) = [(src, a)] -getImports expr = concatMap getImports $ Lens.toListOf Core.subExpressions expr +-- | Get the source line and column from a 'SourcePos' as an 'Int' +getSourceLine, getSourceColumn :: SourcePos -> Int +getSourceLine = SourcePos.unPos . SourcePos.sourceLine +getSourceColumn = SourcePos.unPos . SourcePos.sourceColumn +{-| Every 'Expr' constructor has extra information that tell us what to highlight on + hover and where to jump on click events. 'JtdInfo' record that extra + information. +-} +data JtdInfo + {-| Each field in a Dhall record (type or literal) is associated with a + 'NameDecl', and selector-expressions behave like 'Var's by using a + 'NameUse' with the field 'NameDecl' to jump to that label. + + For example, a Dhall expression like this: + + > { a = foo, b = bar } + + has the following 'JtdInfo': + + > RecordFields (Set.fromList [NameDecl posA "a" jtdInfoA, NameDecl posB "b" jtdInfoB]) + + ... where + + * @posA@ and @posB@ record the source position used to make them + unique across the rendered source code + * @jtdInfoA@ and @jtdInfoB@ are the associated 'JtdInfo' inferred from + @foo@ and @bar@ + -} + = RecordFields (Set.Set NameDecl) + -- | Default type for cases we don't handle + | NoInfo + deriving (Eq, Ord, Show) + +{-| To make each name unique we record the source position where it was + found. + + The names that we handle are the ones introduced by let-bindings, lambda + arguments and record (types and literals) labels. +-} +data NameDecl = NameDecl Src Text JtdInfo + deriving (Eq, Ord, Show) + +makeHtmlId :: NameDecl -> Text +makeHtmlId (NameDecl Src{srcStart} _ _) = + "var" + <> Text.pack (show $ getSourceLine srcStart) <> "-" + <> Text.pack (show $ getSourceColumn srcStart) + +-- | Available ways of rendering source code as HTML +data SourceCodeType + -- | Relative and remote imports are rendered using an HTML anchor tag. + -- Other imports are rendered as plain-text + = ImportExpr Import + + -- | Used to render a name declared in let-binding or function argument + -- that is used in any expression + | NameUse NameDecl + + -- | Used to render the declaration of a name. This is used to jump + -- to that name after clicking an 'NameUse' + | NameDeclaration NameDecl + +{-| The 'Expr Src Import' parsed from a 'Text' is split into a + '[SourceCodeFragment]'. +-} +data SourceCodeFragment = + SourceCodeFragment + Src -- ^ The start and end position of this fragment + SourceCodeType -- ^ The type of 'SourceCodeFragment' that will guide HTML rendering + +-- | Returns all 'SourceCodeFragment's in lexicographic order i.e. in the same +-- order as in the source code. +fragments :: Expr Src Import -> [SourceCodeFragment] +fragments = Data.List.sortBy sorter . removeUnusedDecls . Writer.execWriter . infer Context.empty + where + sorter (SourceCodeFragment Src{srcStart = srcStart0} _) + (SourceCodeFragment Src{srcStart = srcStart1} _) = pos0 `compare` pos1 + where + pos0 = (getSourceLine srcStart0, getSourceColumn srcStart0) + pos1 = (getSourceLine srcStart1, getSourceColumn srcStart1) + + removeUnusedDecls sourceCodeFragments = filter isUsed sourceCodeFragments + where + makePosPair Src{srcStart} = (getSourceLine srcStart, getSourceColumn srcStart) + nameUsePos (SourceCodeFragment _ (NameUse (NameDecl src _ _))) = + Just $ makePosPair src + nameUsePos _ = Nothing + + usedNames = Set.fromList $ Maybe.mapMaybe nameUsePos sourceCodeFragments + + isUsed (SourceCodeFragment _ (NameDeclaration (NameDecl src _ _))) = + makePosPair src `Set.member` usedNames + isUsed _ = True + + infer :: Context NameDecl -> Expr Src Import -> Writer [SourceCodeFragment] JtdInfo + infer context = \case + -- The parsed text of the import is located in it's `Note` constructor + Note src (Embed a) -> Writer.tell [SourceCodeFragment src $ ImportExpr a] >> return NoInfo + + -- since we have to 'infer' the 'JtdInfo' of the annotation, we + -- are not able to generate the 'SourceCodeFragment's in lexicographical + -- without calling 'Data.List.sortBy' after + Let (Binding + (Just Src { srcEnd = srcEnd0 }) + name + (Just Src { srcStart = srcStart1 }) + annotation + _ + value) expr' -> do + + -- If annotation is missing, the type is inferred from the bound value + case annotation of + Nothing -> return () + Just (_, t) -> do + _ <- infer context t + return () + + bindingJtdInfo <- infer context value + + let nameSrc = makeSrcForLabel srcEnd0 srcStart1 name + let nameDecl = NameDecl nameSrc name bindingJtdInfo + + Writer.tell [SourceCodeFragment nameSrc (NameDeclaration nameDecl)] + infer (Context.insert name nameDecl context) expr' + + Note src (Var (V name index)) -> + case Context.lookup name index context of + Nothing -> return NoInfo + Just nameDecl@(NameDecl _ _ t) -> do + Writer.tell [SourceCodeFragment src $ NameUse nameDecl] + return t + + Lam (FunctionBinding + (Just Src{srcEnd = srcEnd0}) + name + (Just Src{srcStart = srcStart1}) + _ + t) expr -> do + dhallType <- infer context t + + let nameSrc = makeSrcForLabel srcEnd0 srcStart1 name + let nameDecl = NameDecl nameSrc name dhallType + + Writer.tell [SourceCodeFragment nameSrc (NameDeclaration nameDecl)] + infer (Context.insert name nameDecl context) expr + + Field e (FieldSelection (Just Src{srcEnd=posStart}) label (Just Src{srcStart=posEnd})) -> do + fields <- do + dhallType <- infer context e + case dhallType of + NoInfo -> return mempty + RecordFields s -> return $ Set.toList s + + let src = makeSrcForLabel posStart posEnd label + let match (NameDecl _ l _) = l == label + case filter match fields of + x@(NameDecl _ _ t) : _ -> do + Writer.tell [SourceCodeFragment src (NameUse x)] + return t + _ -> return NoInfo + + RecordLit (Map.toList -> l) -> handleRecordLike l + + Record (Map.toList -> l) -> handleRecordLike l + + Note _ e -> infer context e + e -> do + mapM_ (infer context) $ Lens.toListOf Core.subExpressions e + return NoInfo + + where + handleRecordLike l = RecordFields . Set.fromList <$> mapM f l + where + f (key, RecordField (Just Src{srcEnd = startPos}) val (Just Src{srcStart = endPos}) _) = do + dhallType <- infer context val + let nameSrc = makeSrcForLabel startPos endPos key + let nameDecl = NameDecl nameSrc key dhallType + Writer.tell [SourceCodeFragment nameSrc (NameDeclaration nameDecl)] + return nameDecl + where + f _ = fileAnIssue "A `RecordField` of type `Expr Src Import` doesn't have `Just src*`" + fileAsText :: File -> Text fileAsText File{..} = foldr (\d acc -> acc <> "/" <> d) "" (Core.components directory) <> "/" <> file -{-| Given an 'Import', render the contents in an HTML element that will allow - users to jump to another file or domain. The 'Text' argument is the contents - inside the anchor tag +-- | Generic way of creating a Src for a label, taking quoted names into +-- account +makeSrcForLabel + :: SourcePos -- ^ Prefix whitespace end position, will be 'srcStart' + -> SourcePos -- ^ Suffix whitespace start position, will be 'srcEnd' + -> Text -- ^ Label name, will be the 'srcText' with surrounding @`@ if needed + -> Src +makeSrcForLabel srcStart srcEnd name = Src {..} + where + realLength = getSourceColumn srcEnd - getSourceColumn srcStart + srcText = + if Text.length name == realLength then name + else "`" <> name <> "`" - Example: +renderSourceCodeFragment :: SourceCodeFragment -> Html () +renderSourceCodeFragment (SourceCodeFragment Src{..} (ImportExpr import_)) = + renderImport import_ srcText + where + {- Given an 'Import', render the contents in an HTML element that will allow + users to jump to another file or domain. The 'Text' argument is the contents + inside the anchor tag - >>> :set -Wno-missing-fields - >>> let file = File { directory = Directory [], file = ""} - >>> let url = URL { scheme = HTTPS, authority = "google.com", query = Nothing, path = file} - >>> let import_ = Import {importHashed = ImportHashed { importType = Remote url }} - >>> renderImport import_ "link for google" - link for google --} -renderImport :: Import -> Text -> Html () -renderImport (Import {importHashed = ImportHashed { importType }}) = - case importType of - Remote URL {..} -> a_ [href_ href, target_ "_blank"] . toHtml - where - scheme_ = case scheme of - HTTP -> "http" - HTTPS -> "https" + Example: - path_ = fileAsText path + >>> :set -Wno-missing-fields + >>> let file = File { directory = Directory [], file = ""} + >>> let url = URL { scheme = HTTPS, authority = "google.com", query = Nothing, path = file} + >>> let import_ = Import {importHashed = ImportHashed { importType = Remote url }} + >>> renderImport import_ "link for google" + link for google + -} + renderImport :: Import -> Text -> Html () + renderImport (Import {importHashed = ImportHashed { importType }}) = + case importType of + Remote URL {..} -> a_ [href_ href, target_ "_blank"] . toHtml + where + scheme_ = case scheme of + HTTP -> "http" + HTTPS -> "https" - query_ = case query of - Nothing -> "" - Just d -> "?" <> d + path_ = fileAsText path - -- we don't include the headers here since we treat links to open a file - -- in another tab - href = scheme_ <> "://" <> authority <> path_ <> query_ + query_ = case query of + Nothing -> "" + Just d -> "?" <> d - Local Here file -> a_ [href_ href] . toHtml - where - href = "." <> fileAsText file <> ".html" + -- we don't include the headers here since we treat links to open a file + -- in another tab + href = scheme_ <> "://" <> authority <> path_ <> query_ - Local Parent file -> a_ [href_ href] . toHtml - where - href = ".." <> fileAsText file <> ".html" + Local Here file -> a_ [href_ href] . toHtml + where + href = "." <> fileAsText file <> ".html" - _ -> toHtml + Local Parent file -> a_ [href_ href] . toHtml + where + href = ".." <> fileAsText file <> ".html" + _ -> toHtml + +renderSourceCodeFragment (SourceCodeFragment Src{..} (NameDeclaration nameDecl)) = + span_ attributes $ toHtml srcText + where + attributes = + [id_ $ makeHtmlId nameDecl + , class_ "name-decl" + , data_ "name" $ makeHtmlId nameDecl ] +renderSourceCodeFragment (SourceCodeFragment Src{..} (NameUse nameDecl)) = + a_ attributes $ toHtml srcText + where + attributes = + [ href_ $ "#" <> makeHtmlId nameDecl + , class_ "name-use" + , data_ "name" $ makeHtmlId nameDecl + ] + -- | Given a Text and the parsed `Expr Src Import` from it, this will render the -- the source code on HTML with jump-to-definition on URL imports. Use this -- to render the source code with the same structure (whitespaces, comments, -- language elements) as the source file renderCodeWithHyperLinks :: Text -> Expr Src Import -> Html () -renderCodeWithHyperLinks contents expr = pre_ $ go (1, 1) (Data.Text.lines contents) imports +renderCodeWithHyperLinks contents expr = pre_ $ go (1, 1) (Text.lines contents) imports where - imports = getImports expr + imports = fragments expr -- we keep the current line, column and consumed text as part of function argument - go :: (Int, Int) -> [Text] -> [(Src, Import)] -> Html () + go :: (Int, Int) -> [Text] -> [SourceCodeFragment] -> Html () go _ textLines [] = mapM_ (\t -> toHtml t >> br_ []) textLines - go (currLine, currCol) currentLines ((Src {..}, import_) : rest) = do - let sourceLine = SourcePos.unPos . SourcePos.sourceLine - let sourceColumn = SourcePos.unPos . SourcePos.sourceColumn - let importStartLine = sourceLine srcStart - let importEndLine = sourceLine srcEnd + -- consume lines until we encounter the first 'SourceCodeFragment' + go (currLineNumber, _) (currLine : restLines) scfs@((SourceCodeFragment Src {..} _) : _) + | getSourceLine srcStart /= currLineNumber = do + toHtml currLine + br_ [] + go (currLineNumber + 1, 1) restLines scfs - let importStartCol = sourceColumn srcStart - let importEndCol = sourceColumn srcEnd + go (_, currCol) currentLines (scf@(SourceCodeFragment Src {..} _) : rest) = do + let importStartLine = getSourceLine srcStart + let importEndLine = getSourceLine srcEnd - let (prefixLines, restLines) = splitAt (importStartLine - currLine) currentLines - let (importLines, suffixLines) = splitAt (importStartLine - importStartLine + 1) restLines + let importStartCol = getSourceColumn srcStart + let importEndCol = getSourceColumn srcEnd + let (importLines, suffixLines) = splitAt (importEndLine - importStartLine + 1) currentLines + -- calls to `head` and `last` here should never fail since `importLines` -- have at least one element let (firstImportLine, lastImportLine) = (head importLines, last importLines) - let prefixCols = Data.Text.take (importStartCol - currCol) firstImportLine - let suffixCols = Data.Text.drop (importEndCol - currCol) lastImportLine + let prefixCols = Text.take (importStartCol - currCol) firstImportLine + let suffixCols = Text.drop (importEndCol - currCol) lastImportLine - -- prefix lines and columns - mapM_ (\t -> toHtml t >> br_ []) prefixLines + -- render the prefix column toHtml prefixCols - -- rendered import - renderImport import_ srcText + -- rendered element + renderSourceCodeFragment scf -- add a newline if last line of import consumes the remaining line on -- the original text - if Data.Text.null suffixCols then br_ [] else return () + if Text.null suffixCols then br_ [] else return () - let suffix = if Data.Text.null suffixCols then suffixLines else suffixCols : suffixLines + let suffix = if Text.null suffixCols then suffixLines else suffixCols : suffixLines -- move the cursor to next line if no characterse are remaining on the -- suffix cols, otherwise keep the last line and next char right after -- the import. This is done to handle properly several imports on the -- same line - let nextPosition = if Data.Text.null suffixCols then + let nextPosition = if Text.null suffixCols then (importEndLine + 1, 1) else (importEndLine, importEndCol) @@ -151,8 +397,9 @@ -- or the whole file data ExprType = TypeAnnotation | AssertionExample --- | Renders an AST /fragment/ from the source file AST. Use this only for that --- purpose. The difference between this and 'renderCodeWithHyperLinks' is because that +-- | Renders an AST /fragment/ from the source file AST. Use this when you don't +-- have access to the 'Text' that was used to generate the AST. +-- The difference between this and 'renderCodeWithHyperLinks' is that -- the extracted fragment's 'SourcePos's need to be re-generated to -- render them in a better way; just adding whitespace at the beginning of the -- first line won't render good results. @@ -171,12 +418,10 @@ Right e -> e Left _ -> fileAnIssue "A failure has occurred while parsing a formatted file" - typeLayout :: Pretty.Doc ann -> Pretty.SimpleDocStream ann typeLayout = Pretty.removeTrailingWhitespace . Pretty.layoutSmart opts where -- this is done so the type of a dhall file fits in a single line -- its a safe value, since types in source codes are not that large - opts :: Pretty.LayoutOptions opts = Pretty.defaultLayoutOptions { Pretty.layoutPageWidth = Pretty.Unbounded diff --git a/src/Dhall/Docs/Comment.hs b/src/Dhall/Docs/Comment.hs --- a/src/Dhall/Docs/Comment.hs +++ b/src/Dhall/Docs/Comment.hs @@ -27,7 +27,6 @@ import qualified Data.List.NonEmpty as NonEmpty import qualified Data.Maybe as Maybe import qualified Data.Text -import qualified Dhall.Parser.Expression as Expression import qualified Dhall.Parser.Token as Token import qualified Text.Megaparsec import qualified Text.Megaparsec.Pos as Megaparsec.Pos @@ -93,7 +92,7 @@ | otherwise = (x :| [], ys) singleLine = do - sourcePos <- Expression.getSourcePos + sourcePos <- Text.Megaparsec.getSourcePos commentLine <- Token.lineComment whitespace pure (sourcePos, commentLine) diff --git a/src/Dhall/Docs/Embedded.hs b/src/Dhall/Docs/Embedded.hs --- a/src/Dhall/Docs/Embedded.hs +++ b/src/Dhall/Docs/Embedded.hs @@ -29,14 +29,14 @@ getDataDir :: IO [(Path Rel File, ByteString)] #if defined(EMBED) -getDataDir = mapM f $(embedDir "src/Dhall/data") +getDataDir = mapM f $(embedDir "src/Dhall/data/assets") where f :: (FilePath, ByteString) -> IO (Path Rel File, ByteString) f (filePath, contents) = (,contents) <$> Path.parseRelFile filePath #else getDataDir = do dir <- Path.parent - <$> (getDataFileName "src/Dhall/data/index.css" >>= Path.parseAbsFile) + <$> (getDataFileName "src/Dhall/data/assets/index.css" >>= Path.parseAbsFile) files <- snd <$> Path.IO.listDir dir Control.Monad.forM files $ \file -> do contents <- ByteString.readFile $ Path.fromAbsFile file diff --git a/src/Dhall/Docs/Store.hs b/src/Dhall/Docs/Store.hs --- a/src/Dhall/Docs/Store.hs +++ b/src/Dhall/Docs/Store.hs @@ -1,19 +1,21 @@ -{-| Utilities to interact with the dhall-docs home directory --} +-- | Utilities to interact with the dhall-docs home directory + {-# OPTIONS_GHC -Wno-unused-imports #-} {-# LANGUAGE QuasiQuotes #-} - module Dhall.Docs.Store (getDocsHomeDirectory, makeHashForDirectory) where -import Dhall.Crypto (SHA256Digest (..), sha256Hash) -import Path (Abs, Dir, Path, Rel) +import Crypto.Hash (Digest, SHA256) +import Dhall.Crypto (SHA256Digest (..)) +import Path (Abs, Dir, Path, Rel, ()) import Path.IO (XdgDirectory (..)) -import qualified Codec.Archive.Tar as Tar -import qualified Codec.Archive.Tar.Entry as Tar.Entry -import qualified Data.ByteString.Lazy -import qualified Data.List +import qualified Control.Monad as Monad +import qualified Crypto.Hash as Hash +import qualified Data.ByteArray as ByteArray +import qualified Data.ByteString as ByteString +import qualified Data.ByteString.Char8 as ByteString.Char8 +import qualified Data.List as List import qualified Path import qualified Path.IO @@ -37,12 +39,27 @@ -} makeHashForDirectory :: Path Abs Dir -> IO SHA256Digest makeHashForDirectory dir = do - -- Builds a map so key order is preserved between several calls - files <- Data.List.sort . map Path.fromRelFile . snd - <$> Path.IO.listDirRecurRel dir + (dirs, files) <- Path.IO.listDirRecurRel dir - let setTimeToZero entry = entry{Tar.Entry.entryTime = 0} - inMemoryTarBytes <- Data.ByteString.Lazy.toStrict . Tar.write . map setTimeToZero - <$> Tar.pack (Path.fromAbsDir dir) files + let context0 = Hash.hashInit - return $ sha256Hash inMemoryTarBytes + let addDir context directory = do + let nameBytes = ByteString.Char8.pack (Path.toFilePath directory) + + return $! Hash.hashUpdate context nameBytes + + context1 <- Monad.foldM addDir context0 (List.sort dirs) + + let addFile context file = do + let nameBytes = ByteString.Char8.pack (Path.toFilePath file) + + contentBytes <- ByteString.readFile (Path.toFilePath (dir file)) + + return $! Hash.hashUpdates context [ nameBytes, contentBytes ] + + context2 <- Monad.foldM addFile context1 (List.sort files) + + let digest :: Digest SHA256 + digest = Hash.hashFinalize context2 + + return (SHA256Digest (ByteArray.convert digest)) diff --git a/src/Dhall/data/assets/dhall-icon.svg b/src/Dhall/data/assets/dhall-icon.svg new file mode 100644 --- /dev/null +++ b/src/Dhall/data/assets/dhall-icon.svg @@ -0,0 +1,1 @@ + diff --git a/src/Dhall/data/assets/index.css b/src/Dhall/data/assets/index.css new file mode 100644 --- /dev/null +++ b/src/Dhall/data/assets/index.css @@ -0,0 +1,221 @@ +/******** Common rules ********/ + +body { + padding: 0; + margin: 0; + background-color: #EBEBEB; + transition: 0.5s; +} + +body * { + font-family: 'Lato', sans-serif; +} + +a { + transition: 0.5s; + color: #008489; +} + +a:visited { + color: #914669; +} + +a:active { + color: #FFA632; +} + +/******** Markdown specific code ********/ + +code { + font-family: 'Fira Code', monospace; +} + +blockquote { + border-left: 9px solid #aaa; + background-color: #bdbdbd; + padding: 0.2rem; + color: #616161; +} + +/******** Nav bar **********/ + +.nav-bar { + display: flex; + align-items: center; + padding: 0.3rem; + background-color: #484848; + color: #EBEBEB; + transition: 0.5s; +} + +.nav-bar .dhall-icon { + max-width: 2.5rem; + margin: 0.5rem; +} + +.nav-bar .package-title { + font-size: 1.3rem; + margin: 0; + margin-left: 1rem; +} + +.nav-bar a.nav-option { + font-size: 1rem; + height: 100%; + margin: 0 0.5rem; + cursor: pointer; + transition: 0.5s; + text-decoration: none; +} + +.nav-bar a.nav-option:hover { + text-decoration: underline; + text-decoration-color: #EBEBEB; +} + +.nav-bar a.nav-option:active, .nav-bar a.nav-option, .nav-bar a.nav-option:visited { + color: #EBEBEB; +} + +.nav-bar .nav-bar-content-divider { + flex: 1; +} + +/******** Main content **********/ + +.main-container { + padding: 2rem; + padding-top: 0; + transition: 0.5s; +} + +h2.doc-title span, h2.doc-title a { + font-family: 'Fira Code', monospace; +} + +span.crumb-divider:first-child { + margin-left: 0; +} + +span.crumb-divider { + margin: 0 0.5rem; +} + +a.title-crumb { + text-decoration: none; +} + +a.title-crumb:hover { + text-decoration: underline; +} + +a.copy-to-clipboard { + margin-top: 0; + color: #888 !important; + user-select: none; + cursor: pointer; + text-decoration: none; +} + +a.copy-to-clipboard:hover { + text-decoration: underline; +} + +h2.doc-title { + margin-bottom: 0; +} + +/******** Source code **********/ + + +.code-examples > pre { + padding-top: 0 !important; + padding-bottom: 0 !important; +} + +.source-code { + padding: 0rem; +} + +.source-code pre { + padding: 1rem; + font-family: 'Fira Code', monospace; + color: #333333; +} + +.source-code span { + font-family: 'Fira Code', monospace; + color: #333333; +} + +.source-code span.name-decl { + border-bottom: 1px solid #bdbdbd; +} + +.source-code a { + transition: 0s; + font-family: 'Fira Code', monospace; +} + +.source-code a.name-use { + text-decoration: none; + color: inherit; + border-bottom: 1px solid #bdbdbd; +} + +.source-code .highlighted { + background-color: #bdbdbd !important; +} + +.dhall-type { + font-family: 'Fira Code', monospace; +} + +.dhall-type pre { + display: inline; + padding: 0; +} + +span.of-type-token { + margin-left: 0.5rem; + margin-right: 0.5rem; +} + +/******** Dark mode styling ********/ + +.dark-mode .main-container { + color: #EBEBEB; +} + +body.dark-mode { + background-color: #484848; +} + +.dark-mode .nav-bar { + background-color: #5d5d5d; +} + +.dark-mode a { + color: #FFA632; +} + +.dark-mode a:visited { + color: #008489; +} + +.dark-mode a:active { + color: #914669; +} + +.dark-mode .source-code pre { + color: #D4D4D4; +} + +.dark-mode .source-code span { + color: #D4D4D4; +} + + +.dark-mode a.copy-to-clipboard { + color: #bdbdbd !important; +} diff --git a/src/Dhall/data/assets/index.js b/src/Dhall/data/assets/index.js new file mode 100644 --- /dev/null +++ b/src/Dhall/data/assets/index.js @@ -0,0 +1,53 @@ +const DARK_MODE_OPT = 'dark-mode' +const DARK_MODE_ACTIVE = 'dark-mode-active' +const DARK_MODE_INACTIVE = 'dark-mode-inactive' + +function onReady() { + if (localStorage.getItem(DARK_MODE_OPT) == DARK_MODE_ACTIVE) { + document.body.classList.add('dark-mode') + } else { + document.body.classList.remove('dark-mode') + } + document.getElementById('switch-light-dark-mode') + .addEventListener('click', () => { + document.body.classList.toggle('dark-mode') + if (document.body.classList.contains('dark-mode')) { + localStorage.setItem(DARK_MODE_OPT, DARK_MODE_ACTIVE) + } else { + localStorage.setItem(DARK_MODE_OPT, DARK_MODE_INACTIVE) + } + }) + + document.querySelectorAll('a.copy-to-clipboard').forEach(node => + node.addEventListener('click', () => { + const temp = document.createElement('input') + document.body.append(temp) + temp.value = node.dataset.path + temp.select() + document.execCommand("copy"); + temp.remove() + })) + + document.querySelectorAll('.source-code a.name-use, .source-code span.name-decl') + .forEach(node => { + node.addEventListener('mouseover', () => highlightNames(node.dataset.name, true)) + node.addEventListener('mouseout', () => highlightNames(node.dataset.name, false)) + }) +} + +function highlightNames(varId, highlight) { + document.querySelectorAll(`#${varId}, [href="#${varId}"]`).forEach(node => { + if (highlight) { + node.classList.add('highlighted') + } else { + node.classList.remove('highlighted') + } + }) +} + + +if (document.readyState != 'loading'){ + onReady(); +} else { + document.addEventListener('DOMContentLoaded', onReady); +} diff --git a/src/Dhall/data/dhall-icon.svg b/src/Dhall/data/dhall-icon.svg deleted file mode 100644 --- a/src/Dhall/data/dhall-icon.svg +++ /dev/null @@ -1,1 +0,0 @@ - diff --git a/src/Dhall/data/index.css b/src/Dhall/data/index.css deleted file mode 100644 --- a/src/Dhall/data/index.css +++ /dev/null @@ -1,229 +0,0 @@ -/* - primary-color: #C4C4C4 - secondary-color: #EBEBEB - accent-color1: #FFA632 - accent-color2: #008489 - accent-color3: #914669 -*/ - -/******** Common rules ********/ - -body { - padding: 0; - margin: 0; - background-color: #EBEBEB; - transition: 0.5s; -} - -body * { - font-family: 'Lato', sans-serif; -} - -a { - transition: 0.5s; - color: #008489; -} - -a:visited { - color: #914669; -} - -a:active { - color: #FFA632; -} - -/******** Markdown specific code ********/ - -code { - font-family: 'Fira Code', monospace; -} - -blockquote { - border-left: 9px solid #aaa; - background-color: #bdbdbd; - padding: 0.2rem; - color: #616161; -} - -/******** Nav bar **********/ - -.nav-bar { - display: flex; - align-items: center; - padding: 0.3rem; - background-color: #484848; - color: #EBEBEB; - transition: 0.5s; -} - -.nav-bar .dhall-icon { - max-width: 2.5rem; - margin: 0.5rem; -} - -.nav-bar .package-title { - font-size: 1.3rem; - margin: 0; - margin-left: 1rem; -} - -.nav-bar a.nav-option { - font-size: 1rem; - height: 100%; - margin: 0 0.5rem; - cursor: pointer; - transition: 0.5s; - text-decoration: none; -} - -.nav-bar a.nav-option:hover { - text-decoration: underline; - text-decoration-color: #EBEBEB; -} - -.nav-bar a.nav-option:active, .nav-bar a.nav-option, .nav-bar a.nav-option:visited { - color: #EBEBEB; -} - -.nav-bar .nav-bar-content-divider { - flex: 1; -} - -/******** Main content **********/ - -.main-container { - padding: 2rem; - padding-top: 0; - transition: 0.5s; -} - -h2.doc-title span, h2.doc-title a { - font-family: 'Fira Code', monospace; -} - -span.crumb-divider:first-child { - margin-left: 0; -} - -span.crumb-divider { - margin: 0 0.5rem; -} - -a.title-crumb { - text-decoration: none; -} - -a.title-crumb:hover { - text-decoration: underline; -} - -a.copy-to-clipboard { - margin-top: 0; - color: #888 !important; - user-select: none; - cursor: pointer; - text-decoration: none; -} - -a.copy-to-clipboard:hover { - text-decoration: underline; -} - -h2.doc-title { - margin-bottom: 0; -} - -/******** Source code **********/ - - -.code-examples > pre { - padding-top: 0 !important; - padding-bottom: 0 !important; -} - -.source-code { - padding: 0rem; -} - -.source-code pre { - padding: 1rem; - font-family: 'Fira Code', monospace; - color: #333333; -} - -.source-code span { - font-family: 'Fira Code', monospace; - color: #333333; -} - -.source-code a { - font-family: 'Fira Code', monospace; -} - -.dhall-type { - font-family: 'Fira Code', monospace; -} - -.dhall-type pre { - display: inline; - padding: 0; -} - -span.of-type-token { - margin-left: 0.5rem; - margin-right: 0.5rem; -} - -/******** Dark mode styling ********/ - -.dark-mode .main-container { - color: #EBEBEB; -} - -body.dark-mode { - background-color: #484848; -} - -.dark-mode .nav-bar { - background-color: #5d5d5d; -} - -.dark-mode a { - color: #FFA632; -} - -.dark-mode a:visited { - color: #008489; -} - -.dark-mode a:active { - color: #914669; -} - -.dark-mode .source-code pre { - color: #D4D4D4; -} - -.dark-mode .source-code span { - color: #D4D4D4; -} - -.dark-mode .source-code span.dhall-keyword { - color: #569CD6; -} - -.dark-mode .source-code span.dhall-syntax { - color: #C586C0; -} - -.dark-mode .source-code span.dhall-literal { - color: #B5CEA8; -} - -.dark-mode .source-code span.dhall-builtin { - color: #4EC9B0; -} - -.dark-mode a.copy-to-clipboard { - color: #bdbdbd !important; -} diff --git a/src/Dhall/data/index.js b/src/Dhall/data/index.js deleted file mode 100644 --- a/src/Dhall/data/index.js +++ /dev/null @@ -1,36 +0,0 @@ -const DARK_MODE_OPT = 'dark-mode' -const DARK_MODE_ACTIVE = 'dark-mode-active' -const DARK_MODE_INACTIVE = 'dark-mode-inactive' - -function onReady() { - if (localStorage.getItem(DARK_MODE_OPT) == DARK_MODE_ACTIVE) { - document.body.classList.add('dark-mode') - } else { - document.body.classList.remove('dark-mode') - } - document.getElementById('switch-light-dark-mode') - .addEventListener('click', () => { - document.body.classList.toggle('dark-mode') - if (document.body.classList.contains('dark-mode')) { - localStorage.setItem(DARK_MODE_OPT, DARK_MODE_ACTIVE) - } else { - localStorage.setItem(DARK_MODE_OPT, DARK_MODE_INACTIVE) - } - }) - - document.querySelectorAll('a.copy-to-clipboard').forEach(node => - node.addEventListener('click', () => { - const temp = document.createElement('input') - document.body.append(temp) - temp.value = node.dataset.path - temp.select() - document.execCommand("copy"); - temp.remove() - })) -} - -if (document.readyState != 'loading'){ - onReady(); -} else { - document.addEventListener('DOMContentLoaded', onReady); -} diff --git a/src/Dhall/data/man/dhall-docs.1 b/src/Dhall/data/man/dhall-docs.1 new file mode 100644 --- /dev/null +++ b/src/Dhall/data/man/dhall-docs.1 @@ -0,0 +1,36 @@ +.\" Automatically generated by Pandoc 2.10.1 +.\" +.TH "dhall-docs (1)" "" "" "" "" +.hy +.SH NAME +.PP +dhall-docs - Dhall documentation tool +.SH DESCRIPTION +.PP +\f[B]dhall-docs\f[R] is a documentation generator for the Dhall language +.SH SYNOPSIS +.PP +dhall-docs --input DIR +.PP +dhall-docs --input DIR --output-link SYMLINK_DIR +.SH OPTIONS +.TP +\f[B]-h\f[R] \f[B]--help\f[R] +Display help +.TP +\f[B]--input\f[R] +Directory of Dhall package +.TP +\f[B]--output-link\f[R] +Directory for generated documentation, or symlink to directory. +Defaults to \[aq]./docs\[aq] +.TP +\f[B]--package-name\f[R] +Package name; defaults to the input directory if not given. +.TP +\f[B]--ascii\f[R] +Format rendered code using ASCII syntax +.SH BUGS +.PP +Please report any bugs you may come across to +https://github.com/dhall-language/dhall-haskell/issues. diff --git a/tasty/data/golden/IndexesExample.dhall.html b/tasty/data/golden/IndexesExample.dhall.html deleted file mode 100644 --- a/tasty/data/golden/IndexesExample.dhall.html +++ /dev/null @@ -1,52 +0,0 @@ - -/IndexesExample.dhall