Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bat does not colorize puppet code block inside markdown #3148

Open
CallieNCI opened this issue Dec 18, 2024 · 2 comments
Open

bat does not colorize puppet code block inside markdown #3148

CallieNCI opened this issue Dec 18, 2024 · 2 comments
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@CallieNCI
Copy link

What steps will reproduce the bug?

  1. bat x.md x.pp

What happens?

Notification_Center

I expected to see the code block inside the markdown highlighted as per the second file in the above example.

How did you install bat?

brew install bat


nolan:nci-helper-scripts callie$ bat x.md x.pp --diagnostic

Software version

bat 0.24.0

Operating system

macOS 15.2 (Darwin 24.2.0)

Command-line

bat x.md x.pp --diagnostic

Environment variables

SHELL=/usr/local/bin/bash
PAGER=<not set>
LESS=<not set>
LANG=C
LC_ALL=<not set>
BAT_PAGER=<not set>
BAT_PAGING=<not set>
BAT_CACHE_PATH=<not set>
BAT_CONFIG_PATH=<not set>
BAT_OPTS=<not set>
BAT_STYLE=<not set>
BAT_TABS=<not set>
BAT_THEME=<not set>
XDG_CONFIG_HOME=<not set>
XDG_CACHE_HOME=<not set>
COLORTERM=truecolor
NO_COLOR=<not set>
MANPAGER=<not set>

System Config file

Could not read contents of '/etc/bat/config': No such file or directory (os error 2).

Config file

--theme="Dracula"

Custom assets metadata

Could not read contents of '/Users/callie/.cache/bat/metadata.yaml': No such file or directory (os error 2).

Custom assets

'/Users/callie/.cache/bat' not found

Compile time information

  • Profile: release
  • Target triple: x86_64-apple-darwin
  • Family: unix
  • OS: macos
  • Architecture: x86_64
  • Pointer width: 64
  • Endian: little
  • CPU features: cmpxchg16b,fxsr,pclmulqdq,popcnt,sse,sse2,sse3,sse4.1,sse4.2,ssse3
  • Host: x86_64-apple-darwin

Less version

> less --version
less 581.2 (POSIX regular expressions)
Copyright (C) 1984-2021  Mark Nudelman

less comes with NO WARRANTY, to the extent permitted by law.
For information about the terms of redistribution,
see the file named README in the less distribution.
Home page: https://greenwoodsoftware.com/less
@CallieNCI CallieNCI added the bug Something isn't working label Dec 18, 2024
@keith-hall
Copy link
Collaborator

keith-hall commented Dec 18, 2024

Currently bat is relying on .sublime-syntax files for syntax highlighting. Sublime Text currently does not have a feature whereby a syntax definition can embed itself into Markdown code blocks automatically (see sublimehq/sublime_text#5004 for an issue tracking this feature request).

The solution for now is to add a patch for the Markdown.sublime-syntax file which would add the required puppet code block embedding.

I'm going to mark it as a good first issue, because there are plenty of examples of how to do this, like mentioned for Lua at #2656 (comment)

@liliwilson
Copy link

Put up a PR for the puppet fix here -- would love feedback! If everything looks okay, I'm happy to make the change suggested in #2656 for Lua syntax highlighting in Markdown as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants