{"id":26269454,"url":"https://github.com/leandrocp/autumnus","last_synced_at":"2025-04-30T21:54:42.485Z","repository":{"id":280904569,"uuid":"932932619","full_name":"leandrocp/autumnus","owner":"leandrocp","description":"Syntax highlighter powered by tree-sitter and Neovim themes.","archived":false,"fork":false,"pushed_at":"2025-04-24T17:35:09.000Z","size":321622,"stargazers_count":13,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-24T18:32:50.986Z","etag":null,"topics":["rust","syntax-highlighter","syntax-highlighting","tree-sitter","tree-sitter-highlight"],"latest_commit_sha":null,"homepage":"https://autumnus.dev","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leandrocp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-14T19:40:42.000Z","updated_at":"2025-04-24T17:32:05.000Z","dependencies_parsed_at":"2025-04-24T18:37:44.660Z","dependency_job_id":null,"html_url":"https://github.com/leandrocp/autumnus","commit_stats":null,"previous_names":["leandrocp/autumnus"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leandrocp%2Fautumnus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leandrocp%2Fautumnus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leandrocp%2Fautumnus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leandrocp%2Fautumnus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leandrocp","download_url":"https://codeload.github.com/leandrocp/autumnus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250689327,"owners_count":21471740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rust","syntax-highlighter","syntax-highlighting","tree-sitter","tree-sitter-highlight"],"created_at":"2025-03-14T05:14:17.024Z","updated_at":"2025-04-30T21:54:42.477Z","avatar_url":"https://github.com/leandrocp.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Autumnus\n\n[![Crates.io](https://img.shields.io/crates/v/autumnus)](https://crates.io/crates/autumnus)\n[![docs.rs](https://img.shields.io/docsrs/autumnus)](https://docs.rs/autumnus)\n\nAutumnus is a syntax highlighter powered by Tree-sitter and Neovim themes. It provides beautiful and accurate syntax highlighting for over 50 programming languages with support for over 100 themes.\n\n## Features\n\n- 🎨 Over 100 themes including popular ones like:\n  - Dracula, Catppuccin, Tokyo Night, Gruvbox\n  - GitHub themes (light/dark)\n  - Solarized variants\n  - Nord, OneDark, and many more\n- 🌳 Tree-sitter powered syntax highlighting for accurate parsing\n- 📝 Support for 50+ programming languages\n- 🎯 Multiple output formats:\n  - HTML with inline styles\n  - HTML with linked stylesheets\n  - Terminal output with ANSI colors\n- 🔍 Automatic language detection from file extensions\n- 🚀 Zero configuration needed to get started\n- 🖥️ Command-line interface included\n\n## Installation\n\n### As a Library\n\nAdd Autumnus to your `Cargo.toml`:\n\n```toml\n[dependencies]\nautumnus = \"0.1\"\n```\n\n### As a CLI Tool\n\nInstall the `autumn` command-line tool:\n\n```sh\ncargo install autumnus\n```\n\nNote: While the package name is `autumnus`, the installed binary is named `autumn`. This means you use `cargo install autumnus` to install it, but run it as `autumn` in your terminal.\n\n## Usage\n\n### Library Usage\n\n#### Basic Example\n\n```rust\nuse autumnus::{highlight, Options};\n\nlet code = r#\"\n    function greet(name) {\n        console.log(`Hello ${name}!`);\n    }\n\"#;\n\nlet html = highlight(\"javascript\", code, Options::default());\n```\n\n#### Using a Specific Theme\n\n```rust\nuse autumnus::{highlight, Options, themes};\n\nlet code = \"SELECT * FROM users WHERE active = true;\";\nlet html = highlight(\n    \"sql\",\n    code,\n    Options {\n        theme: themes::get(\"dracula\").expect(\"Theme not found\"),\n        ..Options::default()\n    }\n);\n```\n\n#### Language Detection from File Path\n\n```rust\nuse autumnus::{highlight, Options};\n\nlet code = r#\"\n    defmodule MyApp do\n      def hello, do: :world\n    end\n\"#;\n// Language will be automatically detected as Elixir from the .ex extension\nlet html = highlight(\"app.ex\", code, Options::default());\n```\n\n#### Terminal Output with ANSI Colors\n\n```rust\nuse autumnus::{highlight, Options, FormatterOption};\n\nlet code = \"puts 'Hello from Ruby!'\";\nlet ansi = highlight(\n    \"ruby\",\n    code,\n    Options {\n        formatter: FormatterOption::Terminal,\n        ..Options::default()\n    }\n);\n```\n\n#### HTML with Linked Stylesheets\n\n```rust\nuse autumnus::{highlight, Options, FormatterOption};\n\nlet code = \"console.log('Hello!')\";\nlet html = highlight(\n    \"javascript\",\n    code,\n    Options {\n        formatter: FormatterOption::HtmlLinked,\n        ..Options::default()\n    }\n);\n```\n\nWhen using `FormatterOption::HtmlLinked`, include the corresponding CSS file for your chosen theme:\n\n```html\n\u003clink rel=\"stylesheet\" href=\"css/dracula.css\" /\u003e\n```\n\n### Command-Line Usage\n\nThe `autumn` command-line tool provides several commands for syntax highlighting and code analysis:\n\n#### List Available Languages\n\n```sh\nautumn list-languages\n```\n\nLists all supported programming languages and their associated file patterns.\n\n#### List Available Themes\n\n```sh\nautumn list-themes\n```\n\nLists all available syntax highlighting themes.\n\n#### Highlight a File\n\n```sh\nautumn highlight \u003cpath\u003e [options]\n```\n\nHighlights the contents of a file with syntax highlighting.\n\nOptions:\n- `-f, --formatter \u003cformatter\u003e`: Output format (default: terminal)\n  - `terminal`: ANSI colored output for terminal\n  - `html-inline`: HTML output with inline styles\n  - `html-linked`: HTML output with linked stylesheet\n- `-t, --theme \u003ctheme\u003e`: Theme name (default: catppuccin_frappe)\n\nExample:\n```sh\nautumn highlight src/main.rs --formatter html-inline --theme github_dark\n```\n\n#### Highlight Source Code\n\n```sh\nautumn highlight-source \u003csource\u003e [options]\n```\n\nHighlights a string of source code.\n\nOptions:\n- `-l, --language \u003clanguage\u003e`: Programming language for the source code\n- `-f, --formatter \u003cformatter\u003e`: Output format (default: terminal)\n- `-t, --theme \u003ctheme\u003e`: Theme name (default: catppuccin_frappe)\n\nExample:\n```sh\nautumn highlight-source \"println!(\\\"Hello World!\\\");\" -l rust\n```\n\n#### Dump Tree-sitter AST\n\n```sh\nautumn dump-tree-sitter \u003cpath\u003e\n```\n\nDumps the Tree-sitter AST (Abstract Syntax Tree) for a given file. This is useful for debugging or understanding how Tree-sitter parses your code.\n\n## Supported Languages\n\nAutumnus supports a wide range of programming languages, including but not limited to:\n\n- Angular\n- Astro\n- Bash\n- C/C++\n- C#\n- Clojure\n- CSS/SCSS\n- Dockerfile\n- Elixir/EEx/HEEx\n- Elm\n- Erlang\n- F#\n- Go\n- GraphQL\n- Haskell\n- HTML\n- Java\n- JavaScript/TypeScript\n- JSON\n- Kotlin\n- LaTeX\n- Lua\n- Markdown\n- OCaml\n- PHP\n- Python\n- Ruby\n- Rust\n- SQL\n- Swift\n- TOML\n- XML\n- YAML\n- And many more!\n\nCheck the [documentation](https://docs.rs/autumnus) for a complete list of supported languages and file extensions.\n\n## Available Themes\n\nAutumnus includes over 100 themes, such as:\n\n- Dracula and Dracula Soft\n- Catppuccin (Mocha, Macchiato, Frappe, Latte)\n- GitHub themes (Light/Dark, High Contrast, Colorblind)\n- Gruvbox (Light/Dark variants)\n- Nord\n- OneDark variants\n- Rose Pine\n- Solarized variants\n- Tokyo Night variants\n- And many more!\n\nVisit the [documentation](https://docs.rs/autumnus) for a complete list of available themes.\n\n## Contributing\n\nContributions are welcome! Feel free to:\n\n- Report bugs\n- Suggest new features\n- Add new themes\n- Add support for new languages\n- Improve documentation\n\n## Acknowledgements\n\nAutumnus would not be possible without these projects:\n\n- [inkjet](https://github.com/Colonial-Dev/inkjet)\n- [difftastic](https://github.com/Wilfred/difftastic)\n- [Learn X in Y minutes](https://github.com/adambard/learnxinyminutes-docs)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleandrocp%2Fautumnus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleandrocp%2Fautumnus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleandrocp%2Fautumnus/lists"}