monaco-theme-converter v0.0.9

monaco-theme-converter

An easy way to use vscode theme in monaco-editor based on monaco-vscode-api.

Supported Language & Theme

Language

• C
• Go
• C#
• C++
• CSS
• PHP
• Java
• Rust
• JSON
• HTML
• Python
• JavaScript
• TypeScript

Theme

• VS
• VS Dark
• Moonlight
• Ariake Dark
• Vitesse Dark
• Atom One Dark
• Atom One Light

Usage

Basic Usage

Before

import * as monaco from 'monaco-editor'

const editor = monaco.editor.create(
  document.getElementById('app'),
  {
    language: 'javascript',
    value: 'function foo() {}',
    automaticLayout: true,
    minimap: {
      enabled: false,
    },
  },
)

After

In comparison to the native approach, apart from the distinction in calling the API to create an editor, there is another difference. createEditor supports the provision of a third parameter, which is used to specify the path for supplying language and theme resources. When you are using a specific language or theme, this library will fetch resources from the address you provided.

import createEditor from 'monaco-theme-converter'

const { editor, setTheme } = createEditor(
  document.getElementById('app'),
  {
    language: 'javascript',
    value: 'function foo() {}',
    automaticLayout: true,
    // rewrite types of theme that you can use to set default vscode theme
    theme: 'AtomOneDark',
    minimap: {
      enabled: false,
    },
  },
  {
    domain: 'danzzzz.netlify.app',
    path: '/resources',
  },
)

// or use setTheme API
setTheme('VSDark')

In the above code, you can see that the domain is danzzzz.netlify.app and the path is /resources. This indicates that when using the java(e.g.) language, resources will be fetched from

• https://danzzzz.netlify.app/resources/java/java.configuration.json

• https://danzzzz.netlify.app/resources/java/java.tmLanguage.json

For theme resource

• https://danzzzz.netlify.app/resources/themes/theme-defaults~atom_one_dark.json

Where are these resources?

You can find tested resources in here, and you only need to upload the resources to your server, and when calling createEditor, pass in the server's domain name and resource path.

How to use other theme that not included in this library?

Step1

Open your Visual Studio Code, use Shift + command + p shortcut to open the command panel, select Developer: Generate Color Theme From Current Settings

Step2

After step1, you could see the current color settings, and remember to remove the comments,

Step3

Save the current color settings and name it like theme-defaults~[themeName].json and upload the file to your server like https://example.com/resources/themes/theme-defaults~[themeName].json

Step4

Using the customized theme named in step3

import createEditor, { ThemesEnum } from 'monaco-theme-converter'

const { setTheme } = createEditor(
  document.getElementById('app'),
  {
    // set customized theme as default theme
    theme: 'CustomTheme' as ThemesEnum
  },
  {
    domain: 'example.com',
    path: '/resources',
    themes: [
      {
        // theme file name on your server
        filename: [themeName],
        // Actually used when using setTheme
        theme: 'CustomTheme',
        baseTheme: 'vs-dark' | 'vs'
      },
      ...
    ]
  }
)

// or using setTheme API
// setTheme('CustomTheme' as ThemesEnum)

When you want to use your customized theme, you can use setTheme('CustomTheme') or to set CustomTheme as default theme in the second parameter.