add -cloud mode for custom messaging on doctree.org

Signed-off-by: Stephen Gutekanst <stephen@sourcegraph.com>

Author: Stephen Gutekanst

Taskfile.yml

@@ -6,6 +6,11 @@ tasks:
     cmds:
       - task --parallel fmt-lint backend frontend --watch
 
+  cloud:
+    desc: Run development server, watching code files for changes.
+    cmds:
+      - task --parallel fmt-lint backend-cloud frontend --watch
+
   fmt-lint:
     desc: "Run formatters and linters"
     cmds:
@@ -21,6 +26,15 @@ tasks:
     deps:
       - build-go-debug
 
+  backend-cloud:
+    desc: Run "doctree serve -cloud" backend
+    cmds:
+      - .bin/doctree serve -cloud
+    env:
+      ELM_DEBUG_SERVER: "http://localhost:1234/"
+    deps:
+      - build-go-debug
+
   frontend:
     desc: Run Elm frontend dev server
     dir: frontend

cmd/doctree/serve.go

@@ -36,12 +36,13 @@ Examples:
 	flagSet := flag.NewFlagSet("serve", flag.ExitOnError)
 	dataDirFlag := flagSet.String("data-dir", defaultDataDir(), "where doctree stores its data")
 	httpFlag := flagSet.String("http", ":3333", "address to bind for the HTTP server")
+	cloudModeFlag := flagSet.Bool("cloud", false, "run in cloud mode (i.e. doctree.org)")
 
 	// Handles calls to our subcommand.
 	handler := func(args []string) error {
 		_ = flagSet.Parse(args)
 		indexDataDir := filepath.Join(*dataDirFlag, "index")
-		return Serve(*httpFlag, indexDataDir)
+		return Serve(*cloudModeFlag, *httpFlag, indexDataDir)
 	}
 
 	// Register the command.
@@ -58,10 +59,24 @@ Examples:
 }
 
 // Serve an HTTP server on the given addr.
