ZedScripts 1.0.0__tar.gz → 1.1.0__tar.gz

{zedscripts-1.0.0/src/ZedScripts.egg-info → zedscripts-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ZedScripts
-Version: 1.0.0
+Version: 1.1.0
 Author: SimKDT
 License: MIT License
         
@@ -36,6 +36,8 @@ Provides-Extra: build
 Requires-Dist: pyinstaller; extra == "build"
 Provides-Extra: debug
 Requires-Dist: debugpy; extra == "debug"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
 Dynamic: license-file
 
 # ZedScripts LSP
@@ -211,6 +213,10 @@ Each diagnostic by default have a specific set of modifiers that can be overridd
 }
 ```
 
+### Server
+A list of server-related configurations for the LSP. The following parameters are available:
+- `logging_level` (optional, default: `INFO`): specifies the logging level for the server. This option is only available in the global configuration and accepts values such as `NOTSET`, `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`.
+
 ## IDE configuration
 Based on the IDE you use, you may need to install the ZedScripts LSP application for your OS in the [releases](https://github.com/PZ-Wiki-Modding/ZedScripts-LSP/releases) (Linux, Windows).
 

{zedscripts-1.0.0 → zedscripts-1.1.0}/README.md

@@ -171,6 +171,10 @@ Each diagnostic by default have a specific set of modifiers that can be overridd
 }
 ```
 
