Merge branch 'master' into readme

.github/CODEOWNERS

@@ -0,0 +1 @@
+*  @meowgorithm @muesli

.github/dependabot.yml

@@ -7,7 +7,7 @@ updates:
     labels:
       - "dependencies"
     commit-message:
-      prefix: "feat"
+      prefix: "chore"
       include: "scope"
   - package-ecosystem: "github-actions"
     directory: "/"

.github/workflows/coverage.yml

@@ -12,17 +12,17 @@ jobs:
       GO111MODULE: "on"
     steps:
       - name: Install Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go-version }}
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Coverage
         env:
           COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           go test -race -covermode atomic -coverprofile=profile.cov ./...
-          GO111MODULE=off go get github.com/mattn/goveralls
-          $(go env GOPATH)/bin/goveralls -coverprofile=profile.cov -service=github
+          go install github.com/mattn/goveralls@latest
+          goveralls -coverprofile=profile.cov -service=github

.github/workflows/lint.yml

@@ -8,9 +8,9 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v6
         with:
           # Optional: golangci-lint command line arguments.
           args: --issues-exit-code=0

.golangci.yml

@@ -20,10 +20,11 @@ linters:
     - goconst
     - godot
     - godox
+    - gofumpt
     - goimports
     - goprintffuncname
     - gosec
-    - ifshort
+    # - ifshort
     - misspell
     - prealloc
     - revive

Makefile

@@ -2,8 +2,6 @@
 
 .PHONY: default clean glow run log
 
-LOGFILE := debug.log
-
 default: glow
 
 clean:
@@ -13,8 +11,7 @@ glow:
 	go build
 
 run: clean glow
-	GLOW_LOGFILE=$(LOGFILE) ./glow
+	./glow
 
 log:
-	> $(LOGFILE)
-	tail -f $(LOGFILE)
+	tail -f ~/.cache/glow/glow.log

README.md

@@ -20,13 +20,9 @@ Glow is a terminal based markdown reader designed from the ground up to bring
 out the beauty—and power—of the CLI.
 
 Use it to discover markdown files, read documentation directly on the command
-line and stash markdown files to your own private collection, so you can read
-them anywhere. Glow will find local markdown files in subdirectories or a local
+line. Glow will find local markdown files in subdirectories or a local
 Git repository.
 
-By the way, all data stashed is encrypted end-to-end: only you can decrypt it.
-More on that below.
-
 ## Installation
 
 ### Package Manager
@@ -53,9 +49,10 @@ pkg install glow
 # Solus
 eopkg install glow
 
-# Windows (with Scoop or Chocolatey)
-scoop install glow
+# Windows (with Chocolatey, Scoop, or Winget)
 choco install glow
+scoop install glow
+winget install charmbracelet.glow
 
 # Android (with termux)
 pkg install glow
@@ -83,6 +80,7 @@ packages. ARM builds are also available for macOS, Linux, FreeBSD and OpenBSD.
 ### Go
 
 Or just install it with `go`:
+
 ```bash
 go install github.com/charmbracelet/glow@latest
 ```
@@ -97,27 +95,17 @@ go build
 
 [releases]: https://github.com/charmbracelet/glow/releases
 
-
 ## The TUI
 
 Simply run `glow` without arguments to start the textual user interface and
-browse local and stashed markdown. Glow will find local markdown files in the
+browse local. Glow will find local markdown files in the
 current directory and below or, if you’re in a Git repository, Glow will search
 the repo.
 
 Markdown files can be read with Glow's high-performance pager. Most of the
 keystrokes you know from `less` are the same, but you can press `?` to list
 the hotkeys.
 
-### Stashing
-
-Glow works with the Charm Cloud to allow you to store any markdown files in
-your own private collection. You can stash a local document from the Glow TUI by
-pressing `s`.
-
-Stashing is private, its contents will not be exposed publicly, and it's
-encrypted end-to-end. More on encryption below.
-
 ## The CLI
 
 In addition to a TUI, Glow has a CLI for working with Markdown. To format a
@@ -137,18 +125,6 @@ glow github.com/charmbracelet/glow
 glow https://host.tld/file.md
 ```
 
-### Stashing
-
-You can also stash documents from the CLI:
-
-```bash
-glow stash README.md
-```
-
-Then, when you run `glow` without arguments will you can browse through your
-stashed documents. This is a great way to keep track of things that you need to
-reference often.
-
 ### Word Wrapping
 
 The `-w` flag lets you set a maximum width at which the output will be wrapped:
@@ -210,32 +186,19 @@ pager: true
 width: 80
 ```
 
