@harmoniclabs/monaco-editor 0.52.0

package/test/smoke/smoke.test.js

@@ -0,0 +1,215 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+//@ts-check
+
+const playwright = require('playwright');
+const { assert } = require('chai');
+
+/** @typedef {import('./common').BrowserKind} BrowserKind */
+/** @typedef {import('./common').PackagerKind} PackagerKind */
+/** @typedef {import('./common').TestInfo} TestInfo */
+
+/** @type TestInfo */
+const testInfo = JSON.parse(process.env.MONACO_TEST_INFO || '');
+
+const URLS = {
+	amd: `http://127.0.0.1:${testInfo.port}/test/smoke/amd/index.html`,
+	webpack: `http://127.0.0.1:${testInfo.port}/test/smoke/webpack/index.html`,
+	esbuild: `http://127.0.0.1:${testInfo.port}/test/smoke/esbuild/index.html`,
+	vite: `http://127.0.0.1:${testInfo.port}/test/smoke/vite/dist/index.html`,
+	parcel: `http://127.0.0.1:${testInfo.port}/test/smoke/parcel/dist/index.html`
+};
+const URL = URLS[testInfo.packager];
+
+suite(`Smoke Test '${testInfo.packager}' on '${testInfo.browser}'`, () => {
+	/** @type {playwright.Browser} */
+	let browser;
+
+	/** @type {playwright.Page} */
+	let page;
+
+	suiteSetup(async () => {
+		browser = await playwright[testInfo.browser].launch({
+			headless: !testInfo.debugTests,
+			devtools: testInfo.debugTests && testInfo.browser === 'chromium'
+			// slowMo: testInfo.debugTests ? 2000 : 0
+		});
+	});
+
+	suiteTeardown(async () => {
+		await browser.close();
+	});
+
+	let pageErrors = [];
+
+	setup(async () => {
+		pageErrors = [];
+		page = await browser.newPage({
+			viewport: {
+				width: 800,
+				height: 600
+			}
+		});
+		page.on('pageerror', (e) => {
+			console.log(e);
+			pageErrors.push(e);
+		});
+		const response = await page.goto(URL);
+		if (!response) {
+			assert.fail('Failed to load page');
+		}
+		assert.strictEqual(response.status(), 200);
+	});
+
+	teardown(async () => {
+		for (const e of pageErrors) {
+			throw e;
+		}
+		await page.close();
+	});
+
+	/**
+	 * @param {string} text
+	 * @param {string} language
+	 * @returns Promise<void>
+	 */
+	async function createEditor(text, language) {
+		return await page.evaluate(
+			`window.ed = monacoAPI.editor.create(document.getElementById('editor-container'), { value: '${text}', language: '${language}' })`
+		);
+	}
+
+	/**
+	 * @param {number} lineNumber
+	 * @param {number} column
+	 * @returns Promise<void>
+	 */
+	async function setEditorPosition(lineNumber, column) {
+		return await page.evaluate(
+			`window.ed.setPosition({ lineNumber: ${lineNumber}, column: ${column} });`
+		);
+	}
+
+	/**
+	 * @param {string} commandId
+	 * @param {any} [args]
+	 * @returns Promise<void>
+	 */
+	async function triggerEditorCommand(commandId, args) {
+		return await page.evaluate(
+			`window.ed.trigger(null, '${commandId}', ${args ? JSON.stringify(args) : 'undefined'});`
+		);
+	}
+
+	async function focusEditor() {
+		await page.evaluate(`window.ed.focus();`);
+	}
+
+	test('`monacoAPI` is exposed as global', async function () {
+		assert.strictEqual(await page.evaluate(`typeof monacoAPI`), 'object');
+	});
+
+	test('should be able to create plaintext editor', async function () {
+		await createEditor('hello world', 'plaintext');
+
+		// type a link in it
+		await setEditorPosition(1, 12);
+		await triggerEditorCommand('type', { text: '\nhttps://www.microsoft.com' });
+
+		// check that the link gets highlighted, which indicates that the web worker is healthy
+		await page.waitForSelector('.detected-link');
+	});
+
+	test('css smoke test', async function () {
+		await createEditor('.sel1 { background: red; }\\n.sel2 {}', 'css');
+
+		// check that a squiggle appears, which indicates that the language service is up and running
+		await page.waitForSelector('.squiggly-warning');
+	});
+
+	test('html smoke test', async function () {
+		await createEditor('<title>hi</title>', 'html');
+
+		// we need to try this a couple of times because the web worker might not be ready yet
+		for (let attempt = 1; attempt <= 2; attempt++) {
+			// trigger hover
+			await focusEditor();
+			await setEditorPosition(1, 3);
+			await page.keyboard.press('F1');
+			await page.keyboard.type('Show Hover');
+			await page.keyboard.press('Enter');
+
+			// check that a hover explaining the `<title>` element appears, which indicates that the language service is up and running
+			try {
+				await page.waitForSelector(
+					`text=The title element represents the document's title or name`,
+					{ timeout: 5000 }
+				);
+			} catch (err) {}
+		}
+	});
+
+	test('json smoke test', async function () {
+		await createEditor('{}', 'json');
+
+		// we need to try this a couple of times because the web worker might not be ready yet
+		for (let attempt = 1; attempt <= 2; attempt++) {
+			// trigger suggestions
+			await focusEditor();
+			await setEditorPosition(1, 2);
+			await triggerEditorCommand('editor.action.triggerSuggest');
+
+			// check that a suggestion item for `$schema` appears, which indicates that the language service is up and running
+			try {
+				await page.waitForSelector(`text=$schema`, { timeout: 5000 });
+			} catch (err) {}
+		}
+	});
+
+	test('typescript smoke test', async function () {
+		await createEditor('window.add', 'typescript');
+
+		// check that a squiggle appears, which indicates that the language service is up and running
+		await page.waitForSelector('.squiggly-error');
+
+		// at this point we know that the web worker is healthy, so we can trigger suggestions
+
+		// trigger suggestions
+		await focusEditor();
+		await setEditorPosition(1, 11);
+		await triggerEditorCommand('editor.action.triggerSuggest');
+
+		// check that a suggestion item for `addEventListener` appears, which indicates that the language service is up and running
+		await page.waitForSelector(`text=addEventListener`);
+
+		// find the TypeScript worker
+
+		function findAsync(arr, fn) {
+			return Promise.all(arr.map(fn)).then((results) => {
+				return arr.find((_, i) => results[i]);
+			});
+		}
+
+		// check that the TypeScript worker exposes `ts` as a global
+		const tsWorker = await findAsync(
+			page.workers(),
+			async (page) => await page.evaluate(`typeof ts !== 'undefined'`)
+		);
+
+		if (!tsWorker) {
+			assert.fail('Could not find TypeScript worker');
+		}
+
+		// check that the TypeScript worker exposes the full `ts` as a global
+		assert.strictEqual(await tsWorker.evaluate(`typeof ts.optionDeclarations`), 'object');
+	});
+});
+
+function timeout(ms) {
+	return new Promise((resolve, reject) => {
+		setTimeout(resolve, ms);
+	});
+}

