Package Exports

monaco-sql-languages
monaco-sql-languages/out/esm/main.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (monaco-sql-languages) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Monaco SQL Languages

English | 简体中文

This project is based on the SQL language project of Monaco Editor, which was forked from the monaco-languages.

The difference is that Monaco SQL Languages has integrated with various SQL languages for the Big Data field, such as FlinkSQL, SparkSQL, HiveSQL, and others.

In addition, Monaco SQL Languages provides SQL syntax validation and CodeCompletion feature for these languages via dt-sql-parser.

Online Preview

https://dtstack.github.io/monaco-sql-languages/

Supported SQL Languages

MySQL
FlinkSQL
SparkSQL
HiveSQL
TrinoSQL (PrestoSQL)
PostgreSQL
Impala SQL

Supported CodeCompletion SQL Languages

SQL Type	Language Id	Code-Completion
MySQL	mysql	✅
Flink SQL	flinksql	✅
Spark SQL	sparksql	✅
Hive SQL	hivesql	✅
Trino SQL	trinosql	✅
PostgreSQL	pgsql	✅
Impala SQL	impalasql	✅

Monaco SQL Languages plan to support more types of SQL Languages in the future. If you need some SQL Languages that are not currently supported, you can contact us at github.

Installing

npm install monaco-sql-languages

Tips: Monaco SQL Languages is only guaranteed to work stably on monaco-editor@0.31.0 for now.

Integrating

Using the Monaco Editor Webpack Plugin

Install Monaco Editor Webpack Plugin

npm install monaco-editor-webpack-plugin

Apply Monaco Editor Webpack Plugin in webpack config

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

const monacoWebpackPlugin = new MonacoWebpackPlugin({
    features: [], // Include only a subset of the editor features
    languages: [], // Include only a subset of the monaco built-in languages
    customLanguages: [
        // Include languages that provides by Monaco SQL Languages
        {
            label: 'mysql',
            entry: 'monaco-sql-languages/out/esm/mysql/mysql.contribution',
            worker: {
                id: 'monaco-sql-languages/out/esm/mysql/mySQLWorker',
                entry: 'monaco-sql-languages/out/esm/mysql/mysql.worker'
            }
        },
        {
            label: 'flinksql',
            entry: 'monaco-sql-languages/out/esm/flinksql/flinksql.contribution',
            worker: {
                id: 'monaco-sql-languages/out/esm/flinksql/flinkSQLWorker',
                entry: 'monaco-sql-languages/out/esm/flinksql/flinksql.worker'
            }
        },
        {
            label: 'sparksql',
            entry: 'monaco-sql-languages/out/esm/sparksql/sparksql.contribution',
            worker: {
                id: 'monaco-sql-languages/out/esm/sparksql/sparkSQLWorker',
                entry: 'monaco-sql-languages/out/esm/sparksql/sparksql.worker'
            }
        },
        {
            label: 'hivesql',
            entry: 'monaco-sql-languages/out/esm/hivesql/hivesql.contribution',
            worker: {
                id: 'monaco-sql-languages/out/esm/hivesql/hiveSQLWorker',
                entry: 'monaco-sql-languages/out/esm/hivesql/hivesql.worker'
            }
        },
        {
            label: 'trinosql',
            entry: 'monaco-sql-languages/out/esm/trinosql/trinosql.contribution',
            worker: {
                id: 'monaco-sql-languages/out/esm/trinosql/TrinoSQLWorker',
                entry: 'monaco-sql-languages/out/esm/trinosql/trinosql.worker'
            }
        },
        {
            label: 'pgsql',
            entry: 'monaco-sql-languages/out/esm/pgsql/pgsql.contribution',
            worker: {
                id: 'monaco-sql-languages/out/esm/pgsql/PgSQLWorker',
                entry: 'monaco-sql-languages/out/esm/pgsql/pgsql.worker'
            }
        },
        {
            label: 'impalasql',
            entry: 'monaco-sql-languages/out/esm/impalasql/impalasql.contribution',
            worker: {
                id: 'monaco-sql-languages/out/esm/impalasql/impalaSQLWorker',
                entry: 'monaco-sql-languages/out/esm/impalasql/impalasql.worker'
            }
        }
    ]
});

