@codemirror/language 6.6.0 → 6.7.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 6.7.0 (2023-05-19)
+
+### New features
+
+Export `DocInput` class for feeding editor documents to a Lezer parser.
+
 ## 6.6.0 (2023-02-13)
 
 ### New features

package/dist/index.cjs

@@ -28,7 +28,7 @@ function defineLanguageFacet(baseData) {
     });
 }
 /**
-Syntax node prop used to register sublangauges. Should be added to
+Syntax node prop used to register sublanguages. Should be added to
 the top level node type for the language.
 */
 const sublanguageProp = new common.NodeProp();
@@ -244,8 +244,15 @@ function syntaxParserRunning(view) {
     var _a;
     return ((_a = view.plugin(parseWorker)) === null || _a === void 0 ? void 0 : _a.isWorking()) || false;
 }
-// Lezer-style Input object for a Text document.
+/**
+Lezer-style
+[`Input`](https://lezer.codemirror.net/docs/ref#common.Input)
+object for a [`Text`](https://codemirror.net/6/docs/ref/#state.Text) object.
+*/
 class DocInput {
+    /**
+    Create an input object for the given document.
+    */
     constructor(doc) {
         this.doc = doc;
         this.cursorPos = 0;
@@ -2480,6 +2487,7 @@ function docID(data) {
     return type;
 }
 
+exports.DocInput = DocInput;
 exports.HighlightStyle = HighlightStyle;
 exports.IndentContext = IndentContext;
 exports.LRLanguage = LRLanguage;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { NodeProp, SyntaxNode, Parser, Tree, TreeFragment, NodeType } from '@lezer/common';
+import { NodeProp, SyntaxNode, Parser, Tree, Input, TreeFragment, NodeType } from '@lezer/common';
 import { LRParser, ParserConfig } from '@lezer/lr';
 import * as _codemirror_state from '@codemirror/state';
-import { Facet, EditorState, Extension, StateField, Range } from '@codemirror/state';
+import { Facet, EditorState, Extension, Text, StateField, Range } from '@codemirror/state';
 import { EditorView, DecorationSet, Command, KeyBinding, ViewUpdate, BlockInfo, Decoration } from '@codemirror/view';
 import { Highlighter, Tag } from '@lezer/highlight';
 import { StyleModule, StyleSpec } from 'style-mod';
@@ -64,7 +64,7 @@ interface Sublanguage {
     }>;
 }
 /**
-Syntax node prop used to register sublangauges. Should be added to
+Syntax node prop used to register sublanguages. Should be added to
 the top level node type for the language.
 */
 declare const sublanguageProp: NodeProp<Sublanguage[]>;
@@ -212,6 +212,26 @@ is no language parser enabled.
 */
 declare function syntaxParserRunning(view: EditorView): boolean;
 /**
+Lezer-style
+[`Input`](https://lezer.codemirror.net/docs/ref#common.Input)
+object for a [`Text`](https://codemirror.net/6/docs/ref/#state.Text) object.
+*/
+declare class DocInput implements Input {
+    readonly doc: Text;
+    private cursor;
+    private cursorPos;
+    private string;
+    /**
+    Create an input object for the given document.
+    */
+    constructor(doc: Text);
+    get length(): number;
+    private syncTo;
+    chunk(pos: number): string;
+    get lineChunks(): boolean;
+    read(from: number, to: number): string;
+}
+/**
 A parse context provided to parsers working on the editor content.
 */
 declare class ParseContext {
@@ -664,7 +684,7 @@ declare function foldable(state: EditorState, lineStart: number, lineEnd: number
     from: number;
     to: number;
 } | null;
-declare type DocRange = {
+type DocRange = {
     from: number;
     to: number;
 };
@@ -752,7 +772,7 @@ interface FoldConfig {
 Create an extension that configures code folding.
 */
 declare function codeFolding(config?: FoldConfig): Extension;
-declare type Handlers = {
+type Handlers = {
     [event: string]: (view: EditorView, line: BlockInfo, event: Event) => boolean;
 };
 interface FoldGutterConfig {
@@ -1157,4 +1177,4 @@ declare class StreamLanguage<State> extends Language {
     get allowsNesting(): boolean;
 }
 
-export { Config, HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, MatchResult, ParseContext, StreamLanguage, StreamParser, StringStream, Sublanguage, TagStyle, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, sublanguageProp, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, toggleFold, unfoldAll, unfoldCode, unfoldEffect };
+export { Config, DocInput, HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, MatchResult, ParseContext, StreamLanguage, StreamParser, StringStream, Sublanguage, TagStyle, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, sublanguageProp, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, toggleFold, unfoldAll, unfoldCode, unfoldEffect };

package/dist/index.js

@@ -24,7 +24,7 @@ function defineLanguageFacet(baseData) {
     });
 }
 /**
-Syntax node prop used to register sublangauges. Should be added to
+Syntax node prop used to register sublanguages. Should be added to
 the top level node type for the language.
 */
 const sublanguageProp = /*@__PURE__*/new NodeProp();
@@ -240,8 +240,15 @@ function syntaxParserRunning(view) {
     var _a;
     return ((_a = view.plugin(parseWorker)) === null || _a === void 0 ? void 0 : _a.isWorking()) || false;
 }
-// Lezer-style Input object for a Text document.
+/**
+Lezer-style
+[`Input`](https://lezer.codemirror.net/docs/ref#common.Input)
+object for a [`Text`](https://codemirror.net/6/docs/ref/#state.Text) object.
+*/
 class DocInput {
+    /**
+    Create an input object for the given document.
+    */
     constructor(doc) {
         this.doc = doc;
         this.cursorPos = 0;
@@ -2476,4 +2483,4 @@ function docID(data) {
     return type;
 }
 
-export { HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, StreamLanguage, StringStream, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, sublanguageProp, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, toggleFold, unfoldAll, unfoldCode, unfoldEffect };
+export { DocInput, HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, StreamLanguage, StringStream, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, sublanguageProp, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, toggleFold, unfoldAll, unfoldCode, unfoldEffect };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/language",
-  "version": "6.6.0",
+  "version": "6.7.0",
   "description": "Language support infrastructure for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",