-func Serve(addr, indexDataDir string) error {
+func Serve(cloudMode bool, addr, indexDataDir string) error {
 	log.Printf("Listening on %s", addr)
 	mux := http.NewServeMux()
 	mux.Handle("/", frontendHandler())
+	mux.Handle("/main.js", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		flags := struct {
+			CloudMode bool `json:"cloudMode"`
+		}{CloudMode: cloudMode}
+
+		flagsJson, err := json.Marshal(flags)
+		if err != nil {
+			http.Error(w, err.Error(), http.StatusInternalServerError)
+			return
+		}
+
+		w.Header().Set("Content-Type", "application/javascript")
+		fmt.Fprintf(w, `Elm.Main.init({flags: %s})`, flagsJson)
+	}))
 	mux.Handle("/api/list", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		// SECURITY: This endpoint isn't mutable and doesn't serve privileged information, and
 		// therefor safe to use from any origin.
@@ -159,7 +174,7 @@ func frontendHandler() http.Handler {
 		return proxy
 	}
 
-	// Server assets that are embedded into Go binary.
+	// Serve assets that are embedded into Go binary.
 	fs := http.FS(frontend.EmbeddedFS())
 	fileServer := http.FileServer(fs)
 	return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {

frontend/public/index.html

@@ -31,6 +31,6 @@
   </script>
 
   <script src="/dist/elm.js"></script>
-  <script> Elm.Main.init() </script>
+  <script src="/main.js"></script>
 </body>
 </html>

frontend/src/Pages/Home_.elm

@@ -32,7 +32,7 @@ page shared req =
     Page.element
         { init = init
         , update = update
-        , view = view
+        , view = view shared.flags.cloudMode
         , subscriptions = subscriptions
         }
 
@@ -139,8 +139,8 @@ subscriptions model =
 -- VIEW
 
 
-view : Model -> View Msg
-view model =
+view : Bool -> Model -> View Msg
+view cloudMode model =
     { title = "doctree"
     , body =
         [ E.layout (List.concat [ Style.layout, [ E.width E.fill ] ])
@@ -154,6 +154,40 @@ view model =
                                 , if model.query /= "" then
                                     Element.Lazy.lazy searchResults model.results
 
+                                  else if cloudMode then
+                                    E.column [ E.centerX ]
+                                        [ Style.h2 [ E.paddingXY 0 32 ] (E.text "# Try doctree (sample projects)")
+                                        , E.column [] (projectsList list)
+                                        , Style.h2 [ E.paddingEach { top = 32, right = 0, bottom = 0, left = 0 } ]
+                                            (E.text "# Add your repository to doctree.org")
+                                        , E.paragraph [ E.paddingEach { top = 32, right = 0, bottom = 0, left = 0 } ]
+                                            [ E.text "(coming soon)"
+                                            ]
+                                        , Style.h2 [ E.paddingEach { top = 32, right = 0, bottom = 0, left = 0 } ]
+                                            (E.text "# Experimental! Early stages!")
+                                        , E.paragraph [ E.paddingEach { top = 16, right = 0, bottom = 0, left = 0 } ]
+                                            [ E.text "We're working on adding more languages, polishing the experience, and adding usage examples. It's all very early stages and experimental - please bear with us!"
+                                            ]
+                                        , Style.h3 [ E.paddingEach { top = 32, right = 0, bottom = 0, left = 0 } ]
+                                            (E.text "# 100% open-source library docs tool for every language")
+                                        , E.paragraph [ E.paddingEach { top = 16, right = 0, bottom = 0, left = 0 } ]
+                                            [ E.text "Available "
+                                            , E.link [ Font.underline ] { url = "https://github.com/sourcegraph/doctree", label = E.text "on GitHub" }
+                                            , E.text ", doctree provides first-class library documentation for every language (based on tree-sitter), with symbol search & more. Using Sourcegraph, it can automatically find real-world usage examples."
+                                            ]
+                                        , Style.h3 [ E.paddingEach { top = 32, right = 0, bottom = 0, left = 0 } ] (E.text "# Run locally, self-host, or use doctree.org")
+                                        , E.paragraph [ E.paddingEach { top = 16, right = 0, bottom = 0, left = 0 } ]
+                                            [ E.text "doctree is a single binary, and is designed to be lightweight for use on your personal machine. It's easy to self-host, or you can use via doctree.org with any GitHub repository."
+                                            , E.link [ Font.underline ] { url = "https://github.com/sourcegraph/doctree#installation", label = E.text "installation instructions" }
+                                            , E.text ")"
+                                            ]
+                                        , E.paragraph [ E.paddingEach { top = 16, right = 0, bottom = 0, left = 0 } ]
+                                            [ E.text "Extremely early stages (pre v0.1), please see "
+                                            , E.link [ Font.underline ] { url = "https://github.com/sourcegraph/doctree/issues/27", label = E.text "our v1.0 roadmap" }
+                                            , E.text " for more details on where we're going! Ideas/feedback welcome!"
+                                            ]
+                                        ]
+
                                   else
                                     E.column [ E.centerX ]
                                         [ Style.h2 [ E.paddingXY 0 32 ] (E.text "# Your projects")

frontend/src/Shared.elm

@@ -9,17 +9,19 @@ module Shared exposing
 
 import APISchema
 import Http
-import Json.Decode as Json
+import Json.Decode as Decode exposing (Decoder)
+import Json.Decode.Pipeline as Pipeline
 import Request exposing (Request)
 import Url.Builder
 
 
 type alias Flags =
-    Json.Value
+    Decode.Value
 
 
 type alias Model =
-    { currentProjectName : Maybe String
+    { flags : DecodedFlags
+    , currentProjectName : Maybe String
     , projectIndexes : Maybe (Result Http.Error APISchema.ProjectIndexes)
     }
 
@@ -29,10 +31,24 @@ type Msg
     | GotProject (Result Http.Error APISchema.ProjectIndexes)
 
 
+flagsDecoder : Decoder DecodedFlags
+flagsDecoder =
+    Decode.succeed DecodedFlags
+        |> Pipeline.required "cloudMode" Decode.bool
+
+
+type alias DecodedFlags =
+    { cloudMode : Bool
+    }
+
+
 init : Request -> Flags -> ( Model, Cmd Msg )
-init _ _ =
+init _ flags =
     ( { currentProjectName = Nothing
       , projectIndexes = Nothing
+      , flags =
+            Decode.decodeValue flagsDecoder flags
+                |> Result.withDefault { cloudMode = False }
       }
     , Cmd.none
     )