+### Server
+A list of server-related configurations for the LSP. The following parameters are available:
+- `logging_level` (optional, default: `INFO`): specifies the logging level for the server. This option is only available in the global configuration and accepts values such as `NOTSET`, `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`.
+
 ## IDE configuration
 Based on the IDE you use, you may need to install the ZedScripts LSP application for your OS in the [releases](https://github.com/PZ-Wiki-Modding/ZedScripts-LSP/releases) (Linux, Windows).
 

{zedscripts-1.0.0 → zedscripts-1.1.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "ZedScripts"
 description = ""
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.12.3"
-version = "1.0.0"
+version = "1.1.0"
 license = {file = "LICENSE"}
 authors = [
   { name = "SimKDT" },
@@ -23,6 +23,9 @@ build = [
 debug = [
     "debugpy"
 ]
+test = [
+    "pytest"
+]
 
 # used to load locale JSON files
 [build-system]

zedscripts-1.1.0/src/ZedScripts/__about__.py

@@ -0,0 +1,7 @@
+__version__ = "1.1.0"
+
+def main():
+    print(__version__)
+
+if __name__ == "__main__":
+    main()

zedscripts-1.1.0/src/ZedScripts/__init__.py

@@ -0,0 +1,75 @@
+import os
+import logging
+from datetime import datetime, timezone
+from pathlib import Path
+
+IDENTIFIER = "ZedScripts"
+SOURCE = IDENTIFIER
+
+IS_DEBUG = os.getenv("ZEDSCRIPTS_DEBUG_MODE") == "1"
+
+# zedscript's cache directory
+ZEDSCRIPT_CACHE_DIR = Path.home() / ".zedscripts"
+"""
+Cache directory to hold various information related to ZedScripts.
+"""
+ZEDSCRIPT_CACHE_DIR.mkdir(parents=True, exist_ok=True)
+
+# config files naming
+CONFIGURATION_FILE_NAME = ".zedscripts.json"
+GLOBAL_CONFIGURATION_FILE = (ZEDSCRIPT_CACHE_DIR / CONFIGURATION_FILE_NAME).resolve()
+
+# setup the logger
+
+log_dir = Path.home() / ".zedscripts" / "logs"
+log_dir.mkdir(parents=True, exist_ok=True)
+
+# define logger
+logger = logging.getLogger()
+
+# set early level, this is changed later by the user configuration
+# in the server initialization
+logger.setLevel(logging.DEBUG if IS_DEBUG else logging.INFO)
+
+formater = logging.Formatter("%(asctime)s %(levelname)s %(message)s")
+
+# setup the time-based log handler
+timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%d-%H-%M-%S-%f")
+time_log_file = log_dir / f"server-{timestamp}.log"
+time_handler = logging.FileHandler(time_log_file, encoding="utf-8")
+time_handler.setFormatter(
+    formater
+)
+logger.addHandler(time_handler)
+
+# setup the debug log handler which stays in the same file to make it easier to view logs
+# when restarting the server for example
+if IS_DEBUG:
+    global_log_file = log_dir / f"server-debug.log"
+    global_handler = logging.FileHandler(
+        global_log_file, encoding="utf-8", mode="w"
+    )
+    global_handler.setFormatter(
+        formater
+    )
+    logger.addHandler(global_handler)
+
+# filenames sort chronologically because the timestamp comes first
+keep_logs = 5
+log_files = sorted(log_dir.glob("server-*.log"), reverse=True)
+
+# delete the oldest log file
+for old_file in log_files[keep_logs:]:
+    try:
+        old_file.unlink()
+    except OSError:
+        logger.exception("Failed to delete old log file: %s", old_file)
+
+logging.info("ZedScripts logger initialized. Debug mode: %s", IS_DEBUG)
+
+# datasets
+SCRIPTS_DATA_MANIFEST = "https://raw.githubusercontent.com/PZ-Wiki-Modding/pz-scripts-data/refs/heads/main/manifest.json"
+SCRIPTS_BLOCKS_DATA_LINK = "https://raw.githubusercontent.com/PZ-Wiki-Modding/pz-scripts-data/refs/tags/{best_tag}/out/scriptsBlocks.json"
+ROOTS_DATA_LINK = "https://raw.githubusercontent.com/PZ-Wiki-Modding/pz-scripts-data/refs/tags/{best_tag}/out/roots.json"
+
+SCRIPTSDOCS_LINK = "https://pz-wiki-modding.github.io/PZ-API-Docs/scripts/"

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts/enums/Diagnostic.py

@@ -76,7 +76,7 @@ DiagnosticDefinition(DiagnosticType.BLOCK_UNEXPECTED_ID,
                      tags=[DiagnosticTag.Unnecessary])
 DiagnosticDefinition(DiagnosticType.BLOCK_MISSING_ID,
                      DiagnosticSeverity.Error,
-                     args={"type": str, "id": str})
+                     args={"type": str})
 DiagnosticDefinition(DiagnosticType.BLOCK_HAS_ID_IN_PARENT,
                      DiagnosticSeverity.Error,
                      args={"type": str, "parent_type": str, "invalid_blocks": list},

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts/environment/__init__.py

@@ -1,4 +1,5 @@
 import enum
+import logging
 
 
 class WorkspaceType(enum.StrEnum):
@@ -31,3 +32,10 @@ class VersionType(enum.StrEnum):
     BASE_GAME = enum.auto()
     """Base game files (e.g., `ProjectZomboid/media`)."""
 
+class LoggerLevel(enum.IntEnum):
+    NOTSET = logging.NOTSET
+    DEBUG = logging.DEBUG
+    INFO = logging.INFO
+    WARNING = logging.WARNING
+    ERROR = logging.ERROR
+    CRITICAL = logging.CRITICAL

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts/environment/config.py

@@ -1,11 +1,19 @@
+"""
+Provides the configuration models and schema generation for the ZedScripts environment.
+
+Usage:
+    python -m ZedScripts.environment.config schema -o schema/zedscripts.json
+    python -m ZedScripts.environment.config default -o default_config.json
+"""
 import logging
 import enum
 from pathlib import Path
 from typing import Annotated, Optional
-from pydantic import BaseModel, BeforeValidator, Field, WithJsonSchema
+from pydantic import BaseModel, BeforeValidator, Field, WithJsonSchema, ConfigDict
 
 from lsprotocol.types import DiagnosticSeverity, DiagnosticTag
 
+from ..environment import LoggerLevel
 from ..scripts.version import DataVersion
 from ..enums.Diagnostic import DiagnosticType
 
@@ -68,6 +76,24 @@ DiagnosticTagName = Annotated[
     }),
 ]
 
+def _parse_logger_level_name(value: object) -> object:
+    if isinstance(value, LoggerLevel):
+        return value
+    if isinstance(value, str):
+        try:
+            return LoggerLevel[value]
+        except KeyError:
+            raise ValueError("level must be a LoggerLevel member name") from None
+    return value
+LoggerLevelName = Annotated[
+    LoggerLevel,
+    BeforeValidator(_parse_logger_level_name),
+    WithJsonSchema({
+        "type": "string",
+        "enum": [member.name for member in LoggerLevel],
+    }),
+]
+
 
 
 # define the models
@@ -77,8 +103,13 @@ class DatasetTag(enum.StrEnum):
     STABLE = "stable"
 
 
+class ZedBaseModel(BaseModel):
+    """Base model for all ZedScripts configuration models.
+    Notably used to set additionalProperties to false for everything."""
+    model_config = ConfigDict(extra='forbid')
+
 
-class ReleaseModel(BaseModel):
+class ReleaseModel(ZedBaseModel):
     major: int = Field(
         description="Build game version number.",
         ge=42,
@@ -97,7 +128,7 @@ class ReleaseModel(BaseModel):
         ge=0,
     )
 
-class DatasetModel(BaseModel):
+class DatasetModel(ZedBaseModel):
     release: Optional[ReleaseModel] = Field(
         description="Provides a configuration for the dataset version to use for validation. This overrides the `latest` and `stable` fields if set.",
         default=None,
@@ -126,7 +157,7 @@ class DatasetModel(BaseModel):
             logging.error(f"Failed to get data version from release model: {e}. Defaulting to 'stable'.")
             return DatasetTag.STABLE
 
-class DiagnosticsModel(BaseModel):
+class DiagnosticsModel(ZedBaseModel):
     """Represents the diagnostics configuration for the workspace environment."""
     type: DiagnosticTypeName = Field(
         description="Specifies the diagnostic member name to enable.",
@@ -144,7 +175,15 @@ class DiagnosticsModel(BaseModel):
         default=None,
     )
 
-class ConfigurationModel(BaseModel):
+class ServerModel(ZedBaseModel):
+    """Represents the server configuration for the workspace environment."""
+    logging_level: Optional[LoggerLevelName] = Field(
+        description="Specifies the logging level for the server. This option only works in the global configuration.",
+        default=LoggerLevel.INFO,
+        exclude=True,
+    )
+
+class ConfigurationModel(ZedBaseModel):
     """Represents the content of the configuration files for workspace environments."""
     dataset: DatasetModel = Field(
         description="Provides configuration for the dataset version to use for diagnostics.",
@@ -166,6 +205,10 @@ class ConfigurationModel(BaseModel):
         description="List of diagnostics configurations for the workspace environment.",
         default_factory=list,
     )
+    server: ServerModel = Field(
+        description="Provides configuration for the server in the workspace environment.",
+        default_factory=ServerModel,
+    )
 
     def find_diagnostic(self, type: DiagnosticType) -> DiagnosticsModel | None:
         for diagnostic in self.diagnostics:
@@ -174,6 +217,46 @@ class ConfigurationModel(BaseModel):
         return None
 
 if __name__ == "__main__":
-    import json
-    config = ConfigurationModel()
-    print(json.dumps(config.model_json_schema(), indent=4))
+    import argparse
+
+    def print_schema(args: argparse.Namespace):
+        import json
+        config = ConfigurationModel()
+        out = json.dumps(config.model_json_schema(), indent=4)
+        print(out)
+        if args.output_path:
+            with open(args.output_path, "w") as f:
+                f.write(out)
+
+    def print_default_config(args: argparse.Namespace):
+        config = ConfigurationModel()
+        out = config.model_dump_json(indent=4)
+        print(out)
+        if args.output_path:
+            with open(args.output_path, "w") as f:
+                f.write(out)
+
+    main_parser = argparse.ArgumentParser(description="ZedScripts configuration tool")
+
+    # schema generation command
+    subparser = main_parser.add_subparsers(
+        dest="command",
+        required=True,
+        help="Available commands"
+    )
+    schema_parser = subparser.add_parser("schema", 
+                                         help="Print the JSON schema of the configuration model.")
+    schema_parser.add_argument("-o", "--output-path", 
+                               help="Path to output the JSON schema.")
+    schema_parser.set_defaults(func=print_schema)
+
+    # default configuration command
+    default_config_subparser = subparser.add_parser("default", 
+                                                    help="Print the default configuration of the workspace environment.")
+    default_config_subparser.add_argument("-o", "--output-path", 
+                                          help="Path to output the default configuration.")
+    default_config_subparser.set_defaults(func=print_default_config)
+
+    args = main_parser.parse_args()
+
+    args.func(args)

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts/environment/document.py

@@ -131,12 +131,14 @@ class Document:
     def make(dataset: 'Dataset', path: Path, workspace: 'Workspace') -> 'Document | None':
         # find the rootType of the document
         rootType = dataset.test_for_root(path)
+        logging.debug(f"Tested {path} for root, got: {rootType}")
         if rootType is None:
             return None
 
         # find the version and skip if pre 42
         # since we don't validate that
         version = Version.find_or_make_version(path)
+        logging.debug(f"Tested {path} for version, got: {version}")
         if version.type == VersionType.PRE_42:
             return None
 

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts/environment/workspace.py

@@ -260,7 +260,20 @@ class Workspace:
     @staticmethod
     def update_global_configuration(text: str | None = None) -> None:
         logging.info("Updating global configuration from %s", GLOBAL_CONFIGURATION_FILE)
-        Workspace.global_configuration = Workspace.load_configuration(GLOBAL_CONFIGURATION_FILE, text=text)
+        # init file if it doesn't exist to default values
+        if not GLOBAL_CONFIGURATION_FILE.exists():
+            with open(GLOBAL_CONFIGURATION_FILE, "w") as f:
+                config = ConfigurationModel()
+                f.write(config.model_dump_json(
+                    indent=4
+                ))
+        
+        # load existing global
+        else:
+            config = Workspace.load_configuration(GLOBAL_CONFIGURATION_FILE, text=text)
+
+        # cache current snapshot of the global configuration
+        Workspace.global_configuration = config
         logging.debug(Workspace.global_configuration)
 
     @staticmethod

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts/scripts/block.py

@@ -405,7 +405,7 @@ class ScriptBlock(Block, Element["BlockNode"]):
                 self.add_diagnostic(
                     DiagnosticType.BLOCK_MISSING_ID,
                     node.type.to_range(),
-                    {"id": ID_data}
+                    {"type": type}
                 )
                 return False
 

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts/server.py

@@ -148,7 +148,7 @@ zedserver = ZedServer()
 
 
 
-## EVENT HANDLERS
+## INITIALIZERS
 
 @zedserver.feature(types.INITIALIZE)
 def initialize(server: ZedServer, params: types.InitializeParams):
@@ -165,6 +165,11 @@ def initialize(server: ZedServer, params: types.InitializeParams):
     # this will store what the server can currently do
     capabilities.register_client_capabilities(params)
 
+    global_config = Workspace.get_global_configuration()
+    if global_config.server.logging_level is not None:
+        logging.info("Setting logging level to %s", global_config.server.logging_level)
+        logging.getLogger().setLevel(global_config.server.logging_level)
+
     # from the above, we determine what the server capabilities should be
     return types.InitializeResult(
         capabilities=capabilities.get_server_capabilities(),
@@ -217,6 +222,9 @@ def initialized(server: ZedServer, params: types.InitializedParams) -> None:
     notifications.send_notification(notifications.ZedNotification.LOADING_DOCUMENTS_DONE)
 
 
+
+## EVENT HANDLERS
+
 @zedserver.feature(types.TEXT_DOCUMENT_DID_OPEN)
 def did_open(server: ZedServer, params: types.DidOpenTextDocumentParams) -> None:
     server.on_document_changed(uri_to_path(params.text_document.uri), params.text_document.text)

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts/structure/lexer.py

@@ -194,25 +194,21 @@ WHITESPACE_NO_NEWLINE = string.whitespace.replace("\n", "")
 
 
 
-class ZedscriptSource:
-    def __init__(self, text: str) -> None:
-        self.string: str = text
-        self.tokens: TokenCollection = TokenCollection()
-
-
 class Token:
     def __init__(
             self, type: TokenType, pos: TextPosition, end: TextPosition,
-            source: ZedscriptSource, text: str
+            text: str
     ) -> None:
         self.type: TokenType = type
         self.pos: TextPosition = pos
         """Start position of the token."""
         self.end: TextPosition = end
         """End position of the token."""
-        self.source: ZedscriptSource = source
         self.text = text
 
+    def __repr__(self) -> str:
+        return f"Token(type={self.type}, text={self.text!r}, pos={self.pos}, end={self.end})"
+
     def pos_of(self, i: int) -> TextPosition:
         """
         Returns the TextPosition of the character at index i in the string.
@@ -233,6 +229,16 @@ class Token:
     def __str__(self) -> str:
         return self.text
 
+    def __eq__(self, value: object) -> bool:
+        if not isinstance(value, Token):
+            return NotImplemented
+        return (
+            self.type == value.type and
+            self.pos == value.pos and
+            self.end == value.end and
+            self.text == value.text
+        )
+
 
 class TokenCollection(UserList[Token]):
     def at(self, pos: TextPosition) -> Token | None:
@@ -314,23 +320,22 @@ class TokenCollection(UserList[Token]):
 
 # TODO: this class is kinda redundant after all
 class TokenBuilder:
-    def __init__(self, pos: TextPosition, type: TokenType, source: ZedscriptSource) -> None:
+    def __init__(self, pos: TextPosition, type: TokenType) -> None:
         self.type: TokenType = type
         self.pos: TextPosition = pos
         self.text: str = ""
-        self.source: ZedscriptSource = source
 
     def add(self, char: str) -> None:
         self.text += char
 
     def build(self, end: TextPosition) -> Token:
-        return Token(self.type, self.pos, end, self.source, self.text)
+        return Token(self.type, self.pos, end, self.text)
 
 
 class Lexer:
     def __init__(self, text: str) -> None:
         self.text: str = text
-        self.source = ZedscriptSource(text)
+        self.tokens = TokenCollection()
         self.pos: int = -1
         self.line: int = 0
         self.offset: int = 0
@@ -364,7 +369,7 @@ class Lexer:
         return self.text[self.pos + num_characters]
 
     def start_token(self, type: TokenType) -> TokenBuilder:
-        return TokenBuilder(TextPosition(self.line, self.offset), type, self.source)
+        return TokenBuilder(TextPosition(self.line, self.offset), type)
 
     def tokenize_comment(self) -> None:
         assert self.check_comment()
@@ -381,7 +386,7 @@ class Lexer:
                 token.add(self.next())
                 break
 
-        self.source.tokens.append(
+        self.tokens.append(
             token.build(
                 TextPosition(self.line, self.offset)
             )
@@ -396,7 +401,7 @@ class Lexer:
     def tokenize_punctuator(self) -> None:
         token = self.start_token(TokenType.PUNCTUATOR)
         token.add(self.next())
-        self.source.tokens.append(
+        self.tokens.append(
             token.build(
                 TextPosition(self.line, self.offset)
             )
@@ -414,7 +419,7 @@ class Lexer:
                 break
             token.add(self.next())
 
-        self.source.tokens.append(
+        self.tokens.append(
             token.build(
                 TextPosition(self.line, self.offset)
             )
@@ -429,7 +434,7 @@ class Lexer:
                 break
             token.add(self.next())
 
-        self.source.tokens.append(
+        self.tokens.append(
             token.build(
                 TextPosition(self.line, self.offset)
             )
@@ -449,7 +454,7 @@ class Lexer:
             elif char in ELEMENTS_DELIMITERS:
                 token = lexer.start_token(TokenType.ELEMENT_DELIMITER)
                 token.add(lexer.next())
-                lexer.source.tokens.append(
+                lexer.tokens.append(
                     token.build(
                         TextPosition(lexer.line, lexer.offset)
                     )
@@ -460,7 +465,7 @@ class Lexer:
                 continue
             lexer.tokenize_text()
 
-        return TokenCollection(lexer.source.tokens)
+        return TokenCollection(lexer.tokens)
 
 
 if __name__ == "__main__":

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts/structure/parser.py

@@ -93,10 +93,6 @@ def parse_type_id(tokens: list[Token]) -> tuple[TokenCollection | None, TokenCol
     return type_token, id_token
 
 
-def parse(text: str) -> ParseResult:
-    return parse_tokens(Lexer.tokenize(text))
-
-
 def parse_tokens(tokens: TokenCollection) -> ParseResult:
     parser = Parser()
     unparsed_tokens: list[Token] = []

zedscripts-1.1.0/src/ZedScripts/tests/parser/test_lexer.py

@@ -0,0 +1,261 @@
+
+from ZedScripts.structure.lexer import Lexer, TextPosition, TokenType, Token, TokenCollection
+
+
+def parse_example_content() -> TokenCollection:
+    EXAMPLE_SCRIPT_CONTENT = r"""
+module Base {
+    item ItemTest {
+        param1 = value,
+        param2 = val1;val2;val3,
+        param3 = key1:val1;key2:val2,
+
+        param4= value,
+        param5 =value,
+        param6=value,
+        param7       =                   fuck you ?,
+
+        weird_param = key1=val1:key2=val2,
+
+        to_new_line = 
+        value,
+
+        /* values */
+        value1,
+        value2,
+        value3,
+        value4:value5,
+    }
+
+    sound SoundTest {
+        clip = this/path/to/clip, volume = 0.8,
+    }
+
+    model id with spaces {
+    
+    }
+
+    /* comment, different syntax block under
+    hello world *//* comment continued */
+    
+    this_is_a_weird_block {
+    
+    }
+
+    item ItemTest2
+    {
+
+    }
+}
+    """.strip()
+    return Lexer.tokenize(EXAMPLE_SCRIPT_CONTENT)
+
+
+def get_theorical_tokens():
+    EXPECTED_LEXICAL_TOKENS = TokenCollection(
+        [
+            Token(TokenType.TEXT, TextPosition(0, 0), TextPosition(0, 6), 'module'),
+            Token(TokenType.WHITESPACE, TextPosition(0, 6), TextPosition(0, 7), ' '),
+            Token(TokenType.TEXT, TextPosition(0, 7), TextPosition(0, 11), 'Base'),
+            Token(TokenType.WHITESPACE, TextPosition(0, 11), TextPosition(0, 12), ' '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(0, 12), TextPosition(0, 13), '{'),
+            Token(TokenType.WHITESPACE, TextPosition(0, 13), TextPosition(1, 4), '\n    '),
+            Token(TokenType.TEXT, TextPosition(1, 4), TextPosition(1, 8), 'item'),
+            Token(TokenType.WHITESPACE, TextPosition(1, 8), TextPosition(1, 9), ' '),
+            Token(TokenType.TEXT, TextPosition(1, 9), TextPosition(1, 17), 'ItemTest'),
+            Token(TokenType.WHITESPACE, TextPosition(1, 17), TextPosition(1, 18), ' '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(1, 18), TextPosition(1, 19), '{'),
+            Token(TokenType.WHITESPACE, TextPosition(1, 19), TextPosition(2, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(2, 8), TextPosition(2, 14), 'param1'),
+            Token(TokenType.WHITESPACE, TextPosition(2, 14), TextPosition(2, 15), ' '),
+            Token(TokenType.PUNCTUATOR, TextPosition(2, 15), TextPosition(2, 16), '='),
+            Token(TokenType.WHITESPACE, TextPosition(2, 16), TextPosition(2, 17), ' '),
+            Token(TokenType.TEXT, TextPosition(2, 17), TextPosition(2, 22), 'value'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(2, 22), TextPosition(2, 23), ','),
+            Token(TokenType.WHITESPACE, TextPosition(2, 23), TextPosition(3, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(3, 8), TextPosition(3, 14), 'param2'),
+            Token(TokenType.WHITESPACE, TextPosition(3, 14), TextPosition(3, 15), ' '),
+            Token(TokenType.PUNCTUATOR, TextPosition(3, 15), TextPosition(3, 16), '='),
+            Token(TokenType.WHITESPACE, TextPosition(3, 16), TextPosition(3, 17), ' '),
+            Token(TokenType.TEXT, TextPosition(3, 17), TextPosition(3, 21), 'val1'),
+            Token(TokenType.PUNCTUATOR, TextPosition(3, 21), TextPosition(3, 22), ';'),
+            Token(TokenType.TEXT, TextPosition(3, 22), TextPosition(3, 26), 'val2'),
+            Token(TokenType.PUNCTUATOR, TextPosition(3, 26), TextPosition(3, 27), ';'),
+            Token(TokenType.TEXT, TextPosition(3, 27), TextPosition(3, 31), 'val3'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(3, 31), TextPosition(3, 32), ','),
+            Token(TokenType.WHITESPACE, TextPosition(3, 32), TextPosition(4, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(4, 8), TextPosition(4, 14), 'param3'),
+            Token(TokenType.WHITESPACE, TextPosition(4, 14), TextPosition(4, 15), ' '),
+            Token(TokenType.PUNCTUATOR, TextPosition(4, 15), TextPosition(4, 16), '='),
+            Token(TokenType.WHITESPACE, TextPosition(4, 16), TextPosition(4, 17), ' '),
+            Token(TokenType.TEXT, TextPosition(4, 17), TextPosition(4, 21), 'key1'),
+            Token(TokenType.PUNCTUATOR, TextPosition(4, 21), TextPosition(4, 22), ':'),
+            Token(TokenType.TEXT, TextPosition(4, 22), TextPosition(4, 26), 'val1'),
+            Token(TokenType.PUNCTUATOR, TextPosition(4, 26), TextPosition(4, 27), ';'),
+            Token(TokenType.TEXT, TextPosition(4, 27), TextPosition(4, 31), 'key2'),
+            Token(TokenType.PUNCTUATOR, TextPosition(4, 31), TextPosition(4, 32), ':'),
+            Token(TokenType.TEXT, TextPosition(4, 32), TextPosition(4, 36), 'val2'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(4, 36), TextPosition(4, 37), ','),
+            Token(TokenType.WHITESPACE, TextPosition(4, 37), TextPosition(6, 8), '\n\n        '),
+            Token(TokenType.TEXT, TextPosition(6, 8), TextPosition(6, 14), 'param4'),
+            Token(TokenType.PUNCTUATOR, TextPosition(6, 14), TextPosition(6, 15), '='),
+            Token(TokenType.WHITESPACE, TextPosition(6, 15), TextPosition(6, 16), ' '),
+            Token(TokenType.TEXT, TextPosition(6, 16), TextPosition(6, 21), 'value'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(6, 21), TextPosition(6, 22), ','),
+            Token(TokenType.WHITESPACE, TextPosition(6, 22), TextPosition(7, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(7, 8), TextPosition(7, 14), 'param5'),
+            Token(TokenType.WHITESPACE, TextPosition(7, 14), TextPosition(7, 15), ' '),
+            Token(TokenType.PUNCTUATOR, TextPosition(7, 15), TextPosition(7, 16), '='),
+            Token(TokenType.TEXT, TextPosition(7, 16), TextPosition(7, 21), 'value'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(7, 21), TextPosition(7, 22), ','),
+            Token(TokenType.WHITESPACE, TextPosition(7, 22), TextPosition(8, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(8, 8), TextPosition(8, 14), 'param6'),
+            Token(TokenType.PUNCTUATOR, TextPosition(8, 14), TextPosition(8, 15), '='),
+            Token(TokenType.TEXT, TextPosition(8, 15), TextPosition(8, 20), 'value'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(8, 20), TextPosition(8, 21), ','),
+            Token(TokenType.WHITESPACE, TextPosition(8, 21), TextPosition(9, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(9, 8), TextPosition(9, 14), 'param7'),
+            Token(TokenType.WHITESPACE, TextPosition(9, 14), TextPosition(9, 21), '       '),
+            Token(TokenType.PUNCTUATOR, TextPosition(9, 21), TextPosition(9, 22), '='),
+            Token(TokenType.WHITESPACE, TextPosition(9, 22), TextPosition(9, 41), '                   '),
+            Token(TokenType.TEXT, TextPosition(9, 41), TextPosition(9, 45), 'fuck'),
+            Token(TokenType.WHITESPACE, TextPosition(9, 45), TextPosition(9, 46), ' '),
+            Token(TokenType.TEXT, TextPosition(9, 46), TextPosition(9, 49), 'you'),
+            Token(TokenType.WHITESPACE, TextPosition(9, 49), TextPosition(9, 50), ' '),
+            Token(TokenType.TEXT, TextPosition(9, 50), TextPosition(9, 51), '?'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(9, 51), TextPosition(9, 52), ','),
+            Token(TokenType.WHITESPACE, TextPosition(9, 52), TextPosition(11, 8), '\n\n        '),
+            Token(TokenType.TEXT, TextPosition(11, 8), TextPosition(11, 19), 'weird_param'),
+            Token(TokenType.WHITESPACE, TextPosition(11, 19), TextPosition(11, 20), ' '),
+            Token(TokenType.PUNCTUATOR, TextPosition(11, 20), TextPosition(11, 21), '='),
+            Token(TokenType.WHITESPACE, TextPosition(11, 21), TextPosition(11, 22), ' '),
+            Token(TokenType.TEXT, TextPosition(11, 22), TextPosition(11, 26), 'key1'),
+            Token(TokenType.PUNCTUATOR, TextPosition(11, 26), TextPosition(11, 27), '='),
+            Token(TokenType.TEXT, TextPosition(11, 27), TextPosition(11, 31), 'val1'),
+            Token(TokenType.PUNCTUATOR, TextPosition(11, 31), TextPosition(11, 32), ':'),
+            Token(TokenType.TEXT, TextPosition(11, 32), TextPosition(11, 36), 'key2'),
+            Token(TokenType.PUNCTUATOR, TextPosition(11, 36), TextPosition(11, 37), '='),
+            Token(TokenType.TEXT, TextPosition(11, 37), TextPosition(11, 41), 'val2'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(11, 41), TextPosition(11, 42), ','),
+            Token(TokenType.WHITESPACE, TextPosition(11, 42), TextPosition(13, 8), '\n\n        '),
+            Token(TokenType.TEXT, TextPosition(13, 8), TextPosition(13, 19), 'to_new_line'),
+            Token(TokenType.WHITESPACE, TextPosition(13, 19), TextPosition(13, 20), ' '),
+            Token(TokenType.PUNCTUATOR, TextPosition(13, 20), TextPosition(13, 21), '='),
+            Token(TokenType.WHITESPACE, TextPosition(13, 21), TextPosition(14, 8), ' \n        '),
+            Token(TokenType.TEXT, TextPosition(14, 8), TextPosition(14, 13), 'value'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(14, 13), TextPosition(14, 14), ','),
+            Token(TokenType.WHITESPACE, TextPosition(14, 14), TextPosition(16, 8), '\n\n        '),
+            Token(TokenType.COMMENT, TextPosition(16, 8), TextPosition(16, 20), '/* values */'),
+            Token(TokenType.WHITESPACE, TextPosition(16, 20), TextPosition(17, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(17, 8), TextPosition(17, 14), 'value1'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(17, 14), TextPosition(17, 15), ','),
+            Token(TokenType.WHITESPACE, TextPosition(17, 15), TextPosition(18, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(18, 8), TextPosition(18, 14), 'value2'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(18, 14), TextPosition(18, 15), ','),
+            Token(TokenType.WHITESPACE, TextPosition(18, 15), TextPosition(19, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(19, 8), TextPosition(19, 14), 'value3'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(19, 14), TextPosition(19, 15), ','),
+            Token(TokenType.WHITESPACE, TextPosition(19, 15), TextPosition(20, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(20, 8), TextPosition(20, 14), 'value4'),
+            Token(TokenType.PUNCTUATOR, TextPosition(20, 14), TextPosition(20, 15), ':'),
+            Token(TokenType.TEXT, TextPosition(20, 15), TextPosition(20, 21), 'value5'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(20, 21), TextPosition(20, 22), ','),
+            Token(TokenType.WHITESPACE, TextPosition(20, 22), TextPosition(21, 4), '\n    '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(21, 4), TextPosition(21, 5), '}'),
+            Token(TokenType.WHITESPACE, TextPosition(21, 5), TextPosition(23, 4), '\n\n    '),
+            Token(TokenType.TEXT, TextPosition(23, 4), TextPosition(23, 9), 'sound'),
+            Token(TokenType.WHITESPACE, TextPosition(23, 9), TextPosition(23, 10), ' '),
+            Token(TokenType.TEXT, TextPosition(23, 10), TextPosition(23, 19), 'SoundTest'),
+            Token(TokenType.WHITESPACE, TextPosition(23, 19), TextPosition(23, 20), ' '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(23, 20), TextPosition(23, 21), '{'),
+            Token(TokenType.WHITESPACE, TextPosition(23, 21), TextPosition(24, 8), '\n        '),
+            Token(TokenType.TEXT, TextPosition(24, 8), TextPosition(24, 12), 'clip'),
+            Token(TokenType.WHITESPACE, TextPosition(24, 12), TextPosition(24, 13), ' '),
+            Token(TokenType.PUNCTUATOR, TextPosition(24, 13), TextPosition(24, 14), '='),
+            Token(TokenType.WHITESPACE, TextPosition(24, 14), TextPosition(24, 15), ' '),
+            Token(TokenType.TEXT, TextPosition(24, 15), TextPosition(24, 32), 'this/path/to/clip'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(24, 32), TextPosition(24, 33), ','),
+            Token(TokenType.WHITESPACE, TextPosition(24, 33), TextPosition(24, 34), ' '),
+            Token(TokenType.TEXT, TextPosition(24, 34), TextPosition(24, 40), 'volume'),
+            Token(TokenType.WHITESPACE, TextPosition(24, 40), TextPosition(24, 41), ' '),
+            Token(TokenType.PUNCTUATOR, TextPosition(24, 41), TextPosition(24, 42), '='),
+            Token(TokenType.WHITESPACE, TextPosition(24, 42), TextPosition(24, 43), ' '),
+            Token(TokenType.TEXT, TextPosition(24, 43), TextPosition(24, 44), '0'),
+            Token(TokenType.PUNCTUATOR, TextPosition(24, 44), TextPosition(24, 45), '.'),
+            Token(TokenType.TEXT, TextPosition(24, 45), TextPosition(24, 46), '8'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(24, 46), TextPosition(24, 47), ','),
+            Token(TokenType.WHITESPACE, TextPosition(24, 47), TextPosition(25, 4), '\n    '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(25, 4), TextPosition(25, 5), '}'),
+            Token(TokenType.WHITESPACE, TextPosition(25, 5), TextPosition(27, 4), '\n\n    '),
+            Token(TokenType.TEXT, TextPosition(27, 4), TextPosition(27, 9), 'model'),
+            Token(TokenType.WHITESPACE, TextPosition(27, 9), TextPosition(27, 10), ' '),
+            Token(TokenType.TEXT, TextPosition(27, 10), TextPosition(27, 12), 'id'),
+            Token(TokenType.WHITESPACE, TextPosition(27, 12), TextPosition(27, 13), ' '),
+            Token(TokenType.TEXT, TextPosition(27, 13), TextPosition(27, 17), 'with'),
+            Token(TokenType.WHITESPACE, TextPosition(27, 17), TextPosition(27, 18), ' '),
+            Token(TokenType.TEXT, TextPosition(27, 18), TextPosition(27, 24), 'spaces'),
+            Token(TokenType.WHITESPACE, TextPosition(27, 24), TextPosition(27, 25), ' '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(27, 25), TextPosition(27, 26), '{'),
+            Token(TokenType.WHITESPACE, TextPosition(27, 26), TextPosition(29, 4), '\n    \n    '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(29, 4), TextPosition(29, 5), '}'),
+            Token(TokenType.WHITESPACE, TextPosition(29, 5), TextPosition(31, 4), '\n\n    '),
+            Token(TokenType.COMMENT, TextPosition(31, 4), TextPosition(32, 18), '/* comment, different syntax block under\n    hello world */'),
+            Token(TokenType.COMMENT, TextPosition(32, 18), TextPosition(32, 41), '/* comment continued */'),
+            Token(TokenType.WHITESPACE, TextPosition(32, 41), TextPosition(34, 4), '\n    \n    '),
+            Token(TokenType.TEXT, TextPosition(34, 4), TextPosition(34, 25), 'this_is_a_weird_block'),
+            Token(TokenType.WHITESPACE, TextPosition(34, 25), TextPosition(34, 26), ' '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(34, 26), TextPosition(34, 27), '{'),
+            Token(TokenType.WHITESPACE, TextPosition(34, 27), TextPosition(36, 4), '\n    \n    '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(36, 4), TextPosition(36, 5), '}'),
+            Token(TokenType.WHITESPACE, TextPosition(36, 5), TextPosition(38, 4), '\n\n    '),
+            Token(TokenType.TEXT, TextPosition(38, 4), TextPosition(38, 8), 'item'),
+            Token(TokenType.WHITESPACE, TextPosition(38, 8), TextPosition(38, 9), ' '),
+            Token(TokenType.TEXT, TextPosition(38, 9), TextPosition(38, 18), 'ItemTest2'),
+            Token(TokenType.WHITESPACE, TextPosition(38, 18), TextPosition(39, 4), '\n    '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(39, 4), TextPosition(39, 5), '{'),
+            Token(TokenType.WHITESPACE, TextPosition(39, 5), TextPosition(41, 4), '\n\n    '),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(41, 4), TextPosition(41, 5), '}'),
+            Token(TokenType.WHITESPACE, TextPosition(41, 5), TextPosition(42, 0), '\n'),
+            Token(TokenType.ELEMENT_DELIMITER, TextPosition(42, 0), TextPosition(42, 1), '}'),
+        ]
+    )
+    return EXPECTED_LEXICAL_TOKENS
+
+
+
+
+def test_lexer():
+    """Test the lexer by comparing its output against the theorical tokens."""
+    lexical_tokens = parse_example_content()
+    theorical_tokens = get_theorical_tokens()
+
+    for token, theorical_token in zip(lexical_tokens, theorical_tokens):
+        print(repr(theorical_token).ljust(80), repr(token).ljust(80))
+        assert token == theorical_token, f"Theorical token: {theorical_token!r}, Actual token: {token!r}"
+
+def generate_theorical_tokens():
+    """
+    Assuming the tokens currently being parsed are already the right ones, generate the comparison list of theorical tokens
+    we are supposed to compare against.
+    """
+    lexical_tokens = parse_example_content()
+    for token in lexical_tokens:
+        print(f"Token({token.type}, TextPosition({token.pos.line}, {token.pos.offset}), TextPosition({token.end.line}, {token.end.offset}), {token.text!r}),")
+
+def main():
+    import argparse
+
+    parser = argparse.ArgumentParser(description="Lexer test.")
+    parser.add_argument("--run", action="store_true", help="Run the lexer test.")
+    parser.add_argument("--generate", action="store_true", help="Generate the theorical tokens.") 
+    args = parser.parse_args()
+    if args.run:
+        test_lexer()
+    elif args.generate:
+        generate_theorical_tokens()
+    else:
+        parser.print_help()
+
+
+if __name__ == "__main__":
+    main()

{zedscripts-1.0.0 → zedscripts-1.1.0/src/ZedScripts.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ZedScripts
-Version: 1.0.0
+Version: 1.1.0
 Author: SimKDT
 License: MIT License
         
@@ -36,6 +36,8 @@ Provides-Extra: build
 Requires-Dist: pyinstaller; extra == "build"
 Provides-Extra: debug
 Requires-Dist: debugpy; extra == "debug"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
 Dynamic: license-file
 
 # ZedScripts LSP
@@ -211,6 +213,10 @@ Each diagnostic by default have a specific set of modifiers that can be overridd
 }
 ```
 
+### Server
+A list of server-related configurations for the LSP. The following parameters are available:
+- `logging_level` (optional, default: `INFO`): specifies the logging level for the server. This option is only available in the global configuration and accepts values such as `NOTSET`, `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`.
+
 ## IDE configuration
 Based on the IDE you use, you may need to install the ZedScripts LSP application for your OS in the [releases](https://github.com/PZ-Wiki-Modding/ZedScripts-LSP/releases) (Linux, Windows).
 

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts.egg-info/SOURCES.txt

@@ -36,4 +36,6 @@ src/ZedScripts/scripts/value.py
 src/ZedScripts/scripts/version.py
 src/ZedScripts/structure/ast.py
 src/ZedScripts/structure/lexer.py
-src/ZedScripts/structure/parser.py
+src/ZedScripts/structure/parser.py
+src/ZedScripts/tests/parser/test_lexer.py
+tests/test_config_cli.py

{zedscripts-1.0.0 → zedscripts-1.1.0}/src/ZedScripts.egg-info/requires.txt

@@ -9,3 +9,6 @@ pyinstaller
 
 [debug]
 debugpy
+
+[test]
+pytest

zedscripts-1.1.0/tests/test_config_cli.py

@@ -0,0 +1,31 @@
+import json
+import subprocess
+import sys
+
+from ZedScripts.environment.config import ConfigurationModel
+
+
+def test_default_config_cli():
+    result = subprocess.run(
+        [sys.executable, "-m", "ZedScripts.environment.config", "default"],
+        capture_output=True,
+        text=True,
+        check=True,
+    )
+
+    output = json.loads(result.stdout)
+    assert output["libraries"] == []
+    assert isinstance(output["ignored"], list)
+    assert ConfigurationModel.model_validate_json(result.stdout) == ConfigurationModel()
+    assert '\n    "dataset": {' in result.stdout
+
+
+def test_config_schema_cli():
+    result = subprocess.run(
+        [sys.executable, "-m", "ZedScripts.environment.config", "schema"],
+        capture_output=True,
+        text=True,
+        check=True,
+    )
+
+    assert json.loads(result.stdout) == ConfigurationModel.model_json_schema()

zedscripts-1.0.0/src/ZedScripts/__about__.py

@@ -1,4 +0,0 @@
-__version__ = "1.0.0"
-
-if __name__ == "__main__":
-    print(__version__)

zedscripts-1.0.0/src/ZedScripts/__init__.py

@@ -1,38 +0,0 @@
-import os
-import logging
-from pathlib import Path
-
-IS_DEBUG = os.getenv("ZEDSCRIPTS_DEBUG_MODE") == "1"
-
-ZEDSCRIPT_CACHE_DIR = Path.home() / ".zedscripts"
-"""
-Cache directory to hold various information related to ZedScripts.
-"""
-ZEDSCRIPT_CACHE_DIR.mkdir(parents=True, exist_ok=True)
-
-# config files
-CONFIGURATION_FILE_NAME = ".zedscripts.json"
-GLOBAL_CONFIGURATION_FILE = (ZEDSCRIPT_CACHE_DIR / CONFIGURATION_FILE_NAME).resolve()
-
-# setup the logger
-log_file = ZEDSCRIPT_CACHE_DIR / "server.log"
-
-level = logging.DEBUG if IS_DEBUG else logging.INFO
-logging.basicConfig(
-    filename=log_file,
-    level=level,
-    format="%(asctime)s %(levelname)s %(message)s",
-    filemode="w",
-    # force=True,
-)
-
-logging.info("ZedScripts logger initialized. Debug mode: %s", IS_DEBUG)
-
-IDENTIFIER = "ZedScripts"
-SOURCE = IDENTIFIER
-
-SCRIPTS_DATA_MANIFEST = "https://raw.githubusercontent.com/PZ-Wiki-Modding/pz-scripts-data/refs/heads/main/manifest.json"
-SCRIPTS_BLOCKS_DATA_LINK = "https://raw.githubusercontent.com/PZ-Wiki-Modding/pz-scripts-data/refs/tags/{best_tag}/out/scriptsBlocks.json"
-ROOTS_DATA_LINK = "https://raw.githubusercontent.com/PZ-Wiki-Modding/pz-scripts-data/refs/tags/{best_tag}/out/roots.json"
-
-SCRIPTSDOCS_LINK = "https://pz-wiki-modding.github.io/PZ-API-Docs/scripts/"