Skip to content

differentiation for description: blocks, adding missed filters and jinja macros #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Contomo wants to merge 2 commits into
base: main
Choose a base branch
from
Open

differentiation for description: blocks, adding missed filters and jinja macros #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8830266
Add support/differentiation for 'description' property block in klipp…
Contomo May 13, 2026
1ab5f6b
various changes to support more complex types/blocks in gcode macros …
Contomo May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions packages/klipper-cfg/src/lib/repository/identifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,33 @@ export const identifier: TMGrammarScope = {
{ include: "source.klipper-gcode" },
],
},
{
name: "meta.property-block.description.klipper-cfg",
begin: /^(description)(:)/,
beginCaptures: {
1: { name: "variable.property.klipper-cfg" },
2: { name: "punctuation.separator.key-value.klipper-cfg" },
},
end: /(?=^\S)/,
contentName: "string.unquoted.description.klipper-cfg",
patterns: [
{ include: "#comment" },
],
},
{
name: "meta.property-block.variable.klipper-cfg",
begin: regex`/^(variable_${IDENT})(:)/`,
beginCaptures: {
1: { name: "variable.property.klipper-cfg" },
2: { name: "punctuation.separator.key-value.klipper-cfg" },
},
end: /(?=^\S)/,
patterns: [
{ include: "#comment" },
{ include: "#literal" },
{ include: "#punctuation" },
],
},
{
name: "meta.property-block.entry.klipper-cfg",
begin: regex`/^(${IDENT})(:)/`,
Expand Down
7 changes: 3 additions & 4 deletions packages/klipper-cfg/src/lib/repository/literals.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import { regex, TMGrammarScope } from "@vscode-devkit/grammar";
import { IDENT } from "../common";
import { TMGrammarScope } from "@vscode-devkit/grammar";

export const boolLiteral: TMGrammarScope = {
name: "constant.language.boolean.klipper-cfg",
match: /\b[Tt]rue|[Ff]alse\b/,
match: /\b(?:[Tt]rue|[Ff]alse)\b/,
};

export const nullLiteral: TMGrammarScope = {
Expand Down Expand Up @@ -39,7 +38,7 @@ export const stringLiteral: TMGrammarScope = {
},
{
name: "string.path.klipper-cfg",
match: regex`/(\/${IDENT})+/`,
match: /\/[^\s#;]+/,
}
],
};
Expand Down
27 changes: 23 additions & 4 deletions packages/klipper-cfg/src/lib/repository/template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,32 @@ import { TMGrammarScope } from "@vscode-devkit/grammar";

export const template: TMGrammarScope = {
patterns: [
{
name: "meta.jinja2.block-set.klipper-cfg",
begin: /(\{%-?)(\s*)(set)\b((?:(?!-?%\}|=).)*)(-?%\})/,
beginCaptures: {
1: { name: "punctuation.definition.template-expression.begin.klipper-cfg" },
3: { name: "storage.type.set.klipper-script" },
5: { name: "punctuation.definition.template-expression.end.klipper-cfg" },
},
end: /(\{%-?)(\s*)(endset)\b(\s*)(-?%\})/,
endCaptures: {
1: { name: "punctuation.definition.template-expression.begin.klipper-cfg" },
3: { name: "storage.type.endset.klipper-script" },
5: { name: "punctuation.definition.template-expression.end.klipper-cfg" },
},
contentName: "string.unquoted.block-set.klipper-cfg",
patterns: [
{ include: "#template" },
],
},
{
name: "meta.jinja2.conditional.klipper-cfg",
begin: /\{%/,
begin: /\{%-?/,
beginCaptures: {
0: { name: "punctuation.definition.template-expression.begin.klipper-cfg" },
},
end: /%\}/,
end: /-?%\}/,
endCaptures: {
0: { name: "punctuation.definition.template-expression.end.klipper-cfg" },
},
Expand All @@ -19,11 +38,11 @@ export const template: TMGrammarScope = {
},
{
name: "meta.jinja2.expression.klipper-cfg",
begin: /\{/,
begin: /\{-?/,
beginCaptures: {
0: { name: "punctuation.definition.template-expression.begin.klipper-cfg" },
},
end: /\}/,
end: /-?\}/,
endCaptures: {
0: { name: "punctuation.definition.template-expression.end.klipper-cfg" },
},
Expand Down
27 changes: 23 additions & 4 deletions packages/klipper-gcode/src/lib/repository/template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,32 @@ import { TMGrammarScope } from "@vscode-devkit/grammar";

export const template: TMGrammarScope = {
patterns: [
{
name: "meta.jinja2.block-set.klipper-gcode",
begin: /(\{%-?)(\s*)(set)\b((?:(?!-?%\}|=).)*)(-?%\})/,
beginCaptures: {
1: { name: "punctuation.definition.template-expression.begin.klipper-gcode" },
3: { name: "storage.type.set.klipper-script" },
5: { name: "punctuation.definition.template-expression.end.klipper-gcode" },
},
end: /(\{%-?)(\s*)(endset)\b(\s*)(-?%\})/,
endCaptures: {
1: { name: "punctuation.definition.template-expression.begin.klipper-gcode" },
3: { name: "storage.type.endset.klipper-script" },
5: { name: "punctuation.definition.template-expression.end.klipper-gcode" },
},
contentName: "string.unquoted.block-set.klipper-gcode",
patterns: [
{ include: "#template" },
],
},
{
name: "meta.jinja2.conditional.klipper-gcode",
begin: /\{%/,
begin: /\{%-?/,
beginCaptures: {
0: { name: "punctuation.definition.template-expression.begin.klipper-gcode" },
},
end: /%\}/,
end: /-?%\}/,
endCaptures: {
0: { name: "punctuation.definition.template-expression.end.klipper-gcode" },
},
Expand All @@ -19,11 +38,11 @@ export const template: TMGrammarScope = {
},
{
name: "meta.jinja2.expression.klipper-gcode",
begin: /\{/,
begin: /\{-?/,
beginCaptures: {
0: { name: "punctuation.definition.template-expression.begin.klipper-gcode" },
},
end: /\}/,
end: /-?\}/,
endCaptures: {
0: { name: "punctuation.definition.template-expression.end.klipper-gcode" },
},
Expand Down
4 changes: 0 additions & 4 deletions packages/klipper-script/src/lib/repository/identifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ import { IDENT } from "../common";

export const identifier: TMGrammarScope = {
patterns: [
{
name: "entity.name.function.filter.klipper-script",
match: /\b(abs|attr|batch|capitalize|center|default|dictsort|escape|filesizeformat|first|float|forceescape|format|groupby|indent|int|join|last|length|list|lower|map|max|min|pprint|random|reject|rejectattr|replace|reverse|round|safe|select|selectattr|slice|sort|string|striptags|sum|title|tojson|truncate|unique|upper|urlencode|urlize|wordcount|wordwrap|xmlattr)\b/,
},
{
match: regex`/\b(${IDENT})\s*(?=\()/`,
captures: {
Expand Down
51 changes: 49 additions & 2 deletions packages/klipper-script/src/lib/repository/keyword.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
import { TMGrammarScope } from "@vscode-devkit/grammar";
const JINJA_TESTS =
"boolean|callable|defined|divisibleby|escaped|even|false|filter|float|ge|greaterthan|gt|in|integer|iterable|le|lessthan|lower|lt|mapping|ne|none|number|odd|sameas|sequence|string|test|true|undefined|upper|eq|equalto";

const JINJA_SYMBOL_TESTS = "==|!=|>=|<=|>|<";

export const keyword: TMGrammarScope = {
patterns: [
{
name: "keyword.control.definition.$1.klipper-script",
match: /\b(macro|endmacro)\b/,
},
{
name: "keyword.control.iteration.$1.klipper-script",
match: /\b(for|in|endfor)\b/,
Expand All @@ -10,13 +18,45 @@ export const keyword: TMGrammarScope = {
name: "keyword.control.condition.$1.klipper-script",
match: /\b(if|elif|else|endif)\b/,
},
{
match: /\b(is)\s+(?:(not)\s+)?([Nn]one)\b/,
captures: {
1: { name: "keyword.operator.wordlike.logical.is.klipper-script" },
2: { name: "keyword.operator.wordlike.logical.not.klipper-script" },
3: { name: "constant.language.null.klipper-script" },
},
},
{
match: /\b(is)\s+(?:(not)\s+)?([Tt]rue|[Ff]alse)\b/,
captures: {
1: { name: "keyword.operator.wordlike.logical.is.klipper-script" },
2: { name: "keyword.operator.wordlike.logical.not.klipper-script" },
3: { name: "constant.language.boolean.klipper-script" },
},
},
{
match: new RegExp(`\\b(is)\\s+(?:(not)\\s+)?(${JINJA_TESTS})\\b`),
captures: {
1: { name: "keyword.operator.wordlike.logical.is.klipper-script" },
2: { name: "keyword.operator.wordlike.logical.not.klipper-script" },
3: { name: "entity.name.function.test.klipper-script" },
},
},
{
match: new RegExp(`\\b(is)\\s+(?:(not)\\s+)?(${JINJA_SYMBOL_TESTS})`),
captures: {
1: { name: "keyword.operator.wordlike.logical.is.klipper-script" },
2: { name: "keyword.operator.wordlike.logical.not.klipper-script" },
3: { name: "entity.name.function.test.klipper-script" },
},
},
{
name: "keyword.operator.wordlike.logical.$1.klipper-script",
match: /\b(and|or|not|is)\b/
match: /\b(and|or|not|is)\b/,
},
{
name: "storage.type.$1.klipper-script",
match: /\b(set)\b/,
match: /\b(set|endset)\b/,
},
],
};
Expand All @@ -35,6 +75,13 @@ export const operator: TMGrammarScope = {
name: "keyword.operator.concatenation.klipper-script",
match: /~/,
},
{
match: /(\|)\s*(abs|attr|batch|capitalize|center|default|dictsort|escape|filesizeformat|first|float|forceescape|format|groupby|indent|int|join|last|length|list|lower|map|max|min|pprint|random|reject|rejectattr|replace|reverse|round|safe|select|selectattr|slice|sort|string|striptags|sum|title|tojson|truncate|unique|upper|urlencode|urlize|wordcount|wordwrap|xmlattr|count|d|e|items|trim)\b/,
captures: {
1: { name: "keyword.operator.pipe.klipper-script" },
2: { name: "entity.name.function.filter.klipper-script" },
},
},
{
name: "keyword.operator.pipe.klipper-script",
match: /\|/,
Expand Down
2 changes: 1 addition & 1 deletion packages/klipper-script/src/lib/repository/literals.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { TMGrammarScope } from "@vscode-devkit/grammar";

export const boolLiteral: TMGrammarScope = {
name: "constant.language.boolean.klipper-script",
match: /\b[Tt]rue|[Ff]alse\b/,
match: /\b(?:[Tt]rue|[Ff]alse)\b/,
};

export const nullLiteral: TMGrammarScope = {
Expand Down