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.

Sign up for GitHub

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

feat: add terminal formatter #23

Merged
merged 6 commits into from
Sep 9, 2024
Merged

feat: add terminal formatter #23

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
133430e
feat: add terminal formatter
guilhermeprokisch Sep 5, 2024
9a0d7a6
feat: add terminal formatter
guilhermeprokisch Sep 5, 2024
1bda7bc
feat: review and examples
guilhermeprokisch Sep 6, 2024
75f0aff
feat: reviews and example
guilhermeprokisch Sep 6, 2024
2c73951
Update theme_example.rs
Colonial-Dev Sep 9, 2024
ff2e6b3
TIL examples can depend on each other!
Colonial-Dev Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 95 additions & 89 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ description = "A batteries-included syntax highlighting library for Rust, based
keywords = ["tree-sitter", "syntax", "highlighting", "highlight"]
categories = ["text-processing"]

include = [
"/config",
"/languages/*",
"/src",
"/build"
]
include = ["/config", "/languages/*", "/src", "/build"]

build = "build/main.rs"

Expand All @@ -26,89 +21,95 @@ default = ["html", "theme", "all_languages"]

html = ["dep:v_htmlescape"]
theme = ["html", "dep:ahash", "dep:toml", "dep:serde"]
development = ["dep:syn", "dep:proc-macro2", "dep:quote", "dep:prettyplease", "dep:fs_extra"]
development = [
"dep:syn",
"dep:proc-macro2",
"dep:quote",
"dep:prettyplease",
"dep:fs_extra",
]

all_languages = [
"language-ada",
"language-asm",
"language-astro",
"language-awk",
"language-bash",
"language-bibtex",
"language-bicep",
"language-blueprint",
"language-c",
"language-capnp",
"language-clojure",
"language-c-sharp",
"language-commonlisp",
"language-cpp",
"language-css",
"language-cue",
"language-d",
"language-dart",
"language-diff",
"language-dockerfile",
"language-eex",
"language-elisp",
"language-elixir",
"language-elm",
"language-erlang",
"language-forth",
"language-fortran",
"language-gdscript",
"language-gleam",
"language-glsl",
"language-go",
"language-haskell",
"language-hcl",
"language-heex",
"language-html",
"language-iex",
"language-ini",
"language-java",
"language-javascript",
"language-json",
"language-jsx",
"language-kotlin",
"language-latex",
"language-llvm",
"language-lua",
"language-make",
"language-matlab",
"language-meson",
"language-nim",
"language-nix",
"language-objc",
"language-ocaml",
"language-ocaml-interface",
"language-openscad",
"language-pascal",
"language-php",
"language-plaintext",
"language-proto",
"language-python",
"language-r",
"language-racket",
"language-regex",
"language-ruby",
"language-rust",
"language-scala",
"language-scheme",
"language-scss",
"language-sql",
"language-svelte",
"language-swift",
"language-toml",
"language-typescript",
"language-tsx",
"language-vim",
"language-wast",
"language-wat",
"language-x86asm",
"language-wgsl",
"language-yaml",
"language-zig",
"language-ada",
"language-asm",
"language-astro",
"language-awk",
"language-bash",
"language-bibtex",
"language-bicep",
"language-blueprint",
"language-c",
"language-capnp",
"language-clojure",
"language-c-sharp",
"language-commonlisp",
"language-cpp",
"language-css",
"language-cue",
"language-d",
"language-dart",
"language-diff",
"language-dockerfile",
"language-eex",
"language-elisp",
"language-elixir",
"language-elm",
"language-erlang",
"language-forth",
"language-fortran",
"language-gdscript",
"language-gleam",
"language-glsl",
"language-go",
"language-haskell",
"language-hcl",
"language-heex",
"language-html",
"language-iex",
"language-ini",
"language-java",
"language-javascript",
"language-json",
"language-jsx",
"language-kotlin",
"language-latex",
"language-llvm",
"language-lua",
"language-make",
"language-matlab",
"language-meson",
"language-nim",
"language-nix",
"language-objc",
"language-ocaml",
"language-ocaml-interface",
"language-openscad",
"language-pascal",
"language-php",
"language-plaintext",
"language-proto",
"language-python",
"language-r",
"language-racket",
"language-regex",
"language-ruby",
"language-rust",
"language-scala",
"language-scheme",
"language-scss",
"language-sql",
"language-svelte",
"language-swift",
"language-toml",
"language-typescript",
"language-tsx",
"language-vim",
"language-wast",
"language-wat",
"language-x86asm",
"language-wgsl",
"language-yaml",
"language-zig",
]

language-ada = []
Expand Down Expand Up @@ -200,11 +201,12 @@ tree-sitter-highlight = "0.23.0"

ahash = { version = "0.8.3", optional = true }
toml = { version = "0.7", optional = true }
serde = { version = "1.0", features = ["derive"], optional = true}
serde = { version = "1.0", features = ["derive"], optional = true }
v_htmlescape = { version = "0.15.8", optional = true }
termcolor = "1.4.1"

[build-dependencies]
syn = { version = "2.0.37", features = ["full", "parsing"], optional = true}
syn = { version = "2.0.37", features = ["full", "parsing"], optional = true }
proc-macro2 = { version = "1.0.67", optional = true }
quote = { version = "1.0.33", optional = true }
prettyplease = { version = "0.2.15", optional = true }
Expand All @@ -214,3 +216,7 @@ anyhow = "1.0.75"
cc = "1.0.83"
serde = { version = "1.0", features = ["derive"] }
toml = "0.8.6"

[[example]]
name = "terminal_highlight"
required-features = ["theme"]
54 changes: 54 additions & 0 deletions examples/terminal_highlight.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
use inkjet::{
formatter::{Terminal, Theme},
Highlighter, Language,
};
use std::error::Error;
use std::fs::File;
use std::io::{self, Read};
use termcolor::{ColorChoice, StandardStream};

mod theme_example;
use theme_example::create_theme;

fn read_file(path: &str) -> io::Result<String> {
let mut content = String::new();
File::open(path)?.read_to_string(&mut content)?;
Ok(content)
}

fn main() -> Result<(), Box<dyn Error>> {
// Read the source code from a file or use a sample
let source = read_file("example.rs").unwrap_or_else(|_| {
r#"
fn main() {
println!("Hello, world!");
let x = 5;
let y = 10;
println!("x + y = {}", x + y);
}
"#
.to_string()
});

let lang = "rust"; // You can change this to test different languages
let mut highlighter = Highlighter::new();
let language = Language::from_token(lang).unwrap_or(Language::Plaintext);
let theme: Theme = create_theme();

// Create a StandardStream for stdout
let stream = StandardStream::stdout(ColorChoice::Always);

// Create the Terminal formatter with both theme and stream
let formatter = Terminal::new(theme, stream);

// Split the code into lines
let lines: Vec<&str> = source.lines().collect();
for line in lines {
highlighter
.highlight_to_writer(language, &formatter, line, &mut io::stdout())
.map_err(|e| io::Error::new(io::ErrorKind::Other, e.to_string()))?;
println!();
}
println!();
Ok(())
}
Loading
Loading