package/test/smoke/vite/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+	</head>
+	<body>
+		<div id="editor-container" style="position: absolute; width: 500px; height: 400px"></div>
+		<script type="module" src="index.js"></script>
+	</body>
+</html>

package/test/smoke/vite/index.js

@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as monaco from '../../../out/monaco-editor/esm/vs/editor/editor.main';
+import editorWorker from '../../../out/monaco-editor/esm/vs/editor/editor.worker?worker';
+import jsonWorker from '../../../out/monaco-editor/esm/vs/language/json/json.worker?worker';
+import cssWorker from '../../../out/monaco-editor/esm/vs/language/css/css.worker?worker';
+import htmlWorker from '../../../out/monaco-editor/esm/vs/language/html/html.worker?worker';
+import tsWorker from '../../../out/monaco-editor/esm/vs/language/typescript/ts.worker?worker';
+
+self.MonacoEnvironment = {
+	getWorker(moduleId, label) {
+		if (label === 'json') {
+			return new jsonWorker();
+		}
+		if (label === 'css' || label === 'scss' || label === 'less') {
+			return new cssWorker();
+		}
+		if (label === 'html' || label === 'handlebars' || label === 'razor') {
+			return new htmlWorker();
+		}
+		if (label === 'typescript' || label === 'javascript') {
+			return new tsWorker();
+		}
+		return new editorWorker();
+	}
+};
+
+window.monacoAPI = monaco;

