You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
358 lines
19 KiB
358 lines
19 KiB
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>LanguageConfiguration | VS Code API</title>
|
|
<meta name="description" content="Documentation for VS Code API">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">VS Code API</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">VS Code API</a>
|
|
</li>
|
|
<li>
|
|
<a href="LanguageConfiguration.html">LanguageConfiguration</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface LanguageConfiguration</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The language configuration interfaces defines the contract between extensions
|
|
and various editor features, like automatic bracket insertion, automatic indentation etc.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">LanguageConfiguration</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LanguageConfiguration.html#comments" class="tsd-kind-icon">comments</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LanguageConfiguration.html#brackets" class="tsd-kind-icon">brackets</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LanguageConfiguration.html#wordPattern" class="tsd-kind-icon">word<wbr>Pattern</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LanguageConfiguration.html#indentationRules" class="tsd-kind-icon">indentation<wbr>Rules</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LanguageConfiguration.html#onEnterRules" class="tsd-kind-icon">on<wbr>Enter<wbr>Rules</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LanguageConfiguration.html#__electricCharacterSupport" class="tsd-kind-icon">__electric<wbr>Character<wbr>Support</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LanguageConfiguration.html#__characterPairSupport" class="tsd-kind-icon">__character<wbr>Pair<wbr>Support</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="comments" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> comments</h3>
|
|
<div class="tsd-signature tsd-kind-icon">comments<span class="tsd-signature-symbol">:</span> <a href="CommentRule.html" class="tsd-signature-type" data-tsd-kind="Interface">CommentRule</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/ea3c2ef/vscode.d.ts#L4928">vscode.d.ts:4928</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The language's comment settings.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="brackets" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> brackets</h3>
|
|
<div class="tsd-signature tsd-kind-icon">brackets<span class="tsd-signature-symbol">:</span> <a href="../modules.html#CharacterPair" class="tsd-signature-type" data-tsd-kind="Type alias">CharacterPair</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/ea3c2ef/vscode.d.ts#L4933">vscode.d.ts:4933</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The language's brackets.
|
|
This configuration implicitly affects pressing Enter around these brackets.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="wordPattern" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> word<wbr>Pattern</h3>
|
|
<div class="tsd-signature tsd-kind-icon">word<wbr>Pattern<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/ea3c2ef/vscode.d.ts#L4941">vscode.d.ts:4941</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The language's word definition.
|
|
If the language supports Unicode identifiers (e.g. JavaScript), it is preferable
|
|
to provide a word definition that uses exclusion of known separators.
|
|
e.g.: A regex that matches anything except known separators (and dot is allowed to occur in a floating point number):
|
|
/(-?\d<em>.\d\w</em>)|([^`~!@#%^&*()-=+[{]}\|;:'",.<>/?\s]+)/g</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="indentationRules" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> indentation<wbr>Rules</h3>
|
|
<div class="tsd-signature tsd-kind-icon">indentation<wbr>Rules<span class="tsd-signature-symbol">:</span> <a href="IndentationRule.html" class="tsd-signature-type" data-tsd-kind="Interface">IndentationRule</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/ea3c2ef/vscode.d.ts#L4945">vscode.d.ts:4945</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The language's indentation settings.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="onEnterRules" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Enter<wbr>Rules</h3>
|
|
<div class="tsd-signature tsd-kind-icon">on<wbr>Enter<wbr>Rules<span class="tsd-signature-symbol">:</span> <a href="OnEnterRule.html" class="tsd-signature-type" data-tsd-kind="Interface">OnEnterRule</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/ea3c2ef/vscode.d.ts#L4949">vscode.d.ts:4949</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The language's rules to be evaluated when pressing Enter.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="__electricCharacterSupport" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> __electric<wbr>Character<wbr>Support</h3>
|
|
<div class="tsd-signature tsd-kind-icon">__electric<wbr>Character<wbr>Support<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>brackets<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>docComment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>scope<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>lineStart<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>close<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/ea3c2ef/vscode.d.ts#L4956">vscode.d.ts:4956</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><strong>Deprecated</strong> Do not use.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>deprecated</dt>
|
|
<dd><p>Will be replaced by a better API soon.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> brackets<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>This property is deprecated and will be <strong>ignored</strong> from
|
|
the editor.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>deprecated</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> doc<wbr>Comment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>scope<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>lineStart<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>close<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>This property is deprecated and not fully supported anymore by
|
|
the editor (scope and lineStart are ignored).
|
|
Use the autoClosingPairs property in the language configuration file instead.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>deprecated</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</div>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>scope<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>line<wbr>Start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> close<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="__characterPairSupport" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> __character<wbr>Pair<wbr>Support</h3>
|
|
<div class="tsd-signature tsd-kind-icon">__character<wbr>Pair<wbr>Support<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>autoClosingPairs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>notIn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/ea3c2ef/vscode.d.ts#L4982">vscode.d.ts:4982</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><strong>Deprecated</strong> Do not use.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>deprecated</dt>
|
|
<dd><ul>
|
|
<li>Use the autoClosingPairs property in the language configuration file instead.</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>auto<wbr>Closing<wbr>Pairs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>notIn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Exports</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface">
|
|
<a href="LanguageConfiguration.html" class="tsd-kind-icon">Language<wbr>Configuration</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="LanguageConfiguration.html#comments" class="tsd-kind-icon">comments</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="LanguageConfiguration.html#brackets" class="tsd-kind-icon">brackets</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="LanguageConfiguration.html#wordPattern" class="tsd-kind-icon">word<wbr>Pattern</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="LanguageConfiguration.html#indentationRules" class="tsd-kind-icon">indentation<wbr>Rules</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="LanguageConfiguration.html#onEnterRules" class="tsd-kind-icon">on<wbr>Enter<wbr>Rules</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="LanguageConfiguration.html#__electricCharacterSupport" class="tsd-kind-icon">__electric<wbr>Character<wbr>Support</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="LanguageConfiguration.html#__characterPairSupport" class="tsd-kind-icon">__character<wbr>Pair<wbr>Support</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |