monaco-editor-webpack-plugin

What is monaco-editor-webpack-plugin?

The monaco-editor-webpack-plugin is a plugin for webpack that simplifies the integration of the Monaco Editor into your webpack build process. It handles the necessary configuration and optimizations to ensure that the Monaco Editor works seamlessly within your application.

What are monaco-editor-webpack-plugin's main functionalities?

Basic Integration

This feature allows you to easily integrate the Monaco Editor into your webpack build by adding the MonacoWebpackPlugin to your webpack configuration.

const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');

module.exports = {
  // other webpack configuration
  plugins: [
    new MonacoWebpackPlugin()
  ]
};

Language Configuration

This feature allows you to specify which languages you want to include in the Monaco Editor, reducing the bundle size by only including the necessary language support.

const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');

module.exports = {
  // other webpack configuration
  plugins: [
    new MonacoWebpackPlugin({
      languages: ['javascript', 'css', 'html', 'typescript']
    })
  ]
};

Custom Features

This feature allows you to customize which features of the Monaco Editor you want to include or exclude, providing more control over the final bundle size and functionality.

const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');

module.exports = {
  // other webpack configuration
  plugins: [
    new MonacoWebpackPlugin({
      features: ['!gotoSymbol']
    })
  ]
};

Other packages similar to monaco-editor-webpack-plugin

monaco-editor

The monaco-editor package is the core editor package that provides the Monaco Editor itself. Unlike monaco-editor-webpack-plugin, it does not handle webpack integration or optimizations, so you would need to manually configure webpack to work with the Monaco Editor.

react-monaco-editor

The react-monaco-editor package provides a React component for the Monaco Editor. It simplifies the integration of the Monaco Editor into React applications but does not handle webpack-specific configurations or optimizations like monaco-editor-webpack-plugin.

monaco-editor-esm-webpack-plugin

The monaco-editor-esm-webpack-plugin is another webpack plugin for the Monaco Editor that focuses on using ES modules. It provides similar functionalities to monaco-editor-webpack-plugin but with a focus on modern JavaScript module standards.

README

Monaco Editor Webpack Loader Plugin

A plugin to simplify loading the Monaco Editor with webpack.

Installing

npm install monaco-editor-webpack-plugin

Using

• webpack.config.js:

const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');
const path = require('path');

module.exports = {
	entry: './index.js',
	output: {
		path: path.resolve(__dirname, 'dist'),
		filename: 'app.js'
	},
	module: {
		rules: [
			{
				test: /\.css$/,
				use: ['style-loader', 'css-loader']
			},
			{
				test: /\.ttf$/,
				type: 'asset/resource'
			}
		]
	},
	plugins: [new MonacoWebpackPlugin()]
};

If using Webpack 4 or lower, it is necessary to use the file-loader instead of Asset Modules like the code below:

{
	test: /\.ttf$/,
	use: ['file-loader']
}

• index.js:

import * as monaco from 'monaco-editor';
// or import * as monaco from 'monaco-editor/esm/vs/editor/editor.api';
// if shipping only a subset of the features & languages is desired

monaco.editor.create(document.getElementById('container'), {
	value: 'console.log("Hello, world")',
	language: 'javascript'
});

Options

Options can be passed in to MonacoWebpackPlugin. They can be used to generate a smaller editor bundle by selecting only certain languages or only certain editor features:

• filename (string) - custom filename template for worker scripts, respects the same options as loader-utils' interpolateName. Useful for adding content-based hashes so that files can be served with long-lived caching headers.

  • default value: '[name].worker.js'.

• publicPath (string) - custom public path for worker scripts, overrides the public path from which files generated by this plugin will be served. This wins out over Webpack's dynamic runtime path and can be useful to avoid attempting to load workers cross-origin when using a CDN for other static resources. Use e.g. '/' if you want to load your resources from the current origin..

  • default value: ''.

• languages (string[]) - include only a subset of the languages supported. By default, all languages shipped with the monaco-editor will be included.

  Some languages share the same web worker. If one of the following languages is included, you must also include the language responsible for instantiating their shared worker:

  Language	Instantiator
  javascript	typescript
  handlebars	html
  scss, less	css

  To view a list of all available languages, you can run import metadata from 'monaco-editor/esm/metadata'; console.log(metadata.languages);.

• features (string[]) - include only a subset of the editor features. By default, all features shipped with the monaco-editor will be included. Instead of enumerating included features, it is also possible to exclude certain default features prefixing them with an exclamation mark '!'.

  To view a list of all available features, you can run import metadata from 'monaco-editor/esm/metadata'; console.log(metadata.features);.

• globalAPI (boolean) - specify whether the editor API should be exposed through a global monaco object or not. This option is applicable to 0.22.0 and newer version of monaco-editor. Since 0.22.0, the ESM version of the monaco editor does no longer define a global monaco object unless global.MonacoEnvironment = { globalAPI: true } is set (change log).

  • default value: false.

Version Matrix

monaco-editor-webpack-plugin	monaco-editor
7.*.*	>= 0.31.0
6.*.*	0.30.*
5.*.*	0.29.*
4.*.*	0.25.*, 0.26.*, 0.27.*, 0.28.*
3.*.*	0.22.*, 0.23.*, 0.24.*
2.*.*	0.21.*
1.9.*	0.20.*
1.8.*	0.19.*
1.7.*	0.18.*

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.