fix(styles): tokyo night (#320)

* fix: tokyo night Signed-off-by: Carlos Alexandro Becker <[email protected]> * docs: contributing styles * refactor(styles): move to styles package * feat(examples): add stdin/stdout example with env styles detection * chore: clean commented code * fix: fix errors * docs(gallery): add tokyo night image * fix: update generate-style-json path Co-authored-by: Ayman Bagabas <[email protected]> * docs: how to create a new style --------- Signed-off-by: Carlos Alexandro Becker <[email protected]> Co-authored-by: bashbunni <[email protected]> Co-authored-by: bashbunni <[email protected]> Co-authored-by: Ayman Bagabas <[email protected]>
charmbracelet · Aug 5, 2024 · 29b800e · 29b800e
1 parent 1fcce6f
commit 29b800e
Show file tree

Hide file tree

Showing 12 changed files with 320 additions and 48 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,3 +7,11 @@ Please submit a pull request for minor changes and submit issues for major chang
 ## Testing
 
 When providing a new feature or bug fix, please provide tests that demonstrate the issue along with your fix.
+
+## Themes
+
+New styles need to be implemented in `styles/<style-name>.go`, and then `go generate
+./...` will create the JSON files from it.
+
+You can look up all references of another theme (e.g. Dracula), and add your
+theme accordingly.
diff --git a/examples/stdin-stdout-custom-styles/main.go b/examples/stdin-stdout-custom-styles/main.go
@@ -0,0 +1,46 @@
+package main
+
+// A simple example that renders input through a pipe.
+//
+// Usage:
+// echo "# Hello, world!" | go run main.go
+//
+// cat README.md | go run main.go
+//
+// go run main.go < README.md
+
+import (
+ "fmt"
+ "io"
+ "os"
+
+ "github.com/charmbracelet/glamour"
+)
+
+const defaultWidth = 80
+
+func main() {
+ // Read from stdin.
+ in, err := io.ReadAll(os.Stdin)
+ if err != nil {
+ fmt.Fprintf(os.Stderr, "Error reading stdin: %s\n", err)
+ }
+
+ // Create a new renderer.
+ r, err := glamour.NewTermRenderer(
+ glamour.WithEnvironmentConfig(),
+ glamour.WithWordWrap(defaultWidth),
+ )
+ if err != nil {
+ fmt.Fprintf(os.Stderr, "Error creating renderer: %s\n", err)
+ }
+
+ // Render markdown.
+ md, err := r.RenderBytes(in)
+ if err != nil {
+ fmt.Fprintf(os.Stderr, "Error rendering markdown: %s\n", err)
+ }
+
+ // Write markdown to stdout.
+ fmt.Fprintf(os.Stdout, "%s\n", md)
+}
diff --git a/glamour.go b/glamour.go
@@ -16,17 +16,7 @@ import (
  "golang.org/x/term"
 
  "github.com/charmbracelet/glamour/ansi"
-)
-
-// Default styles.
-const (
- AsciiStyle = "ascii"
- AutoStyle = "auto"
- DarkStyle = "dark"
- DraculaStyle = "dracula"
- LightStyle = "light"
- NoTTYStyle = "notty"
- PinkStyle = "pink"
+ styles "github.com/charmbracelet/glamour/styles"
 )
 
 const (
@@ -138,7 +128,7 @@ func WithStandardStyle(style string) TermRendererOption {
 // WithAutoStyle sets a TermRenderer's styles with either the standard dark
 // or light style, depending on the terminal's background color at run-time.
 func WithAutoStyle() TermRendererOption {
- return WithStandardStyle(AutoStyle)
+ return WithStandardStyle(styles.AutoStyle)
 }
 
 // WithEnvironmentConfig sets a TermRenderer's styles based on the
@@ -253,24 +243,24 @@ func (tr *TermRenderer) RenderBytes(in []byte) ([]byte, error) {
 func getEnvironmentStyle() string {
  glamourStyle := os.Getenv("GLAMOUR_STYLE")
  if len(glamourStyle) == 0 {
- glamourStyle = AutoStyle
+ glamourStyle = styles.AutoStyle
  }
 
  return glamourStyle
 }
 
 func getDefaultStyle(style string) (*ansi.StyleConfig, error) {
- if style == AutoStyle {
+ if style == styles.AutoStyle {
  if !term.IsTerminal(int(os.Stdout.Fd())) {
- return &NoTTYStyleConfig, nil
+ return &styles.NoTTYStyleConfig, nil
  }
  if termenv.HasDarkBackground() {
- return &DarkStyleConfig, nil
+ return &styles.DarkStyleConfig, nil
  }
- return &LightStyleConfig, nil
+ return &styles.LightStyleConfig, nil
  }
 
- styles, ok := DefaultStyles[style]
+ styles, ok := styles.DefaultStyles[style]
  if !ok {
  return nil, fmt.Errorf("%s: style not found", style)
  }

diff --git a/glamour_test.go b/glamour_test.go
@@ -8,14 +8,15 @@ import (
  "strings"
  "testing"
 
+ styles "github.com/charmbracelet/glamour/styles"
  "github.com/charmbracelet/x/exp/golden"
 )
 
 const markdown = "testdata/readme.markdown.in"
 
 func TestTermRendererWriter(t *testing.T) {
  r, err := NewTermRenderer(
- WithStandardStyle(DarkStyle),
+ WithStandardStyle(styles.DarkStyle),
  )
  if err != nil {
  t.Fatal(err)
@@ -116,7 +117,7 @@ func TestStyles(t *testing.T) {
  }
 
  _, err = NewTermRenderer(
- WithStandardStyle(AutoStyle),
+ WithStandardStyle(styles.AutoStyle),
  )
  if err != nil {
  t.Fatal(err)
@@ -141,8 +142,8 @@ func TestCustomStyle(t *testing.T) {
  expected string
  }{
  {name: "style exists", stylePath: "testdata/custom.style", err: nil, expected: "testdata/custom.style"},
- {name: "style doesn't exist", stylePath: "testdata/notfound.style", err: os.ErrNotExist, expected: AutoStyle},
- {name: "style is empty", stylePath: "", err: nil, expected: AutoStyle},
+ {name: "style doesn't exist", stylePath: "testdata/notfound.style", err: os.ErrNotExist, expected: styles.AutoStyle},
+ {name: "style is empty", stylePath: "", err: nil, expected: styles.AutoStyle},
  }
 
  for _, tc := range tests {
@@ -186,7 +187,7 @@ func TestRenderHelpers(t *testing.T) {
 
 func TestCapitalization(t *testing.T) {
  p := true
- style := DarkStyleConfig
+ style := styles.DarkStyleConfig
  style.H1.Upper = &p
  style.H2.Title = &p
  style.H3.Lower = &p
@@ -209,7 +210,7 @@ func TestCapitalization(t *testing.T) {
 func FuzzData(f *testing.F) {
  f.Fuzz(func(t *testing.T, data []byte) {
  func() int {
- _, err := RenderBytes(data, DarkStyle)
+ _, err := RenderBytes(data, styles.DarkStyle)
  if err != nil {
  return 0
  }

diff --git a/internal/generate-style-json/main.go b/internal/generate-style-json/main.go
@@ -6,8 +6,8 @@ import (
  "os"
  "path/filepath"
 
- "github.com/charmbracelet/glamour"
  "github.com/charmbracelet/glamour/ansi"
+ styles "github.com/charmbracelet/glamour/styles"
 )
 
 func writeStyleJSON(filename string, styleConfig *ansi.StyleConfig) error {
@@ -22,7 +22,7 @@ func writeStyleJSON(filename string, styleConfig *ansi.StyleConfig) error {
 }
 
 func run() error {
- for style, styleConfig := range glamour.DefaultStyles {
+ for style, styleConfig := range styles.DefaultStyles {
  if err := writeStyleJSON(filepath.Join("styles", style+".json"), styleConfig); err != nil {
  return err
  }

diff --git a/dracula.go → styles/dracula.go b/dracula.go → styles/dracula.go
@@ -1,7 +1,8 @@
-package glamour
+package styles
 
 import "github.com/charmbracelet/glamour/ansi"
 
+// DraculaStyleConfig is the dracula style.
 var DraculaStyleConfig = ansi.StyleConfig{
  Document: ansi.StyleBlock{
  StylePrimitive: ansi.StylePrimitive{

diff --git a/styles/gallery/README.md b/styles/gallery/README.md
@@ -2,18 +2,22 @@
 
 ## Dark
 
-![Glamour Dark Style](dark.png)
+![Glamour Dark Style](./dark.png)
 
 ## Light
 
-![Glamour Light Style](light.png)
+![Glamour Light Style](./light.png)
 
 ## NoTTY
 
 Pronounced _naughty_.
 
-![Glamour NoTTY Style](notty.png)
+![Glamour NoTTY Style](./notty.png)
 
 ## Dracula
 
-![Dracula Style](dracula.png)
+![Dracula Style](./dracula.png)
+
+## Tokyo Night
+
+![Tokyo Night Style](./tokyo-night.png)
diff --git a/styles/gallery/tokyo-night.png b/styles/gallery/tokyo-night.png
diff --git a/styles/notty.json b/styles/notty.json
@@ -6,7 +6,7 @@
  },
  "block_quote": {
  "indent": 1,
- "indent_token": "│ "
+ "indent_token": "| "
  },
  "paragraph": {},
  "list": {
@@ -56,7 +56,7 @@
  "block_prefix": ". "
  },
  "task": {
- "ticked": "[✓] ",
+ "ticked": "[x] ",
  "unticked": "[ ] "
  },
  "link": {},
@@ -72,15 +72,11 @@
  "code_block": {
  "margin": 2
  },
- "table": {
- "center_separator": "┼",
- "column_separator": "│",
- "row_separator": "─"
- },
+ "table": {},
  "definition_list": {},
  "definition_term": {},
  "definition_description": {
- "block_prefix": "\n🠶 "
+ "block_prefix": "\n* "
  },
  "html_block": {},
  "html_span": {}

diff --git a/styles.go → styles/styles.go b/styles.go → styles/styles.go
@@ -1,6 +1,6 @@
-package glamour
+package styles
 
-//go:generate go run ./internal/generate-style-json
+//go:generate go run ../internal/generate-style-json
 
 import (
  "github.com/charmbracelet/glamour/ansi"
@@ -12,6 +12,18 @@ const (
  defaultMargin = 2
 )
 
+// Default styles.
+const (
+ AsciiStyle = "ascii"
+ AutoStyle = "auto"
+ DarkStyle = "dark"
+ DraculaStyle = "dracula"
+ TokyoNightStyle = "tokyo-night"
+ LightStyle = "light"
+ NoTTYStyle = "notty"
+ PinkStyle = "pink"
+)
+
 var (
  // ASCIIStyleConfig uses only ASCII characters.
  ASCIIStyleConfig = ansi.StyleConfig{
@@ -647,12 +659,15 @@ var (
 
  // DefaultStyles are the default styles.
  DefaultStyles = map[string]*ansi.StyleConfig{
- AsciiStyle: &ASCIIStyleConfig,
- DarkStyle: &DarkStyleConfig,
- DraculaStyle: &DraculaStyleConfig,
- LightStyle: &LightStyleConfig,
- NoTTYStyle: &NoTTYStyleConfig,
- PinkStyle: &PinkStyleConfig,
+ AsciiStyle: &ASCIIStyleConfig,
+ DarkStyle: &DarkStyleConfig,
+ LightStyle: &LightStyleConfig,
+ NoTTYStyle: &NoTTYStyleConfig,
+ PinkStyle: &PinkStyleConfig,
+
+ // Popular themes
+ DraculaStyle: &DraculaStyleConfig,
+ TokyoNightStyle: &TokyoNightStyleConfig,
  }
 )