Skip to content

Commit

Permalink
autocomletion and linting
Browse files Browse the repository at this point in the history
  • Loading branch information
forgodtosave committed Jul 10, 2023
1 parent 3f69ab6 commit 8624855
Show file tree
Hide file tree
Showing 51 changed files with 5,523 additions and 119 deletions.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
"start": "vite build && vite preview",
"test": "start-server-and-test preview http://127.0.0.1:4173/ 'cypress run'",
"test:ui": "cypress open",
"test:parser:klipperCfg": "mocha --config src/plugins/Codemirror/.mocharc.json src/plugins/Codemirror/KlipperCfgLang/test/test-klipperCfg.js",
"test:parser:klipperCfg": "mocha --config src/plugins/Codemirror/.mocharc.json src/plugins/Codemirror/KlipperCfgLang/testParser/testKlipperCfgParser.js",
"test:lint:klipperCfg": "mocha --config src/plugins/Codemirror/.mocharc.json src/plugins/Codemirror/KlipperCfgLang/testLint/testKlipperCfgLint.js",
"changelog": "git cliff v0.0.4..$(git describe --tags $(git rev-list --tags --max-count=1)) --output CHANGELOG.md"
},
"dependencies": {
Expand Down
6 changes: 4 additions & 2 deletions src/components/inputs/Codemirror.vue
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import { json } from '@codemirror/lang-json'
import { css } from '@codemirror/lang-css'
import { klipperCfg } from '../../plugins/Codemirror/KlipperCfgLang/lang/klipperCfg'
import { parseErrorLint } from '../../plugins/Codemirror/parseErrorLint'
import { klipperCfgLint } from '../../plugins/Codemirror/KlipperCfgLang/lang/lint'
import { indentUnit } from '@codemirror/language'
// for lezer grammar debugging
Expand Down Expand Up @@ -56,10 +57,10 @@ export default class Codemirror extends Mixins(BaseMixin) {
this.setCmValue(newVal)
}
// for lezer grammar debugging
/* const state = this.cminstance?.state ?? EditorState.create({})
/* const state = this.cminstance?.state ?? EditorState.create({})
logTree(syntaxTree(state), state.doc.toString())
const text = state.doc.toString()
console.log(parser.parse(text) + '') */
console.log(parser.parse(text) + '') */
}
mounted(): void {
Expand Down Expand Up @@ -107,6 +108,7 @@ export default class Codemirror extends Mixins(BaseMixin) {
}),
]
if ("printer.cfg" === this.name) extensions.push(klipperCfgLint)
if (['cfg', 'conf'].includes(this.fileExtension)) extensions.push(klipperCfg())
else if (['gcode'].includes(this.fileExtension)) extensions.push(StreamLanguage.define(gcode))
else if (['json'].includes(this.fileExtension)) extensions.push(json())
Expand Down
184 changes: 184 additions & 0 deletions src/plugins/Codemirror/KlipperCfgLang/lang/complete.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
import { CompletionContext } from '@codemirror/autocomplete'
import { syntaxTree } from '@codemirror/language'
import { EditorState } from '@codemirror/state'
import { SyntaxNode } from '@lezer/common'
import { parseCfgMd } from '../parserCfgMd/parserCfgMd.js'
import { exampleText } from '../parserCfgMd/ref.js'

// Parse Cfg Reference
const [parsedMd, dependentParameters] = parseCfgMd(exampleText)

// Map with all autocompletion objects for each blocktype
const autocompletionMap = new Map<string, { label: string; type: string; info: string }[]>()

// Map with all autocompletion objects for each trigger parameter
const dependentParametersMap = new Map<string, { label: string; type: string; info: string }[]>()

function createParameterObject(parameter: any) {
return {
label: `${parameter.name}: `,
type: 'variable',
detail: parameter.isOptional ? '(optional)' : '(required)',
info: parameter.tooltip,
}
}

// Populate autocompletionMap
parsedMd.forEach((entry) => {
const parameters = entry.parameters.map(createParameterObject)
autocompletionMap.set(entry.type, parameters)
})

// Populate dependentParametersMap
dependentParameters.forEach((entry) => {
const parameters = entry.parameters.map(createParameterObject)
dependentParametersMap.set(entry.triggerParameter, parameters)
})

export function klipperCfgCompletionSource(context: CompletionContext) {
const parent = syntaxTree(context.state).resolveInner(context.pos, -1)
const tagBefore = getTagBefore(context.state, parent.from, context.pos)

if (parent?.type.name === 'Comment') return null

if (parent?.type.name === 'Parameter') {
const typeNode = findTypeNode(parent)
if (!typeNode) return null
const blockType = context.state.sliceDoc(typeNode.from, typeNode.to)
const options = getOptionsByBlockType(blockType, context.state, parent)
if (options == null) return null

return {
from: tagBefore ? parent.from + tagBefore.index : context.pos,
options: options,
validFor: /^(\w*)?$/,
}
}

if (parent?.parent?.type.name === 'CfgBlock') {
return {
from: tagBefore ? parent.from + tagBefore.index : context.pos,
options: getAllPossibleBlockTypes(context.state, parent),
validFor: /^(\w*)?$/,
}
}

return null
}

function getTagBefore(state: EditorState, from: number, pos: number) {
const textBefore = state.sliceDoc(from, pos)
return /\w*$/.exec(textBefore)
}

function findTypeNode(node: SyntaxNode) {
let travNode: SyntaxNode | null = node
while (travNode) {
if (travNode.type.name === 'CfgBlock') {
return travNode.firstChild
}
travNode = travNode.parent
}
return null
}

