@codemirror/legacy-modes

[ WEBSITE | ISSUES | FORUM | CHANGELOG ]

This package implements a collection of ported stream language modes for the CodeMirror code editor. Each mode is available as a separate script file, under "@codemirror/legacy-modes/mode/[name]", and exports the values listed below.

The project page has more information, a number of examples and the documentation.

This code is released under an MIT license.

We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.

Example

Using modes from this package works like this:

Install this package and the @codemirror/language package.
Find the StreamParser instance you need in the reference below.
Add StreamLanguage.define(theParser) to your editor's configuration.

For example, to load the Lua mode, you'd do something like...

import {StreamLanguage} from "@codemirror/language"
import {lua} from "@codemirror/legacy-modes/mode/lua"

import {EditorView, basicSetup} from "codemirror"

let view = new EditorView({
  extensions: [basicSetup, StreamLanguage.define(lua)]
})

API Reference

mode/apl

apl: StreamParser<unknown>

mode/asciiarmor

asciiArmor: StreamParser<unknown>

mode/asn1

asn1(conf: {keywords⁠?: Object<any>, cmipVerbs⁠?: Object<any>, compareTypes⁠?: Object<any>, status⁠?: Object<any>, tags⁠?: Object<any>, storage⁠?: Object<any>, modifier⁠?: Object<any>, accessTypes⁠?: Object<any>, multiLineStrings⁠?: boolean}) → StreamParser<unknown>

mode/asterisk

asterisk: StreamParser<unknown>

mode/brainfuck

brainfuck: StreamParser<unknown>

mode/clike

clike(conf: {name: string, statementIndentUnit⁠?: number, dontAlignCalls⁠?: boolean, keywords⁠?: Object<any>, types⁠?: Object<any>, builtin⁠?: Object<any>, blockKeywords⁠?: Object<any>, atoms⁠?: Object<any>, hooks⁠?: Object<any>, multiLineStrings⁠?: boolean, indentStatements⁠?: boolean, indentSwitch⁠?: boolean, namespaceSeparator⁠?: string, isPunctuationChar⁠?: RegExp, numberStart⁠?: RegExp, number⁠?: RegExp, isOperatorChar⁠?: RegExp, isIdentifierChar⁠?: RegExp, isReservedIdentifier⁠?: fn(id: string) → boolean}) → StreamParser<unknown>
c: StreamParser<unknown>
cpp: StreamParser<unknown>
java: StreamParser<unknown>
csharp: StreamParser<unknown>
scala: StreamParser<unknown>
kotlin: StreamParser<unknown>
shader: StreamParser<unknown>
nesC: StreamParser<unknown>
objectiveC: StreamParser<unknown>
objectiveCpp: StreamParser<unknown>
squirrel: StreamParser<unknown>
ceylon: StreamParser<unknown>
dart: StreamParser<unknown>

mode/simple-mode

interface Rule

regex⁠?: string | RegExp | undefined
token⁠?: string | string[] | fn(matches: RegExpMatchArray) → string | string[] | null | null | undefined
sol⁠?: boolean
next⁠?: string
push⁠?: string
pop⁠?: boolean
indent⁠?: boolean
dedent⁠?: boolean
dedentIfLineStart⁠?: boolean

simpleMode<K extends string>(states: {[P in K]: P extends "languageData" ? Object<any> : Rule[]} & {start: Rule[]}) → StreamParser<unknown>

mode/smalltalk

smalltalk: StreamParser<unknown>

mode/solr

solr: StreamParser<unknown>

mode/sparql

sparql: StreamParser<unknown>

mode/spreadsheet

spreadsheet: StreamParser<unknown>

mode/sql