-## 🔒 Encryption: How It Works
-
-Encryption works by issuing symmetric keys (basically a generated password) and
-encrypting it with the local SSH public key generated by the open-source
-[charm][charmlib] library. That encrypted key is then sent up to our server.
-We can’t read it since we don’t have your private key. When you want to decrypt
-something or view your stash, that key is downloaded from our server and
-decrypted locally using the SSH private key. When you link accounts, the
-symmetric key is encrypted for each new public key. This happens on your
-machine and not our server, so we never see any unencrypted data.
-
-[charmlib]: https://github.com/charmbracelet/charm
-
 ## Feedback
 
 We’d love to hear your thoughts on this project. Feel free to drop us a note!
 
-* [Twitter](https://twitter.com/charmcli)
-* [The Fediverse](https://mastodon.social/@charmcli)
-* [Discord](https://charm.sh/chat)
+- [Twitter](https://twitter.com/charmcli)
+- [The Fediverse](https://mastodon.social/@charmcli)
+- [Discord](https://charm.sh/chat)
 
 ## License
 
 [MIT](https://github.com/charmbracelet/glow/raw/master/LICENSE)
 
-***
+---
 
 Part of [Charm](https://charm.sh).
 

config_cmd.go

@@ -6,21 +6,26 @@ import (
 	"path"
 	"path/filepath"
 
-	"github.com/charmbracelet/glow/editor"
+	"github.com/charmbracelet/x/editor"
 	gap "github.com/muesli/go-app-paths"
 	"github.com/spf13/cobra"
 )
 
 const defaultConfig = `# style name or JSON path (default "auto")
 style: "auto"
-# show local files only; no network (TUI-mode only)
-local: false
 # mouse support (TUI-mode only)
 mouse: false
 # use pager to display markdown
 pager: false
 # word-wrap at width
-width: 80`
+width: 80
+`
+
+func defaultConfigFile() string {
+	scope := gap.NewScope(gap.User, "glow")
+	path, _ := scope.ConfigPath("glow.yml")
+	return path
+}
 
 var configCmd = &cobra.Command{
 	Use:     "config",
@@ -30,41 +35,14 @@ var configCmd = &cobra.Command{
 	Example: paragraph("glow config\nglow config --config path/to/config.yml"),
 	Args:    cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		if configFile == "" {
-			scope := gap.NewScope(gap.User, "glow")
-
-			var err error
-			configFile, err = scope.ConfigPath("glow.yml")
-			if err != nil {
-				return err
-			}
-		}
-
-		if ext := path.Ext(configFile); ext != ".yaml" && ext != ".yml" {
-			return fmt.Errorf("'%s' is not a supported config type: use '%s' or '%s'", ext, ".yaml", ".yml")
+		if err := ensureConfigFile(); err != nil {
+			return err
 		}
 
-		if _, err := os.Stat(configFile); os.IsNotExist(err) {
-			// File doesn't exist yet, create all necessary directories and
-			// write the default config file
-			if err := os.MkdirAll(filepath.Dir(configFile), 0o700); err != nil {
-				return err
-			}
-
-			f, err := os.Create(configFile)
-			if err != nil {
-				return err
-			}
-			defer func() { _ = f.Close() }()
-
-			if _, err := f.WriteString(defaultConfig); err != nil {
-				return err
-			}
-		} else if err != nil { // some other error occurred
+		c, err := editor.Cmd("Glow", configFile)
+		if err != nil {
 			return err
 		}
-
-		c := editor.Cmd(configFile)
 		c.Stdin = os.Stdin
 		c.Stdout = os.Stdout
 		c.Stderr = os.Stderr
@@ -76,3 +54,37 @@ var configCmd = &cobra.Command{
 		return nil
 	},
 }
+
+func ensureConfigFile() error {
+	if configFile == "" {
+		configFile = defaultConfigFile()
+		if err := os.MkdirAll(filepath.Dir(configFile), 0o755); err != nil {
+			return fmt.Errorf("Could not write config file: %w", err)
+		}
+	}
+
+	if ext := path.Ext(configFile); ext != ".yaml" && ext != ".yml" {
+		return fmt.Errorf("'%s' is not a supported config type: use '%s' or '%s'", ext, ".yaml", ".yml")
+	}
+
+	if _, err := os.Stat(configFile); os.IsNotExist(err) {
+		// File doesn't exist yet, create all necessary directories and
+		// write the default config file
+		if err := os.MkdirAll(filepath.Dir(configFile), 0o700); err != nil {
+			return err
+		}
+
+		f, err := os.Create(configFile)
+		if err != nil {
+			return err
+		}
+		defer func() { _ = f.Close() }()
+
+		if _, err := f.WriteString(defaultConfig); err != nil {
+			return err
+		}
+	} else if err != nil { // some other error occurred
+		return err
+	}
+	return nil
+}