Skip to content

Latest commit

 

History

History
78 lines (66 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

78 lines (66 loc) · 3.77 KB
Raw

Getting started

Follow the instructions for installing onefetch from source.

Adding support for a new language

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

Example:

CSharp: # required, this will be the name of the enum variant for the language as specified by tokei (link 1)
  type: programming # required, can be programming, data, markup, or prose as specified by linguist (link 2)
  # required, this is the logo. If it's not within 25x40 bounds, you will get a compiler error. Use `{i}` to color the ascii with `i` the color index.
  ascii: |
    {0}                 ++++++
    {0}              ++++++++++++
    {0}          ++++++++++++++++++++
    {0}       ++++++++++++++++++++++++++
    {0}    ++++++++++++++++++++++++++++++++
    {0} +++++++++++++{3}************{0}+++++++++++++
    {0}+++++++++++{3}******************{0}++++++++{2};;;
    {0}+++++++++{3}**********************{0}++{2};;;;;;;
    {0}++++++++{3}*********{0}++++++{3}******{2};;;;;;;;;;;
    {0}+++++++{3}********{0}++++++++++{3}**{2};;;{3}**{2};;;{3}**{2};;;
    {0}+++++++{3}*******{0}+++++++++{2};;;;;;{3}*********{2}::
    {0}+++++++{3}******{0}+++++++{2};;;;;;;;;;{3}**{2};;;{3}**{2};;;
    {0}+++++++{3}*******{0}+++{1}:::::{2};;;;;;;{3}*********{2};;
    {0}+++++++{3}********{1}::::::::::{3}**{2};;;{3}**{2};;;{3}**{2};;;
    {0}++++++++{3}*********{1}::::::{3}******{2};;;;;;;;;;;
    {0}++++++{1}:::{3}**********************{1}::{2};;;;;;;
    {0}+++{1}::::::::{3}******************{1}::::::::{2};;;
    {1} :::::::::::::{3}************{1}:::::::::::::
    {1}    ::::::::::::::::::::::::::::::::
    {1}       ::::::::::::::::::::::::::
    {1}          ::::::::::::::::::::
    {1}              ::::::::::::
    {1}                 ::::::
  colors:
    ansi: # required, a list of the ANSI colors used to colorize the logo
      - blue
      - magenta
      - magenta
      - white
    hex: # optional, alternative to basic colors for terminals that support true colour.
      - "#9B4F97"
      - "#67217A"
      - "#803788"
      - "#FFFFFF"
    chip: "#178600" # required, this is used for the language breakdown bar, its value can be found in linguist (link 2).
  icon: '\u{E648}' # optional, the UTF-16 code point of the nerd font icon if supported (link 3).
  serialization: c# # required only if the Enum name `CSharp` doesn't match the display name `C#`

Note

An additional field, line_types can also be set on a language's attributes. It has been excluded because it is not necessary for the majority of languages. By default, only a language's lines of code are counted, but this field can be used to count other lines, too. For example, line_types: [code, comments]. This is useful in languages like Markdown, where the significant lines are mostly comments. A list of available fields to be used can be found in tokei's documentation.

Special Thanks to

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

❤️❤️

Made with contributors-img.