module.exports = {
    entry: './index.js',
    output: {
        path: path.resolve(__dirname, 'dist'),
        filename: 'app.js'
    },
    module: {},
    plugins: [monacoEditorPlugin] // Apply monacoWebpackPlugin
};

More options of Monaco Editor Webpack Plugin, see here.

Using Plain Webpack

Output worker files via webpack entries.

entry: {
    'mysql.worker': 'monaco-sql-languages/out/esm/mysql/mysql.worker.js',
    'flinksql.worker': 'monaco-sql-languages/out/esm/flinksql/flinksql.worker.js',
    'sparksql.worker': 'monaco-sql-languages/out/esm/sparksql/sparksql.worker.js',
    'hivesql.worker': 'monaco-sql-languages/out/esm/hivesql/hivesql.worker.js',
    'trinosql.worker': 'monaco-sql-languages/out/esm/trinosql/trinosql.worker.js',
    'pgsql.worker': 'monaco-sql-languages/out/esm/pgsql/pgsql.worker.js',
    'impalasql.worker': 'monaco-sql-languages/out/esm/impalasql/impalasql.worker.js',
    'editor.worker': 'monaco-editor/esm/vs/editor/editor.worker.js',
},

Define the global variable MonacoEnvironment and specify the path of the worker file

window.MonacoEnvironment = {
    getWorkerUrl: function (moduleId, label) {
        switch (label) {
            case 'mysql': {
                return './mysql.worker.js';
            }
            case 'sparksql': {
                return './sparksql.worker.js';
            }
            case 'flinksql': {
                return './flinksql.worker.js';
            }
            case 'hivesql': {
                return './hivesql.worker.js';
            }
            case 'trinosql': {
                return './trinosql.worker.js';
            }
            case 'pgsql': {
                return './pgsql.worker.js';
            }
            case 'impalasql': {
                return './impalasql.worker.js'
            }
            default: {
                return './editor.worker.js';
            }
        }
    }
};

Using Vite

Vite example see https://github.com/DTStack/monaco-sql-languages/blob/main/website/src/languageWorker.ts

Usage

Import language contributions

Tips: If integrated via MonacoEditorWebpackPlugin, it will help us to import contribution files automatically. Otherwise, you need to import the contribution files manually.

import 'monaco-sql-languages/out/esm/mysql/mysql.contribution';
import 'monaco-sql-languages/out/esm/flinksql/flinksql.contribution';
import 'monaco-sql-languages/out/esm/sparksql/sparksql.contribution';
import 'monaco-sql-languages/out/esm/hivesql/hivesql.contribution';
import 'monaco-sql-languages/out/esm/trinosql/trinosql.contribution';
import 'monaco-sql-languages/out/esm/impalasql/impalasql.contribution';
import 'monaco-sql-languages/out/esm/pgsql/pgsql.contribution';

// Or you can import all language contributions at once.
// import 'monaco-sql-languages/out/esm/monaco.contribution';

Setup language features

You can setup language features via setupLanguageFeatures. For example, disable code completion feature of flinkSQL language.

import {
    setupLanguageFeatures,
    LanguageIdEnum,
} from 'monaco-sql-languages';

setupLanguageFeatures({
    languageId: LanguageIdEnum.FLINK,
    completionItems: false
})

By default, MonacoSQLLanguages only provides keyword autocompletion, and you can customize your completionItem list via completionService.

import { languages } from 'monaco-editor/esm/vs/editor/editor.api';
import {
    setupLanguageFeatures,
    LanguageIdEnum,
    CompletionService,
    ICompletionItem,
    SyntaxContextType
 } from 'monaco-sql-languages';

