Nocturnal Practitioners of Magic

    term-schemes
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.1 • Public • Published

    Parse and normalize common terminal emulator color schemes

    term-schemes

    • Supports 10 formats
    • Normalizes to common structure
    • Works well with svg-term
    • TypeScript support

    Example

    const termSchemes = require('term-schemes');
    const fs = require('fs');
    const util = require('util');
    const readFile = util.promisify(fs.readFile);
     
    async function main() {
      const raw = String(await readFile('./Seti.itermcolors'));
      const scheme = termSchemes.iterm2(raw); // => {0: [50, 50, 50], .., background: [17, 18, 19]}
    }
     

    API

    // Available methods
    export iterm2Parser;
    export konsoleParser;
    export remminaParser;
    export terminalParser;
    export terminatorParser;
    export termiteParser;
    export tildaParser;
    export xfceParser;
    export xresourcesParser;
    export xtermParser;
     
    type Parser = (input: any) => TermScheme;
     
    /** RGB Color: [R, G, B], each item number between 0 and 255 */
    type TermSchemeColor = [number, number, number];
     
    interface TermScheme {
      /** Black */
      0: TermSchemeColor;
      /** Red */
      1: TermSchemeColor;
      /** Green */
      2: TermSchemeColor;
      /** Yellow */
      3: TermSchemeColor;
      /** Blue */
      4: TermSchemeColor;
      /** Magenta */
      5: TermSchemeColor;
      /** Cyan */
      6: TermSchemeColor;
      /** White */
      7: TermSchemeColor;
      /** Bright Black */
      8: TermSchemeColor;
      /** Bright Red */
      9: TermSchemeColor;
      /** Bright Green */
      10: TermSchemeColor;
      /** Bright Yellow */
      11: TermSchemeColor;
      /** Bright Blue */
      12: TermSchemeColor;
      /** Bright Magenta */
      13: TermSchemeColor;
      /** Bright Cyan */
      14: TermSchemeColor;
      /** Bright White */
      15: TermSchemeColor;
      /** Background color */
      background: TermSchemeColor;
      /** Bold text color */
      bold: TermSchemeColor;
      /** Cursor background color */
      cursor: TermSchemeColor;
      /** Text color */
      text: TermSchemeColor;
    }

    Supported formats

    • Hyper .js
    • iTerm2 .itermcolors
    • Konsole .colorscheme
    • Remmina .colors
    • Terminal .terminal
    • Terminator .config
    • Termite
    • Tilda .config_0
    • Xfce .theme
    • XTerm .xrdb, Xresources

    License

    Copyright Mario Nebl. term-schemes is released under the MIT license.

    Related

    Development

    npx yarn install
    npx yarn start
    

    Keywords

    none

    Install

    npm i term-schemes

    DownloadsWeekly Downloads

    5,037

    Version

    1.2.1

    License

    MIT

    Last publish

    Collaborators

    • marionebl