sql(conf: {client⁠?: Object<any>, atoms⁠?: Object<any>, builtin⁠?: Object<any>, keywords⁠?: Object<any>, operatorChars⁠?: RegExp, support⁠?: Object<any>, hooks⁠?: Object<any>, dateSQL⁠?: Object<any>, backslashStringEscapes⁠?: boolean, brackets⁠?: RegExp, punctuation⁠?: RegExp}) → StreamParser<unknown>
standardSQL: StreamParser<unknown>
msSQL: StreamParser<unknown>
mySQL: StreamParser<unknown>
mariaDB: StreamParser<unknown>
sqlite: StreamParser<unknown>
cassandra: StreamParser<unknown>
plSQL: StreamParser<unknown>
hive: StreamParser<unknown>
pgSQL: StreamParser<unknown>
gql: StreamParser<unknown>
gpSQL: StreamParser<unknown>
sparkSQL: StreamParser<unknown>
esper: StreamParser<unknown>

mode/stex

stex: StreamParser<unknown>
stexMath: StreamParser<unknown>

mode/stylus

stylus: StreamParser<unknown>

mode/swift

swift: StreamParser<unknown>

mode/tcl

tcl: StreamParser<unknown>

mode/textile

textile: StreamParser<unknown>

mode/tiddlywiki

tiddlyWiki: StreamParser<unknown>

mode/tiki

tiki: StreamParser<unknown>

mode/toml

toml: StreamParser<unknown>

mode/troff

troff: StreamParser<unknown>

mode/ttcn-cfg

ttcnCfg: StreamParser<unknown>

mode/ttcn

ttcn: StreamParser<unknown>

mode/turtle

turtle: StreamParser<unknown>

mode/vb

vb: StreamParser<unknown>

mode/vbscript

vbScript: StreamParser<unknown>
vbScriptASP: StreamParser<unknown>

mode/velocity

velocity: StreamParser<unknown>

mode/verilog

verilog: StreamParser<unknown>
tlv: StreamParser<unknown>

mode/vhdl

vhdl: StreamParser<unknown>

mode/wast

wast: StreamParser<unknown>

mode/webidl

webIDL: StreamParser<unknown>

mode/xml

xml: StreamParser<unknown>
html: StreamParser<unknown>

mode/xquery

xQuery: StreamParser<unknown>

mode/yacas

yacas: StreamParser<unknown>

mode/yaml

yaml: StreamParser<unknown>

mode/z80

z80: StreamParser<unknown>
ez80: StreamParser<unknown>

Name		Name	Last commit message	Last commit date
Latest commit History 145 Commits
.github/workflows		.github/workflows
mode		mode
.gitignore		.gitignore
.npmignore		.npmignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
package.json		package.json
rollup.config.js		rollup.config.js

License

codemirror/legacy-modes

Folders and files

Latest commit

History

Repository files navigation

@codemirror/legacy-modes

Example

API Reference

mode/apl

mode/asciiarmor

mode/asn1

mode/asterisk

mode/brainfuck

mode/clike

mode/clojure

mode/cmake

mode/cobol

mode/coffeescript

mode/commonlisp

mode/crystal

mode/css

mode/cypher

mode/d

mode/diff

mode/dockerfile

mode/dtd

mode/dylan

mode/ebnf

mode/ecl

mode/eiffel

mode/elm

mode/erlang

mode/factor

mode/fcl

mode/forth

mode/fortran

mode/gas

mode/gherkin

mode/go

mode/groovy

mode/haskell

mode/haxe

mode/http

mode/idl

mode/javascript

mode/jinja2

mode/julia

mode/livescript

mode/lua

mode/mathematica

mode/mbox

mode/mirc

mode/mllike

mode/modelica

mode/mscgen

mode/mumps

mode/nginx

mode/nsis

mode/ntriples

mode/octave

mode/oz

mode/pascal

mode/pegjs

mode/perl

mode/pig

mode/powershell

mode/properties

mode/protobuf

mode/pug

mode/puppet

mode/python

mode/q

mode/r

mode/rpm

mode/ruby

mode/rust

mode/sas

mode/sass

mode/scheme

`interface` Rule

Packages