Skip to content

“syntaxes: support [[SOME_COMPOSITE_NODE]], deprecate SECTION” #25

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

Merged
mettta merged 7 commits into from
Jun 14, 2025
Merged

“syntaxes: support [[SOME_COMPOSITE_NODE]], deprecate SECTION” #25

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0424754
syntaxes: adds support for `PREFIX`; makes `REQ_PREFIX` deprecated.
mettta Jun 12, 2025
071ccd6
syntaxes: adds support for `VIEW_STYLE`; makes `REQUIREMENT_STYLE` de…
mettta Jun 12, 2025
e9b01c4
syntaxes: adds support for `NODE_IN_TOC`; makes `REQUIREMENT_IN_TOC` …
mettta Jun 12, 2025
d5cf65f
syntaxes: updates UID match pattern to match symbols like (), /, :, a…
mettta Jun 12, 2025
4541e67
syntaxes: prevent partial 'METADATA' from ending OPTIONS block
mettta Jun 13, 2025
0841e0c
syntaxes: remove deprecated FREETEXT
mettta Jun 13, 2025
2bb34bf
syntaxes: add support for composite nodes with double brackets; make …
mettta Jun 13, 2025
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
162 changes: 126 additions & 36 deletions syntaxes/sdoc.tmLanguage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@
"include": "#node"
},
{
"include": "#freetext"
"include": "#forbidden_composite_tags"
},
{
"include": "#composite_node"
},
{
"include": "#document_from_file"
Expand Down Expand Up @@ -54,6 +57,9 @@
{
"include": "#field_req_prefix"
},
{
"include": "#field_prefix"
},
{
"include": "#document_root"
},
Expand Down Expand Up @@ -91,7 +97,7 @@
"patterns": [{
"begin": "^OPTIONS:$",
"name": "",
"end": "^(?=METADATA:|$)",
"end": "^(?=METADATA:$|$)",
"beginCaptures": {
"0": { "name": "keyword.control.sdoc" }
},
Expand All @@ -106,7 +112,13 @@
"include": "#document_options_auto_levels"
},
{
"include": "#document_options_node_style"
"include": "#document_options_requirement_style_deprecated"
},
{
"include": "#document_options_view_style"
},
{
"include": "#document_options_requirement_in_toc_deprecated"
},
{
"include": "#document_options_node_in_toc"
Expand Down Expand Up @@ -139,20 +151,33 @@
}
}]
},
"document_options_node_style": {
"document_options_requirement_style_deprecated": {
"comment": "Deprecated field: use VIEW_STYLE instead.",
"patterns": [{
"name": "",
"match": "(^\\s\\sREQUIREMENT_STYLE:)\\s\\b(Inline|Simple|Table|Zebra|Narrative)\\b$",
"captures": {
"1": { "name": "invalid.deprecated.sdoc" },
"2": { "name": "constant.numeric.sdoc" }
}
}]
},
"document_options_view_style": {
"comment": "Defines node view style",
"patterns": [{
"name": "",
"match": "(^\\s\\sVIEW_STYLE:)\\s\\b(Inline|Simple|Table|Zebra|Narrative)\\b$",
"captures": {
"1": { "name": "keyword.control.sdoc" },
"2": { "name": "constant.numeric.sdoc" }
}
}]
},
"document_options_node_in_toc": {
"comment": "Defines whether node appears in TOC.",
"patterns": [{
"name": "",
"begin": "(^\\s\\sREQUIREMENT_IN_TOC:)",
"begin": "(^\\s\\sNODE_IN_TOC:)",
"end": "$",
"beginCaptures": {
"0": { "name": "keyword.control.sdoc" }
Expand All @@ -164,6 +189,22 @@
]
}]
},
"document_options_requirement_in_toc_deprecated": {
"comment": "Deprecated field: use NODE_IN_TOC instead.",
"patterns": [{
"name": "",
"begin": "(^\\s\\sREQUIREMENT_IN_TOC:)",
"end": "$",
"beginCaptures": {
"0": { "name": "invalid.deprecated.sdoc" }
},
"patterns": [
{
"include": "#choice_boolean"
}
]
}]
},
"document_options_auto_levels": {
"patterns": [{
"name": "",
Expand All @@ -180,7 +221,7 @@
}]
},
"document_metadata": {
"patterns": [
"patterns": [
{
"match": "^METADATA:\\s*$",
"name": "keyword.control.sdoc"
Expand Down Expand Up @@ -233,7 +274,7 @@
"document_field_name_pattern": {
"patterns": [{
"name": "invalid.sdoc",
"match": "^\\b(MID|UID|TITLE|VERSION|DATE|CLASSIFICATION|REQ_PREFIX|ROOT|OPTIONS|METADATA)\\b:"
"match": "^\\b(MID|UID|TITLE|VERSION|DATE|CLASSIFICATION|PREFIX|REQ_PREFIX|ROOT|OPTIONS|METADATA)\\b:"
}]
},
"document_from_file": {
Expand Down Expand Up @@ -296,7 +337,7 @@
"grammar_element": {
"patterns": [
{
"begin": "^(-\\sTAG:)\\s\\b([A-Z0-9_]+)\\b$",
"begin": "^(-\\sTAG:)\\s\\b([A-Z]+(_[A-Z]+)*)\\b$",
"name": "",
"end": "$",
"beginCaptures": {
Expand Down Expand Up @@ -429,6 +470,7 @@
}]
},
"section": {
"comment": "SECTION tag is deprecated: planned for removal by the end of 2025",
"begin": "^\\[SECTION\\]$",
"end": "^$",
"patterns": [
Expand All @@ -447,50 +489,69 @@
{
"include": "#field_req_prefix"
},
{
"include": "#field_prefix"
},
{
"include": "#section_field_names_without_values"
}
],
"captures": {
"0": {
"name": "keyword.sdoc"
"name": "invalid.deprecated.sdoc"
}
}
},
"section_field_names_without_values": {
"comment": "SECTION tag is deprecated: planned for removal by the end of 2025",
"patterns": [
{
"comment": "reserved section fields",
"match": "^(MID|UID|LEVEL|TITLE|REQ_PREFIX):\\s",
"match": "^(MID|UID|LEVEL|TITLE|PREFIX|REQ_PREFIX):\\s",
"name": "keyword.control.sdoc"
}
]
},
"freetext": {
"begin": "^\\[FREETEXT\\]$",
"end": "^\\[\\/FREETEXT\\]$",
"contentName": "source.rst",
"node": {
"comment": "Node: use the tag pattern and exclude reserved tags; SECTION tag is deprecated",
"begin": "^\\[(?!DOCUMENT|GRAMMAR|DOCUMENT_FROM_FILE|SECTION)([A-Z]+(_[A-Z]+)*)\\]$",
"end": "^$",
"captures": { "0": { "name": "keyword.sdoc" } },
"patterns": [
{
"comment": "FIXME: See 'The problem of leaking incorrect RST markup'.",
"include": "source.rst"
}
],
"captures": {
"0": {
"name": "keyword.sdoc"
"include": "#field_mid"
},
{
"include": "#field_uid"
},
{
"include": "#field_title"
},
{
"include": "#field_level_with_skipping"
},
{
"include": "#field_prefix"
},
{
"include": "#node_relations"
},
{
"include": "#node_field_refs_deprecated"
},
{
"include": "#node_field_general_except_specific"
},
{
"include": "#node_field_names_without_values"
}
}
]
},
"node": {
"comment": "REQUIREMENT/COMPOSITE_REQUIREMENT or similar elements: use the tag pattern and exclude reserved tags",
"begin": "^\\[(?!DOCUMENT|GRAMMAR|SECTION|FREETEXT|DOCUMENT_FROM_FILE)([A-Z0-9_]+)\\]$",
"composite_node": {
"comment": "Composite Node: use the tag pattern and exclude reserved tags; SECTION tag is deprecated",
"begin": "^\\[\\[(?!(DOCUMENT|GRAMMAR|DOCUMENT_FROM_FILE|SECTION)\\]\\])([A-Z]+(?:_[A-Z]+)*)\\]\\]$",
"end": "^$",
"captures": {
"0": {
"name": "keyword.sdoc"
}
},
"captures": { "0": { "name": "keyword.sdoc" } },
"patterns": [
{
"include": "#field_mid"
Expand All @@ -504,6 +565,9 @@
{
"include": "#field_level_with_skipping"
},
{
"include": "#field_prefix"
},
{
"include": "#node_relations"
},
Expand All @@ -518,19 +582,32 @@
}
]
},
"forbidden_composite_tags": {
"comment": "Catch forbidden composite node tags and highlight them as invalid",
"match": "^\\[\\[(DOCUMENT|GRAMMAR|DOCUMENT_FROM_FILE)\\]\\]$",
"name": "invalid.illegal.sdoc"
},
"closing_tag": {
"patterns": [
{
"comment": "SECTION tag is deprecated: planned for removal by the end of 2025",
"name": "invalid.deprecated.sdoc",
"match": "^\\[\\/?(SECTION)\\]$"
},
{
"comment": "Invalid closing tags for forbidden blocks",
"name": "invalid.illegal.sdoc",
"match": "\\[\\/(REQUIREMENT|GRAMMAR|DOCUMENT)\\]"
"match": "^\\[\\[\\/(DOCUMENT|GRAMMAR|DOCUMENT_FROM_FILE)\\]\\]$"
},
{
"comment": "Only composite nodes with double brackets have a valid closing tag",
"name": "keyword.sdoc",
"match": "^\\[\\/?SECTION\\]$"
"match": "^\\[\\[\\/(?!(DOCUMENT|GRAMMAR|DOCUMENT_FROM_FILE)\\]\\])([A-Z]+(_[A-Z]+)*)\\]\\]$"
},
{
"name": "keyword.sdoc",
"match": "^\\[\\/?COMPOSITE_REQUIREMENT\\]$"
"comment": "Only composite nodes with double brackets have a valid closing tag",
"name": "invalid.illegal.sdoc",
"match": "^\\[\\/(.*)\\]$"
}
]
},
Expand All @@ -550,7 +627,7 @@
"patterns": [
{
"name": "keyword.control.sdoc",
"match": "(^UID:)\\s\\b(\\S+)\\b$",
"match": "(^UID:)\\s([\\w]+[\\w()\\-\\/\\.: ]*)$",
"captures": {
"1": { "name": "keyword.control.sdoc" },
"2": { "name": "string.unquoted.sdoc" }
Expand Down Expand Up @@ -585,11 +662,24 @@
]
},
"field_req_prefix": {
"comment": "for document and section",
"comment": "Deprecated (legacy support): replaced by PREFIX in [DOCUMENT] and [SECTION].",
"patterns": [
{
"name": "keyword.control.sdoc",
"match": "^\\b(REQ_PREFIX)\\b:\\s(\\S+)$",
"captures": {
"1": { "name": "invalid.deprecated.sdoc" },
"2": { "name": "string.sdoc" }
}
}
]
},
"field_prefix": {
"comment": "Defines prefix for UID generation in [DOCUMENT] and [SECTION] blocks.",
"patterns": [
{
"name": "keyword.control.sdoc",
"match": "^\\b(PREFIX)\\b:\\s(\\S+)$",
"captures": {
"1": { "name": "keyword.control.sdoc" },
"2": { "name": "string.sdoc" }
Expand Down