Sublime Text Scheme Generator

Getting started

# Using NPM
npm i @meetio/scheme-generator -D

# Using Yarn
yarn add @meetio/scheme-generator

In addition to the base settings, SchemeSetting provides more options for colors, ui, rules. There is also an overrides property, which allows you to set any color key from the Color Scheme Reference directly.

Example

This is all that's needed to generate a great looking theme:

import { generateScheme, rules, ui } from '@meetio/scheme-generator';
import { SchemeSetting, UI } from '@meetio/scheme-generator/dist/types';

const colorPalette = {
    accent: '#80CBC4',
    cursor: '#FFCC00',
    foreground: '#EEFFFF',
    background: '#263238',
    comments: '#546E7A',
    deprecated: '#FFC777A1',
    invalid: '#D46C6C66',
    diffAdded: '#ADDB67',
    diffModified: '#E2B93D',
    diffDeleted: '#EF5350',
};

const uiSettings: UI = {
   line_diff_width: '3',
    brackets_options: 'underline, glow',
};

const mergedRules = Object.values(rules).flatMap(rule => rule);

const settings: SchemeSetting = {
    colors: colorPalette,
    ui: {
        ...ui,
        ...uiSettings,
    },
    rules: mergedRules,
};

generateScheme({
    name: 'Scheme Example',
    author: 'Mauro Reis Vieira <[email protected]>',
    output: {
        filename: 'Scheme Example',
    },
    settings,
});

Support

Support below means that the standard Sublime Text grammar has explicit support for the languages. Other languages will probably still look alright but there is no guarantee that they will.

• CSS/SASS/SCSS
• HTML
• JSON
• JavaScript/JSX
• TypeScript/TSX
• Markdown
• SQL
• PHP
• Python
• YAML
• Vue
• Git

External Plugins Support

• BetterFindBuffer

Import default syntax:

import { generateScheme, SchemeSetting, options } from '@meetio/scheme-generator';

// options contains default styles for syntax scopes.
const { ui, ...rest } = options;

const settings: SchemeSetting = {
    colors: { ... },
    ui,
    rules: [].concat.apply([], Object.values(rest).map(item => item)),
};

Development

# Using NPM
npm run watch

# Using Yarn
yarn run watch

Project inspired on code-theme-generator for VSCode.