package/test/smoke/webpack/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+	</head>
+	<body>
+		<div id="editor-container" style="position: absolute; width: 500px; height: 400px"></div>
+		<script type="text/javascript" src="out/app.js"></script>
+	</body>
+</html>

package/test/smoke/webpack/index.js

@@ -0,0 +1,4 @@
+import * as monaco from 'monaco-editor/esm/vs/editor/editor.api';
+
+// expose the monaco API as a global for tests
+window.monacoAPI = monaco;

package/test/unit/all.js

@@ -0,0 +1,70 @@
+const requirejs = require('requirejs');
+const jsdom = require('jsdom');
+const glob = require('glob');
+const path = require('path');
+
+requirejs.config({
+	baseUrl: '',
+	paths: {
+		'vs/fillers/monaco-editor-core': 'out/languages/amd-tsc/fillers/monaco-editor-core-amd',
+		'vs/basic-languages': 'out/languages/amd-tsc/basic-languages',
+		vs: './node_modules/monaco-editor-core/dev/vs'
+	},
+	nodeRequire: require
+});
+
+const tmp = new jsdom.JSDOM('<!DOCTYPE html><html><body></body></html>');
+global.AMD = true;
+global.document = tmp.window.document;
+global.navigator = tmp.window.navigator;
+global.self = global;
+global.document.queryCommandSupported = function () {
+	return false;
+};
+global.UIEvent = tmp.window.UIEvent;
+
+global.window = {
+	location: {},
+	navigator: tmp.window.navigator,
+	document: {
+		body: tmp.window.document.body,
+		addEventListener: (...args) => tmp.window.document.addEventListener(...args)
+	},
+	matchMedia: function () {
+		return {
+			matches: false,
+			addEventListener: function () {}
+		};
+	},
+	setInterval: function () {},
+	setTimeout: function () {}
+};
+
+requirejs(
+	['test/unit/setup'],
+	function () {
+		glob(
+			'out/languages/amd-tsc/basic-languages/*/*.test.js',
+			{ cwd: path.join(__dirname, '../../') },
+			function (err, files) {
+				if (err) {
+					console.log(err);
+					return;
+				}
+				requirejs(
+					files.map((f) => f.replace(/^out\/languages\/amd-tsc/, 'vs').replace(/\.js$/, '')),
+					function () {
+						run(); // We can launch the tests!
+					},
+					function (err) {
+						console.log(err);
+					}
+				);
+			}
+		);
+	},
+	function (err) {
+		console.log(err);
+		process.exit(1);
+	}
+);

package/test/unit/setup.js

@@ -0,0 +1,34 @@
+define('vs/css', [], {
+	load: function (name, req, load) {
+		load({});
+	}
+});
+
+define('vs/nls', [], {
+	create: function () {
+		return {
+			localize: function () {
+				return 'NO_LOCALIZATION_FOR_YOU';
+			},
+			localize2: function () {
+				return 'NO_LOCALIZATION_FOR_YOU';
+			},
+			getConfiguredDefaultLocale: function () {
+				return undefined;
+			}
+		};
+	},
+	localize: function () {
+		return 'NO_LOCALIZATION_FOR_YOU';
+	},
+	localize2: function (key, message) {
+		return { value: 'NO_LOCALIZATION_FOR_YOU', original: message };
+	},
+	load: function (name, req, load) {
+		load({});
+	}
+});
+
+define(['vs/editor/editor.main'], function (api) {
+	global.monaco = api;
+});

package/webpack-plugin/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/webpack-plugin/README.md

@@ -0,0 +1,116 @@
+# Monaco Editor Webpack Loader Plugin
+
+A plugin to simplify loading the [Monaco Editor](https://github.com/microsoft/monaco-editor) with [webpack](https://webpack.js.org/).
+
+## Installing
+
+```sh
+npm install monaco-editor-webpack-plugin
+```
+
+## Using
+
+- `webpack.config.js`:
+
+```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:
+
+```js
+{
+	test: /\.ttf$/,
+	use: ['file-loader']
+}
+```
+
+- `index.js`:
+
+```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](https://github.com/webpack/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](https://github.com/microsoft/monaco-editor/blob/main/CHANGELOG.md#0220-29012021)).
+  - 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](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.