Skip to content

Commit

Permalink
Remove redundant and outdated documentation from lib
Browse files Browse the repository at this point in the history
  • Loading branch information
@glfmn
glfmn committed Sep 24, 2019
1 parent f9972c3 commit 39dca65
Showing 1 changed file with 5 additions and 104 deletions.
109 changes: 5 additions & 104 deletions lib/lib.rs
View file
Original file line number Diff line number Diff line change
@@ -1,112 +1,13 @@
//! glitter, a git repository status pretty-printer
//!
//! An expression based, ergonomic language for writing the status of your git repository into
//! your shell prompt.
//!
//! For example :`"\<\b\(\+\-)>\[\M\A\R\D':'\m\a\u\d]\{\h('@')}':'"` results in something that
//! might look like `<master(+1)>[M1:D3]{@5}:` where
//! Glitter is a cross-platform command-line tool and format language for making informative git prompts. Glitter's interpreter, `glit` will:
//!
//! - `master` is the name of the current branch.
//! - `+1`: means we are 1 commit ahead of the remote branch
//! - `M1`: the number of staged modifications
//! - `D3`: is the number of unstaged deleted files
//! - `@5`: is the number of stashes
//! - Read status information from your git repository through the git api
//! - Parse and Interpret the provided format
//! - Output your format with the requested information to `stdout`
//!
//! `glit` expressions also support inline format expressions to do things like making text red,
//! or bold, or using ANSI terminal escape sequences, or setting RGB colors for your git
//! information.
//!
//! # Grammar
//!
//! `glit` expressions have four basic types of expressions:
//!
//! 1. Named expressions
//! 2. Format expressions
//! 3. Group expressions
//! 4. Literals
//!
//! ## Literals
//!
//! Any characters between single quotes literal, except for backslashes and single quotes.
//! Literals are left untouched. For example, `'literal'` outputs `literal`.
//!
//! ## Named expressions
//!
//! Named expressions represent information about your git repository.
//!
//! | Name | Meaning | Example |
//! |:------|:-------------------------------|:----------------|
//! | `\b` | branch name or head commit id | `master` |
//! | `\B` | remote name | `origin/master` |
//! | `\+` | # of commits ahead remote | `+1` |
//! | `\-` | # of commits behind remote | `-1` |
//! | `\m` | # of unstaged modified files | `M1` |
//! | `\a` | # of untracked files | `?1` |
//! | `\d` | # of unstaged deleted files | `D1` |
//! | `\u` | # of merge conflicts | `U1` |
//! | `\M` | # of staged modified files | `M1` |
//! | `\A` | # of added files | `A1` |
//! | `\R` | # of renamed files | `R1` |
//! | `\D` | # of staged deleted files | `D1` |
//! | `\h` | # of stashed files | `H1` |
//!
//! You can provide other expressions as arguments to expressions which replace the default prefix
//! which appears before the result or file count. For example, `\h('@')` will output `@3`
//! instead of `H3` if your repository has 3 stashed files. You can provide an arbitrary number
//! of valid expressions as a prefix to another named expression.
//!
//! ## Group Expressions
//!
//! Glitter will surround grouped expressions with parentheses or brackets, and will print nothing
//! if the group is empty.
//!
//! | Macro | Result |
//! |:------------|:---------------------------------|
//! | `\[]` | empty |
//! | `\()` | empty |
//! | `\<>` | empty |
//! | `\{}` | empty |
//! | `\{\b}` | `{master}` |
//! | `\<\+\->` | `<+1-1>` |
//! | `\[\M\A\R]` | `[M1A3]` where `\R` is empty |
//! | `\[\r\(\a)]`| empty, when `\r`, `\a` are empty |
//!
//! ## Format Expressions
//!
//! Glitter expressions support ANSI terminal formatting through the following styles:
//!
//! | Format | Meaning |
//! |:---------------------|:----------------------------------------------|
//! | `#~(`...`)` | reset |
//! | `#_(`...`)` | underline |
//! | `#i(`...`)` | italic text |
//! | `#*(`...`)` | bold text |
//! | `#r(`...`)` | red text |
//! | `#g(`...`)` | green text |
//! | `#b(`...`)` | blue text |
//! | `#m(`...`)` | magenta/purple text |
//! | `#y(`...`)` | yellow text |
//! | `#w(`...`)` | white text |
//! | `#k(`...`)` | bright black text |
//! | `#[01,02,03](`...`)` | 24 bit rgb text color |
//! | `#R(`...`)` | red background |
//! | `#G(`...`)` | green background |
//! | `#B(`...`)` | blue background |
//! | `#M(`...`)` | magenta/purple background |
//! | `#Y(`...`)` | yellow background |
//! | `#W(`...`)` | white background |
//! | `#K(`...`)` | bright black background |
//! | `#{01,02,03}(`...`)` | 24 bit rgb background color |
//! | `#01(`...`)` | Fixed terminal color |
//!
//! Format styles can be combined in a single expression by separating them with semicolons:
//!
//! | Format | Meaning |
//! |:---------------|:-------------------------------|
//! | `#w;K(`...`)` | white text, black background |
//! | `#r;*(`...`)` | red bold text |
//! | `#42(`...`)` | a forest greenish color |
//! | `#_;*(`...`)` | underline bold text |
//! For a detailed guide, visit the [GitHub repository](https://github.com/glfmn/glitter)l

extern crate git2;
extern crate nom;
Expand Down

0 comments on commit 39dca65

Please sign in to comment.