function findPrinterNode(node: SyntaxNode, state: EditorState) {
const typeNode = findTypeNode(node)
// If node is [printer] return it
if (typeNode && typeNode.type.name === 'printer') {
return typeNode
}
// If not, find Programm node and search for printer node from there
let programmNode
if (typeNode) programmNode = typeNode.parent?.parent ?? null // If node is a typeNode go up to Programm node
else programmNode = node // If typeNode is null, node must be the Programm node or inside inport (here not important)
const printerNode =
programmNode?.getChildren('CfgBlock')?.find((cfgBlockNode) => {
const blockTypeNode = cfgBlockNode.firstChild
if (!blockTypeNode) return false
return state.sliceDoc(blockTypeNode.from, blockTypeNode.to) === 'printer'
}) ?? null
return printerNode
}

function getPrinterKinematics(state: EditorState, node: SyntaxNode) {
const printerOptions = findPrinterNode(node, state)?.getChild('Body')?.getChildren('Option') ?? []
for (const childNode of printerOptions) {
const parameter = childNode.getChild('Parameter')
const value = childNode.getChild('Value')
if (!parameter || !value) continue
const parameterName = state.sliceDoc(parameter.from, parameter.to)
if (parameterName !== 'kinematics') continue
const printerKinematics = state.sliceDoc(value.from, value.to).replace(/(\r\n|\n|\r)/gm, '')
return printerKinematics.split('#')[0].trim()
}
return ''
}

function getOptionsByBlockType(blocktype: string, state: EditorState, parentNode: SyntaxNode) {
let options: { label: string; type: string; info: string }[] = []

Check failure on line 119 in src/plugins/Codemirror/KlipperCfgLang/lang/complete.ts

View workflow job for this annotation

GitHub Actions / ESLint

src/plugins/Codemirror/KlipperCfgLang/lang/complete.ts#L119

'options' is never reassigned. Use 'const' instead (prefer-const)
const printerKinematics = getPrinterKinematics(state, parentNode)
if (blocktype.includes('stepper_')) {
1
const stepperOptions = autocompletionMap.get(blocktype + '--' + printerKinematics)
const secondaryStepperOptions = /\d/.test(blocktype)
? autocompletionMap.get('stepper_z1')
: autocompletionMap.get('stepper_x')
if (stepperOptions) {
options.push(...stepperOptions)
}
if (secondaryStepperOptions) {
options.push(...secondaryStepperOptions)
}
} else {
const optionsForBlockType =
autocompletionMap.get(blocktype) || autocompletionMap.get(blocktype + '--' + printerKinematics)
if (optionsForBlockType) {
options.push(...optionsForBlockType)
}
}
if (blocktype.includes('extruder') && /\d/.test(blocktype)) {
const secondaryExtruderOptions = autocompletionMap.get('extruder1')
if (secondaryExtruderOptions) {
options.push(...secondaryExtruderOptions)
}
}
return editOptions(options, state, parentNode)
}

function editOptions(options: { label: string; type: string; info: string }[], state: EditorState, node: SyntaxNode) {
const allreadyUsedOptions = new Set<string>()
// for all options in the current cfg block check if it is a trigger parameters and add dependent parameters if necessary
for (const childNode of node.parent?.parent?.getChildren('Option') ?? []) {
const parameter = childNode.firstChild
const value = childNode.lastChild
if (!parameter || !value) continue
const parameterName = state.sliceDoc(parameter.from, parameter.to).trim()
if (!parameterName.endsWith('_')) allreadyUsedOptions.add(parameterName) // save allready used options to remove them later (not "variable_")
const valueName = state.sliceDoc(value.from, value.to).replace(/(\r\n|\n|\r)/gm, '')
const parameterValue = parameterName + ':' + valueName
const mapEntry = dependentParametersMap.get(parameterValue)
if (mapEntry) {
options = options.concat(mapEntry)
}
}
// remove all options that are already used in the current cfg block
return (options = options.filter((option) => !allreadyUsedOptions.has(option.label.replace(': ', ''))))
}

function getAllPossibleBlockTypes(state: EditorState, node: SyntaxNode) {
const printerKinematics = getPrinterKinematics(state, node)
let blockTypes = Array.from(autocompletionMap.keys())
if (printerKinematics !== '') {
// all blockTypes but if stepper_ only these which match the printerKinematics
blockTypes = blockTypes.filter(
(blockType) => !blockType.includes('stepper_') || blockType.includes('--' + printerKinematics)
)
}
return blockTypes.map((blockType) => ({
label: blockType.includes('--') ? blockType.split('-')[0] : blockType,
type: 'keyword',
}))
}

//Known Issues: secondary stepper/extruder-names are not suggested (only stepper_z1/extruder1)
6 changes: 5 additions & 1 deletion src/plugins/Codemirror/KlipperCfgLang/lang/klipperCfg.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import { parser } from '../dist/klipperCfgParser.es.js'
import { LRLanguage, LanguageSupport, StreamLanguage, foldNodeProp } from '@codemirror/language'
import { parseMixed } from '@lezer/common'
import { klipper_config } from '../../../StreamParserKlipperConfig.js'
import { klipperCfgCompletionSource } from './complete.js'


const jinja2Parser = StreamLanguage.define(klipper_config).parser

Expand Down Expand Up @@ -32,7 +34,9 @@ export const klipperCfgLang = LRLanguage.define({
})

export function klipperCfg() {
return new LanguageSupport(klipperCfgLang)
return new LanguageSupport(klipperCfgLang, [
klipperCfgLang.data.of({ autocomplete: klipperCfgCompletionSource }),
])
}

/*
Expand Down
Loading

0 comments on commit 8624855

Please sign in to comment.