1265a9b · elk · git.iko.soy

git.iko.soy/elk

Remove Elm.Project.generateDocs for now

Plan is to bring back docs generation as a separate pass, possibly allowing different levels of requirements so that it is possible to have partially documented modules. TBD.

commit1265a9b12ec76973eb4d649979c6a09f7e1841b3 authorEvan Czaplicki <evancz@users.noreply.github.com> dateSat 29 Dec 2018, 10:29 (8 years ago) parent8db2300

3 files changed+10−31

compare with master

unifiedsplit

builder/src/Elm/Diff.hs+2−2 builder/src/Elm/Project.hs+7−28 builder/src/Elm/Publish.hs+1−1

builder/src/Elm/Diff.hs+2−2

@@ -67,13 +67,13 @@ diff args =

6767 CodeVsLatest ->

6868 do (summary, name, vsns) <- getPackageInfo

6969 oldDocs <- getDocs name vsns (maximum vsns)

70− newDocs <- Task.silently (Project.generateDocs summary)

70+ newDocs <- Task.silently (error "TODO Project.generateDocs summary" summary)

7171 writeDiff oldDocs newDocs

7272

7373 CodeVsExactly version ->

7474 do (summary, name, vsns) <- getPackageInfo

7575 oldDocs <- getDocs name vsns version

76− newDocs <- Task.silently (Project.generateDocs summary)

76+ newDocs <- Task.silently (error "TODO Project.generateDocs summary" summary)

7777 writeDiff oldDocs newDocs

7878

7979

builder/src/Elm/Project.hs+7−28

@@ -5,7 +5,6 @@ module Elm.Project

55 , getRootWithReplFallback

66 , compile

77 , compileForRepl

8− , generateDocs

98 )

109 where

1110

@@ -13,10 +12,8 @@ module Elm.Project

1312import qualified Data.ByteString as BS

1413import Data.Map ((!))

1514import qualified Data.Name as Name

16−import System.FilePath ((</>))

1715

1816import qualified Elm.Compiler as Compiler

19−import qualified Elm.Docs as Docs

2017import qualified Elm.Project.Json as Project

2118import qualified Elm.Project.Root as Root

2219import qualified Elm.Project.Summary as Summary

@@ -29,7 +26,6 @@ import qualified Generate.Artifacts as Artifacts

2926import qualified Generate.Output as Output

3027import qualified Reporting.Render.Type.Localizer as L

3128import qualified Reporting.Task as Task

32−import qualified Stuff.Paths as Path

3329

3430

3531

@@ -54,18 +50,17 @@ compile

5450 :: Output.Mode

5551 -> Output.Target

5652 -> Maybe Output.Output

57− -> Maybe FilePath

5853 -> Summary

5954 -> [FilePath]

6055 -> Task.Task ()

61−compile mode target maybeOutput docs summary@(Summary.Summary root project _ _ _) paths =

56+compile mode target maybeOutput summary@(Summary.Summary root project _ _ _) paths =

6257 do Project.check project

6358 args <- Args.fromPaths summary paths

6459 graph <- Crawl.crawl summary args

65− (dirty, ifaces) <- Plan.plan docs summary graph

66− answers <- Compile.compile project docs ifaces dirty

60+ (dirty, ifaces) <- Plan.plan summary graph

61+ answers <- Compile.compile project ifaces dirty

6762 results <- Artifacts.write root answers

68− _ <- traverse (Artifacts.writeDocs results) docs

63+ -- _ <- traverse (Artifacts.writeDocs results) docs

6964 Output.generate mode target maybeOutput summary graph results

7065

7166

@@ -78,24 +73,8 @@ compileForRepl noColors localizer source maybeName =

7873 do summary@(Summary.Summary root project _ _ _) <- getRoot

7974 Project.check project

8075 graph <- Crawl.crawlFromSource summary source

81− (dirty, ifaces) <- Plan.plan Nothing summary graph

82− answers <- Compile.compile project Nothing ifaces dirty

76+ (dirty, ifaces) <- Plan.plan summary graph

77+ answers <- Compile.compile project ifaces dirty

8378 results <- Artifacts.write root answers

84− let (Compiler.Artifacts elmi _ _) = results ! Name.replModule

79+ let (Compiler.Artifacts elmi _) = results ! Name.replModule

8580 traverse (Output.generateReplFile noColors localizer summary graph elmi) maybeName

86−

87−

88−

89−-- GENERATE DOCS

90−

91−

92−generateDocs :: Summary.Summary -> Task.Task Docs.Documentation

93−generateDocs summary@(Summary.Summary root project _ _ _) =

94− do let docsPath = root </> Path.docs

95− args <- Args.fromSummary summary

96− graph <- Crawl.crawl summary args

97− (dirty, ifaces) <- Plan.plan (Just docsPath) summary graph

98− answers <- Compile.compile project (Just docsPath) ifaces dirty

99− results <- Artifacts.write root answers

100− Output.noDebugUsesInPackage summary graph

101− Artifacts.writeDocs results docsPath

builder/src/Elm/Publish.hs+1−1

@@ -51,7 +51,7 @@ publish summary@(Summary.Summary root project _ _ _) =

5151

5252 verifyReadme root

5353 verifyLicense root

54− docs <- Task.silently (Project.generateDocs summary)

54+ docs <- Task.silently (error "TODO Project.generateDocs summary" summary)

5555 verifyVersion name version docs maybePublishedVersions

5656 commitHash <- verifyTag name version

5757 verifyNoChanges commitHash version