-
Notifications
You must be signed in to change notification settings - Fork 17
/
docs.go
60 lines (52 loc) · 1.89 KB
/
docs.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*
* Copyright 2022 Aspect Build Systems, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package docs
import (
"fmt"
"os"
"strings"
"aspect.build/cli/pkg/ioutils"
"github.com/pkg/browser"
"github.com/spf13/cobra"
)
type Docs struct {
ioutils.Streams
}
func New(streams ioutils.Streams) *Docs {
return &Docs{
Streams: streams,
}
}
func (runner *Docs) Run(_ *cobra.Command, args []string) error {
// TODO: we should open the browser to the bazel version matching what is running
dest := "https://bazel.build/docs"
// Detect requests for docs on rules, which we host.
// Also, special case `bazel-` as this is likely bazel-lib or bazel-skylib
if len(args) == 1 {
if strings.HasPrefix(args[0], "contrib_") || strings.HasPrefix(args[0], "aspect_rules_") || strings.HasPrefix(args[0], "rules_") || strings.HasPrefix(args[0], "bazel-") {
dest = fmt.Sprintf("https://docs.aspect.build/rules/%s", args[0])
} else {
dest = fmt.Sprintf("https://bazel.build/reference/%s.html", args[0])
}
}
// TODO: a way to lookup whatever the user typed after "docs" using docs.aspect.build search
// as far as I can tell, Algolia doesn't provide a way to render results on a dedicated search page
// so I can't find a way to hyperlink to a search result.
if err := browser.OpenURL(dest); err != nil {
fmt.Fprintf(os.Stderr, "Failed to open link in the browser: %runner\n", err)
}
return nil
}