Update style for complex types

Author: michaelblyons

src/build.py

@@ -4,35 +4,94 @@
 import json
 import re
 import yaml
-from yaml.representer import SafeRepresenter
 
-CompletionItem: dict[str, str | list[str]]
-CompletionMetadata: dict[str, str | list[str]]
-CompletionSet: dict[str, CompletionItem | CompletionMetadata]
-CryptoSet: dict[str, str | list[str]]
+from typing import Callable, Literal, NotRequired, TypedDict
+from yaml.representer import SafeRepresenter
 
 SYNTAX_STEM = 'Packages/SSH Config/syntax/'
 TEST_STEM = '../test/generated/syntax_test_'
 SUPPORT_STEM = '../support/generated/'
 
 
+class CompletionMetadata(TypedDict):
+    scope: str
+    kind: list[str]
+    annotation: str
+
+
+class CompletionItem(TypedDict):
+    kind: list[str] | Literal['snippet']
+    annotation: str
+    trigger: str
+    contents: str
+    details: NotRequired[str]
+
+
+class CompletionFillins(TypedDict):
+    details: str
+    values: str | list[str]
+
+
+class CompletionSet(TypedDict):
+    completions: CompletionMetadata
+    items: dict[str,CompletionFillins]
+
+
+class CompletionYaml(TypedDict):
+    scope: str
+    completions: list[CompletionItem]
+
+
+class CryptoFillins(TypedDict):
+    scope: str
+    items: list[str]
+
+
+class CryptoSet(TypedDict):
+    completions: CompletionMetadata
+    active: CryptoFillins
+    deprecated: CryptoFillins
+
+
+class SyntaxContext(TypedDict):
+    include: NotRequired[str]
+    match: NotRequired[str]
+    scope: NotRequired[str]
+    captures: NotRequired[dict[int,str]]
+    pop: NotRequired[bool | int]
+    push: NotRequired[str | list[str] | list[SyntaxContext]]
+
+
+class SyntaxYaml(TypedDict):
+    scope: str
+    name: NotRequired[str]
+    hidden: NotRequired[bool]
+    file_extensions: NotRequired[list[str]]
+    hidden_file_extensions: NotRequired[list[str]]
+    extends: NotRequired[str | list[str]]
+    version: NotRequired[int]
+    variables: NotRequired[dict[str, str]]
+    contexts: dict[str, list[SyntaxContext]]
+
+
 def build_ssh_options():
     with open('options.yaml', 'r') as stream:
