Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 5.01 KB

CONTRIBUTING.md

File metadata and controls

97 lines (69 loc) · 5.01 KB
Raw

How to Contribute

Contributing via Pull Requests

Adding support for a new language

Adding support for a new Language consists in adding a new entry to the define_language! macro in language.rs and filling it in with the right data.

Example:

{ TypeScript, Programming, "typescript.ascii", define_colors!([Cyan, White] : [Rgb(0, 122, 204), Rgb(255, 255, 255)]), Rgb(43, 116, 137) }

The first item TypeScript corresponds to the name of the language as defined in tokei. The second item refers to the language type as specified by linguist, only four values are possible: Programming, Markup, Prose and Data. The third item typescript.ascii is the name of the file containing the ascii logo: this file has to be placed in the ./resources folder (more info below). Then we have the colors used to customize the look of the ascii logo when displayed to the screen. Finally, the circle color used in the language distribution as specified by linguist.

Ascii logo

{0}TSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTS
{0}TSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTS
{0}TSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTS
{0}TSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTS
{0}TSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTS
{0}TSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTS
{0}TSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTS
{0}TSTSTSTS{1}TSTSTSTSTSTSTS{0}TSTS{1}TSTSTS{0}TSTSTS
{0}TSTSTSTS{1}TSTSTSTSTSTSTS{0}TS{1}TSTSTSTSTS{0}TSTS
{0}TSTSTSTSTSTST{1}TSTS{0}TSTSTST{1}TSTST{0}TSTSTSTST
{0}TSTSTSTSTSTST{1}TSTS{0}TSTSTSTS{1}TSTST{0}STSTSTST
{0}TSTSTSTSTSTST{1}TSTS{0}TSTSTSTSTS{1}TSTST{0}STSTST
{0}TSTSTSTSTSTST{1}TSTS{0}TSTSTSTSTSTS{1}TSTST{0}TSTS
{0}TSTSTSTSTSTST{1}TSTS{0}TSTSTSTSTSTST{1}TSTST{0}TST
{0}TSTSTSTSTSTST{1}TSTS{0}TSTSTSTS{1}TSTSTSTSTS{0}TST
{0}TSTSTSTSTSTST{1}TSTS{0}TSTSTSTSTS{1}TSTSTS{0}STSTS
{0}TSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTS
{0}TSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTSTS

Remarks:

  • The ascii logo's dimensions must fall below 25*40 (height*width); The CI will fail otherwise.
  • Use {i} to color the ascii with i the color index from the vec! of colors defined in define_language!.
  • Make sure to trim any unnecessary trailing whitespaces.
  • Check "Convert image to ASCII art" to learn more about image to ascii conversion.
  • Optionally, you may provide a vec! of colors in rgb format as an alternative to basic colors for terminals that support true colour.

Adding support for a new package manager

To add a new package manager, make sure to follow these steps:

  1. Add a new entry in the define_package_managers! macro in package_manager.rs.

Example:

{ Cargo, "cargo", [ ("Cargo.toml", cargo) ] },

The first item Cargo corresponds to the name of the package manager. The second item cargo is the display name. Then we have the name of the package manager file that will be parsed: Cargo.toml along with its parser cargo (cf. step 2), notice that the third item is an array of tuple in case the package manager has multiple parsers (e.g. pip).

  1. In package_manager.rs: create a function that takes an input of type &str representing the content of the package manager's file, and returns a usize as its number of dependencies.
pub fn cargo(contents: &str) -> Result<usize> {
    let parsed = contents.parse::<Value>()?;
    let count = parsed.get("dependencies");

    match count {
        Some(val) => Ok(val.as_table().unwrap().len()),
        None => Ok(0),
    }
}

Adding translation for README.md

In order to make Onefetch more accessible for non English-speakers, we are seeking the help of multilingual contributors willing to translate the README.md in their native tongue.

These translations will be accessible directly from the English README.md via hyperlinks.

Special Thanks to

  • Every onefetch user, who contributed to the project by writing issues or PRs.
  • @spenserblack, @CephalonRho, @yoichi and @HallerPatrick for maintaining this project.
  • Everyone I forgot to mention here, but also influenced onefetch and helped it grow.

❤️❤️

Made with contributors-img.