Rockingcool
/
ccat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
color cat - cat(1) with regex-based syntax highlighting.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
23 Commits
1 Branch
3 Tags
2.0 MiB
Go 97.5%
Shell 2.2%
Makefile 0.3%
 
 
 
master
v0.0.1
v0.1.0
v0.1.1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5da734e06d'
${ noResults }
Go to file
Aadhavan Srinivasan 5da734e06d Fixed typo 4 months ago
config Defined color mappings for Go 4 months ago
stack First commit 5 months ago
.gitignore Added gitignore file 4 months ago
Makefile First commit 5 months ago
README.md Fixed typo 4 months ago
color.go Added Dark Blue as a color 4 months ago
colorunit.go Replaced 'panic' with an error return, and a call to 'printAndExit' 4 months ago
config.go Wrote function to copy embedded config files to a config directory 4 months ago
errors.go Renamed 'printAndExit' to 'printErrAndExit' 4 months ago
go.mod First commit 5 months ago
go.sum First commit 5 months ago
main.go Changed behavior of program when 'disable color' flag is passed. 4 months ago
regcolor.go First commit 5 months ago
todo.txt Updated TODO 4 months ago
vision.txt First commit 5 months ago

README.md

ccat

ccat is a file printing tool (like 'cat') which uses Regular Expressions to enable syntax highlighting.

Features

  • Support for 11 colors: Red, Blue, Green, Magenta, Cyan, Black, White, Yellow, Gray, Orange and Dark Blue.
  • Adding more colors involves adding a line of code, then recompiling.
  • Regex-color mappings are stored in configuration files.
  • Uses the file extension to determine which configuration file to use.
  • Highly extensible - to add a config file for an specific file type, name the file <extension>.conf.
  • Support for printing line numbers with the -n flag.
  • Statically linked Go binary - no runtime dependencies, config files are distributed along with the binary.
  • Cross-platform

Installing

If you have the go command installed, run make after cloning the repository.

Getting Started

The config files are embedded within the binary. They will automatically be installed to the correct location (%APPDATA/ccat on Windows, ~/.config/ccat on UNIX) when the program is first run.

As written above, if provided a file with extension .example, the program will look for the config file named example.conf. If such a file doesn't exist, the file is printed out without any highlighting.

Config Files

The config files are written in YAML, and have the following syntax:

"<regex>": COLOR

Note that the regex must be enclosed in double quotes, and the color must be capitalized.

TODO:

  • Allow user to define colors at runtime by reading RGB values from a config file.
  • Allow users to provide a config file in the command-line, overriding the extension-based config file.
  • Provide releases.