Files
australis-theme-generator/README.md
2017-03-31 03:27:26 -07:00

1.9 KiB

vscode-theme-generator

⚠️ This is a preview that leverages the upcoming VS Code theming options, you will need to regenerate your theme when 1.12 is released and the API finalized

The Problem

  • New themes are typically forked from other themes, carrying the bugs with them
  • .tmThemes are overly verbose and difficult to maintain
  • Themes are difficult to write from scratch

The Solution

What if all you needed to do to generate a theme was specify a few colors and everything else was handled for you? Well that's what this module aims to accomplish. All you need to do is specify a set of "base colors" (background, foreground and 4 accent colors) and you have a reasonably good looking theme.

All other VS Code theme colors are then derived from those base colors, with the option to tweak each underlying color as well.

Example

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

import { generateTheme, IColorSet } from 'vscode-theme-generator';
const colorSet: IColorSet = {
  base: {
    background: '#12171F',
    foreground: '#EFEFEF',
    color1: '#399EF4',
    color2: '#DA6771',
    color3: '#4EB071',
    color4: '#fff099',
  }
};
generateTheme('My Theme', colorSet, path.join(__dirname, 'theme.json'));

Support

Support below means that the standard VS Code grammar has explicit support for the languages; the colors should match their meanings. Other languages will probably still look alright but there is no guarentee that they will.

  • CSS
  • JavaScript
  • HTML
  • TypeScript
  • Markdown
  • C#

Development

npm run dev

Then in VS Code press F5 to build demo and launch the debugger with the generated themes available to switch to.