const completionService: CompletionService = function (
    model,
    position,
    completionContext,
    suggestions
) {
    return new Promise((resolve, reject) => {
        if (!suggestions) {
            return Promise.resolve([]);
        }
        const { keywords, syntax } = suggestions;
        const keywordsCompletionItems: ICompletionItem[] = keywords.map((kw) => ({
            label: kw,
            kind: languages.CompletionItemKind.Keyword,
            detail: 'keyword',
            sortText: '2' + kw
        }));

        let syntaxCompletionItems: ICompletionItem[] = [];

        syntax.forEach((item) => {
            if (item.syntaxContextType === SyntaxContextType.DATABASE) {
                const databaseCompletions: ICompletionItem[] = []; // some completions about databaseName
                syntaxCompletionItems = [...syntaxCompletionItems, ...databaseCompletions];
            }
            if (item.syntaxContextType === SyntaxContextType.TABLE) {
                const tableCompletions: ICompletionItem[] = []; // some completions about tableName
                syntaxCompletionItems = [...syntaxCompletionItems, ...tableCompletions];
            }
        });

        resolve([...syntaxCompletionItems, ...keywordsCompletionItems]);
    });
};

setupLanguageFeatures({
    languageId: LanguageIdEnum.FLINK,
    completionService: completionService,
})

Create the Monaco Editor instance and specify the language you need

monaco.editor.create(document.getElementById('container'), {
    value: 'select * from tb_test',
    language: 'flinksql' // you need
});

Monaco Theme

Monaco SQL Languages plan to support more themes in the future.

Monaco SQL Languages provides built-in Monaco Theme that is named vsPlusTheme. vsPlusTheme inspired by vscode default plus colorTheme and it contains three styles of themes inside:

darkTheme: inherited from Monaco built-in Theme vs-dark;
lightTheme: inherited from Monaco built-in Theme vs;
hcBlackTheme: inherited from Monaco built-in Theme hc-black;

Use Monaco SQL Languages built-in vsPlusTheme

import { vsPlusTheme } from 'monaco-sql-languages';
import { editor } from 'monaco-editor';

// import themeData and defineTheme, you can customize the theme name, e.g. sql-dark
editor.defineTheme('sql-dark', vsPlusTheme.darkThemeData);
editor.defineTheme('sql-light', vsPlusTheme.lightThemeData);
editor.defineTheme('sql-hc', vsPlusTheme.hcBlackThemeData);

// specify the theme you have defined
editor.create(null as any, {
    theme: 'sql-dark',
    language: 'flinksql'
});

Customize your own Monaco theme

import { TokenClassConsts, postfixTokenClass } from 'monaco-sql-languages';

// Customize the various tokens style
const myThemeData: editor.IStandaloneThemeData = {
    base: 'vs-dark',
    inherit: true,
    rules: [
        { token: postfixTokenClass(TokenClassConsts.COMMENT), foreground: '6a9955' },
        { token: postfixTokenClass(TokenClassConsts.IDENTIFIER), foreground: '9cdcfe' },
        { token: postfixTokenClass(TokenClassConsts.KEYWORD), foreground: '569cd6' },
        { token: postfixTokenClass(TokenClassConsts.NUMBER), foreground: 'b5cea8' },
        { token: postfixTokenClass(TokenClassConsts.STRING), foreground: 'ce9178' },
        { token: postfixTokenClass(TokenClassConsts.TYPE), foreground: '4ec9b0' }
    ],
    colors: {}
};

// Define the monaco theme
editor.defineTheme('my-theme', myThemeData);

postfixTokenClass is not required in most cases, but since Monaco SQL Languages has tokenPostfix: 'sql' internally set for all SQL languages, in some cases your custom style may not work if you don't use postfixTokenClassClass to handle TokenClassConsts.*.

Dev: cheat sheet

initial setup
```
pnpm install
```

open the dev web

pnpm watch-esm
cd website
pnpm install
pnpm dev

compile
```
pnpm compile
```
run test
```
pnpm compile
pnpm test
```

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

License

MIT