@codingame/monaco-vscode-editor-api 20.1.1 → 20.2.0

package/vscode/src/vs/editor/standalone/common/monarch/monarchLexer.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Create a syntax highighter with a fully declarative JSON style lexer description
+ * using regular expressions.
+ */
 import { Disposable, IDisposable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle";
 import * as languages from "@codingame/monaco-vscode-api/vscode/vs/editor/common/languages";
 import { ILanguageService } from "@codingame/monaco-vscode-api/vscode/vs/editor/common/languages/language.service";

package/vscode/src/vs/editor/standalone/common/monarch/monarchTypes.d.ts

@@ -1,16 +1,52 @@
+/**
+ * A Monarch language definition
+ */
 export interface IMonarchLanguage {
+    /**
+     * map from string to ILanguageRule[]
+     */
     tokenizer: {
         [name: string]: IMonarchLanguageRule[];
     };
+    /**
+     * is the language case insensitive?
+     */
     ignoreCase?: boolean;
+    /**
+     * is the language unicode-aware? (i.e., /\u{1D306}/)
+     */
     unicode?: boolean;
+    /**
+     * if no match in the tokenizer assign this token class (default 'source')
+     */
     defaultToken?: string;
+    /**
+     * for example [['{','}','delimiter.curly']]
+     */
     brackets?: IMonarchLanguageBracket[];
+    /**
+     * start symbol in the tokenizer (by default the first entry is used)
+     */
     start?: string;
+    /**
+     * attach this to every token class (by default '.' + name)
+     */
     tokenPostfix?: string;
+    /**
+     * include line feeds (in the form of a \n character) at the end of lines
+     * Defaults to false
+     */
     includeLF?: boolean;
+    /**
+     * Other keys that can be referred to by the tokenizer.
+     */
     [key: string]: any;
 }
+/**
+ * A rule is either a regular expression and an action
+ * 		shorthands: [reg,act] == { regex: reg, action: act}
+ *		and       : [reg,act,nxt] == { regex: reg, action: act{ next: nxt }}
+ */
 export type IShortMonarchLanguageRule1 = [
     string | RegExp,
     IMonarchLanguageAction
@@ -21,26 +57,79 @@ export type IShortMonarchLanguageRule2 = [
     string
 ];
 export interface IExpandedMonarchLanguageRule {
+    /**
+     * match tokens
+     */
     regex?: string | RegExp;
+    /**
+     * action to take on match
+     */
     action?: IMonarchLanguageAction;
+    /**
+     * or an include rule. include all rules from the included state
+     */
     include?: string;
 }
 export type IMonarchLanguageRule = IShortMonarchLanguageRule1 | IShortMonarchLanguageRule2 | IExpandedMonarchLanguageRule;
+/**
+ * An action is either an array of actions...
+ * ... or a case statement with guards...
+ * ... or a basic action with a token value.
+ */
 export type IShortMonarchLanguageAction = string;
 export interface IExpandedMonarchLanguageAction {
+    /**
+     * array of actions for each parenthesized match group
+     */
     group?: IMonarchLanguageAction[];
+    /**
+     * map from string to ILanguageAction
+     */
     cases?: Object;
+    /**
+     * token class (ie. css class) (or "@brackets" or "@rematch")
+     */
     token?: string;
+    /**
+     * the next state to push, or "@push", "@pop", "@popall"
+     */
     next?: string;
+    /**
+     * switch to this state
+     */
     switchTo?: string;
+    /**
+     * go back n characters in the stream
+     */
     goBack?: number;
+    /**
+     * @open or @close
+     */
     bracket?: string;
+    /**
+     * switch to embedded language (using the mimetype) or get out using "@pop"
+     */
     nextEmbedded?: string;
+    /**
+     * log a message to the browser console window
+     */
     log?: string;
 }
 export type IMonarchLanguageAction = IShortMonarchLanguageAction | IExpandedMonarchLanguageAction | (IShortMonarchLanguageAction | IExpandedMonarchLanguageAction)[];
+/**
+ * This interface can be shortened as an array, ie. ['{','}','delimiter.curly']
+ */
 export interface IMonarchLanguageBracket {
+    /**
+     * open bracket
+     */
     open: string;
+    /**
+     * closing bracket
+     */
     close: string;
+    /**
+     * token class
+     */
     token: string;
 }