-        ssh_options_input: dict[str, CompletionSet] = yaml.load(
+        ssh_options_input: dict[str, CompletionSet] = yaml.load(  # pyright: ignore[reportAssignmentType]
             stream, Loader=yaml.BaseLoader)
 
     for domain, settings in ssh_options_input.items():
-        completions = {
+        completions_yaml: CompletionYaml = {
             'scope': settings['completions']['scope'],
             'completions': [],
         }
+        completions: list[CompletionItem] = []
         snippet_spacer: str = settings['completions'].get('snippet_spacer', ' ')
         default_kind: list[str] = settings['completions']['kind']
         annotation: str = settings['completions']['annotation']
 
         for keyword, options in settings['items'].items():
             details: str = options.get('details', '') if options else ''
-            _ = completions['completions'].append({
+            _ = completions.append({
                 'trigger': keyword,
                 'contents': keyword,
                 'annotation': annotation,
@@ -47,21 +106,23 @@ def build_ssh_options():
                 value_string = values
             else:
                 value_string = f'${{0:{{ {" | ".join(values)} \\}}}}'
-            _ = completions['completions'].append({
+            _ = completions.append({
                 'trigger': keyword.lower(),
                 'contents': f'{keyword}{snippet_spacer}{value_string}',
                 'annotation': annotation,
                 'kind': 'snippet',
                 'details': details,
             })
 
+        completions_yaml['completions'] = completions
+
         with open(f'{SUPPORT_STEM}{domain}.sublime-completions', 'w') as f:
-            json.dump(completions, f, indent=4)
+            json.dump(completions_yaml, f, indent=4)
 
 
 def build_sshd_index_test():
     with open('options.yaml', 'r') as stream:
-        ssh_options_input: dict[str, CompletionSet] = yaml.load(
+        ssh_options_input: dict[str, CompletionSet] = yaml.load(  # pyright: ignore[reportAssignmentType]
             stream, Loader=yaml.BaseLoader)
 
     test_content = [
@@ -91,8 +152,9 @@ def build_crypto():
     # Set up YAML dump style
     class literal_str(str): pass
 
-    def change_style(style, representer):
-        def new_representer(dumper, data):
+    def change_style(style: Literal['"', '|', '>'],
+                     representer: Callable['...', yaml.ScalarNode]):
+        def new_representer(dumper: yaml.Dumper, data: str) -> yaml.ScalarNode:
             scalar = representer(dumper, data)
             scalar.style = style
             return scalar
@@ -103,12 +165,13 @@ def new_representer(dumper, data):
 
     # Process
     with open('crypto.yaml', 'r') as stream:
-        crypto_input = yaml.load(stream, Loader=yaml.BaseLoader)
+        crypto_input: dict[str, CryptoSet] = yaml.load(  # pyright: ignore[reportAssignmentType]
+            stream, Loader=yaml.BaseLoader)
 
-    test_content = [
+    test_content: list[str] = [
         f'# SYNTAX TEST "{SYNTAX_STEM}SSH Crypto.sublime-syntax"\n',
     ]
-    syntax_content = {
+    syntax_content: SyntaxYaml = {
         'name': 'SSH Crypto',
         'hidden': True,
         'scope': 'text.ssh.crypto',
@@ -117,19 +180,22 @@ def new_representer(dumper, data):
         'hidden_file_extensions': [
             'syntax_test_crypto',
         ],
-        'contexts': {
-            'main': [
-                {'include': 'comments'},
-            ],
-        },
+        'contexts': {},
         'variables': {},
     }
+    syntax_contexts: dict[str, list[SyntaxContext]] = {
+        'main': [
+            {'include': 'comments'},
+        ],
+    }
+    syntax_variables: dict[str, str] = {}
 
     for domain, settings in crypto_input.items():
-        completions = {
+        completions_yaml: CompletionYaml = {
             'scope': settings['completions']['scope'].strip(),
             'completions': [],
         }
+        completions: list[CompletionItem] = []
         default_kind: list[str] = settings['completions']['kind']
         annotation: str = settings['completions']['annotation']
         active_scope: str = settings['active']['scope']
@@ -138,14 +204,14 @@ def new_representer(dumper, data):
         domain_ = domain.replace('-', '_')
 
         test_content.append(f'\n###[ {domain + " ]":#<74}\n')
-        _ = syntax_content['contexts']['main'].append({
+        _ = syntax_contexts['main'].append({
             'match': fr'^{annotation}:',
             'push': [
                 {'include': 'pop-before-nl'},
                 {'include': f'ssh-{domain}'}
             ]
         })
-        syntax_content['contexts'][f'ssh-{domain}'] = [
+        syntax_contexts[f'ssh-{domain}'] = [
             {
                 'match': fr'\b{{{{{domain_}_active}}}}(?=[,\s\"])',
                 'scope': active_scope,
@@ -155,21 +221,21 @@ def new_representer(dumper, data):
                 'scope': deprec_scope,
             },
         ]
-        syntax_content['variables'][f'{domain_}_active'] = literal_str(
+        syntax_variables[f'{domain_}_active'] = literal_str(
             fr"""(?x:{'\n  '}{'\n| '.join(
                 re.escape(i) for i in
                 sorted(settings['active']['items'], reverse=True)
             )}{'\n'})"""
         )
-        syntax_content['variables'][f'{domain_}_deprec'] = literal_str(
+        syntax_variables[f'{domain_}_deprec'] = literal_str(
             fr"""(?x:{'\n  '}{'\n| '.join(
                 re.escape(i) for i in
                 sorted(settings['deprecated']['items'], reverse=True)
             )}{'\n'})"""
         )
 
         for item in settings['active']['items']:
-            _ = completions['completions'].append({
+            _ = completions.append({
                 'trigger': item,
                 'contents': item,
                 'annotation': annotation,
@@ -180,7 +246,7 @@ def new_representer(dumper, data):
                 f'#{" " * len(annotation)} {"^" * len(item)} {active_scope}')
 
         for item in settings['deprecated']['items']:
-            _ = completions['completions'].append({
+            _ = completions.append({
                 'trigger': item,
                 'contents': item,
                 'annotation': f'deprecated {annotation}',
@@ -191,12 +257,17 @@ def new_representer(dumper, data):
             test_content.append(
                 f'#{" " * len(annotation)} {"^" * len(item)} {deprec_scope}')
 
+        completions_yaml['completions'] = completions
+
         with open(f'{SUPPORT_STEM}{domain}.sublime-completions', 'w') as f:
-            json.dump(completions, f, indent=4)
+            json.dump(completions_yaml, f, indent=4)
+
+    syntax_content['contexts'] = syntax_contexts
+    syntax_content['variables'] = syntax_variables
 
     with open('../syntax/SSH Crypto.sublime-syntax', 'w') as syntax_file:
         _ = syntax_file.write('%YAML 1.2\n---\n')
-        yaml.dump(syntax_content, syntax_file)
+        _ = yaml.dump(syntax_content, syntax_file)
 
     with open(f'{TEST_STEM}crypto', 'w') as test_file:
         _ = test_file.write('\n'.join(test_content))