Merge pull request #3 from Slackow/dev

Version 0.1.4

Author: Slackow

README.md

@@ -93,24 +93,24 @@ multiple `anon/function`'s take up names like `anon/function_1`, `anon/function_
 
 ex:
 ```
-=== data/main/sources/main.dps ===
+=== data/main/source/main.dps ===
 /function tick [tick]:
     /data modify storage args msg set value "example"
     /execute as @a run function main:func [] with storage args:
         /$say $(msg)
 ```
 outputs
 ```
-=== data/main/functions/tick.mcfunction ===
-# Generated by PackScript 0.1.0
+=== data/main/function/tick.mcfunction ===
+# Generated by PackScript 0.1.4
 data modify storage args msg set value "example"
 execute as @a run function main:func with storage args
 
-=== data/main/functions/func.mcfunction ===
-# Generated by PackScript 0.1.0
+=== data/main/function/func.mcfunction ===
+# Generated by PackScript 0.1.4
 $say $(msg)
 
-=== data/minecraft/tags/functions/tick.json ===
+=== data/minecraft/tags/function/tick.json ===
 {
     "values": [
         "main:tick"
@@ -144,8 +144,8 @@ this is done with Python's builtin JSON library.<br>
 a String or Bytes object will just be written raw to the file, but I do not know what this would be useful for.
 
 ```
-=== data/main/sources/main.dps ===
-create tags/blocks ns:chests -> {
+=== data/main/source/main.dps ===
+create tags/block ns:chests -> {
     "values": [
         "chest",
         "trapped_chest",
@@ -155,7 +155,7 @@ create tags/blocks ns:chests -> {
 ```
 outputs
 ```
-=== data/ns/tags/blocks/chests.json ===
+=== data/ns/tags/block/chests.json ===
 {
     "values": [
         "chest",
@@ -170,7 +170,7 @@ Of course, you do not need to specify a literal dictionary right after.
 def tag(*values):
     return {"values": values}
     
-create tags/blocks chests -> \
+create tags/block chests -> \
     tag('chest', 'trapped_chest', 'ender_chest')
 ```
 
@@ -180,7 +180,7 @@ The capture_lines() function diverts command lines to a list of strings instead
 This is niche, but useful for constructing 'Only One Command's.
 
 ```
-=== data/ooc/sources/main.dps ===
+=== data/ooc/source/main.dps ===
 def only_one_command(definer):
     """ Generates "Only One Command"s given a function that defines commands """
     with capture_lines() as lines:
@@ -203,14 +203,14 @@ def only_one_command(definer):
 ```
 outputs
 ```
-=== data/ooc/functions/ooc.mcfunction ===
-# Generated by PackScript 0.1.0
+=== data/ooc/function/ooc.mcfunction ===
+# Generated by PackScript 0.1.4
 summon falling_block ~ ~1 ~ {BlockState:{Name:redstone_block},Passengers:[{id:falling_block,BlockState:{Name:activator_rail}},{id:command_block_minecart,Command:'gamerule commandBlockOutput false'},{id:command_block_minecart,Command:'say as second lame command'},{id:command_block_minecart,Command:'say third lamer command lol'},{id:command_block_minecart,Command:'tellraw @a "look ma I\'m using quotes \\\\/!"'},{id:command_block_minecart,Command:'tellraw @a[name=!"Slackow"] "say \\"lol\\""'},{id:command_block_minecart,Command:'setblock ~ ~1 ~ command_block{auto:1b,Command:"fill ~ ~ ~ ~ ~-3 ~ air"}'},{id:command_block_minecart,Command:'kill @e[type=command_block_minecart,distance=..1]'}]}
 ```
 ## `ns` String
 The `ns` global variable lets you access the namespace of the dps file you are in as a string. note that `ns` is the namespace of the *source* file, not the function you are in.
 ```
-=== data/example_pack/sources/example.dps ===
+=== data/example_pack/source/example.dps ===
 /function say_something:
    /say something!
 /function example:
@@ -219,11 +219,11 @@ The `ns` global variable lets you access the namespace of the dps file you are i
 ```
 outputs
 ```
-=== data/example_pack/functions/say_something.mcfunction ===
-# Generated by PackScript 0.1.2
+=== data/example_pack/function/say_something.mcfunction ===
+# Generated by PackScript 0.1.4
 say something!
-=== data/example_pack/functions/example.mcfunction ===
-# Generated by PackScript 0.1.2
+=== data/example_pack/function/example.mcfunction ===
+# Generated by PackScript 0.1.4
 function example_pack:say_something
 ```
 
@@ -281,12 +281,14 @@ add lines or create new files.
 # FunctionPackScript
 Most files shown so far have been `.dps` files, standing for DataPackScript,
 but there's also FunctionPackScript with `.fps` files. These are contained in the root of the input directory instead
-of under a proper datapack with a namespace underneath sources, these are meant for generating independent
+of under a proper datapack with a namespace underneath `source`[<sup>[1]</sup>](#f1), these are meant for generating independent
 function files easily, usually those with repetitive lines. In these files you cannot use create statements, but you can generate
 additional functions. All the generated function files
 will have their namespace ignored and be generated in the same directory
 as the main generated function.
 
+<span id="f1">[1]</span>: In older versions of minecraft (pre 1.21) this folder is `sources` instead. PackScript will automatically figure out which folder name to use based on your pack_format value in your `pack.mcmeta`. 
+
 # The CLI
 This tool has two main actions it can perform: compiling packs and initializing templates.
 - `python3 packscript.py c` (you can also use compile or comp)
@@ -300,7 +302,7 @@ More actions:
 ## Compile Options
 - `-i/--input <dir>` specify the directory of the pack you are compiling defaults to current dir.
 - `-o/--output <dir/zip>` specify the output of the pack (can output zip too) defaults to `output`
-- `-s/--sources` output the source files into the resulting pack, by default they get deleted
+- `-s/--source` output the source files into the resulting pack, by default they get deleted
 - `-v/--verbose` print out all the generated Python code with line numbers. Very good for debugging.
 
 ## Init Options
@@ -350,6 +352,6 @@ In this case it's because there's a letter before the command line, making it ge
 4. **Create A Datapack.** Run `python3 packscript.py init` in order to create a datapack with
    PackScript. You'll be prompted for information about the datapack.
    You should have a new datapack, you can put files in there as usual for them to
-   be outputted, files in `<pack>/data/*/sources/*.dps` and `<pack>/*.fps` will be interpreted as PackScript
+   be outputted, files in `<pack>/data/*/source/*.dps` and `<pack>/*.fps` will be interpreted as PackScript
    on compilation. By default, you will find a main.dps file there.
 5. **Compile Datapack.** To compile, run `python3 packscript.py compile -i <datapack directory> -o <output>`

packscript.py

@@ -6,8 +6,8 @@
 import shutil
 import sys
 
-__version__ = '0.1.3'
-latest_mc_version = '1.20.6'
+__version__ = '0.1.4'
+latest_mc_version = '1.21'
 
 # # # # # # # # # # # # # # # # # # # # # #
 # Please set this to your username if you are modifying this script
@@ -20,6 +20,7 @@ def ver(base_version, start, end, *, pf):
 
 
 pack_formats = {
+    '1.21': 48,
     '1.20.6': 41, '1.20.5': 41,
     '1.20.4': 26, '1.20.3': 26, '1.20.2': 18,
     '1.20.1': 15, '1.20': 15, '1.19.4': 12,
@@ -186,11 +187,15 @@ def capture_lines():
     return globals
 
 
-def get_header():
+def get_header() -> str:
     return f'# Generated by PackScript {__version__}{modified_by and f" modified by: {modified_by}"}\n'
 
 
-def comp(*, input, output, verbose, sources, **_):
+def get_folder(path: str, pf: int) -> str:
+    return path if pf >= 45 else path + 's'
+
+
+def comp(*, input: str, output: str, verbose: bool, source: bool, **_):
     try:
         namespaces = os.listdir(os.path.join(input, 'data'))
 
@@ -213,21 +218,32 @@ def comp(*, input, output, verbose, sources, **_):
                                 os.path.join(output_folder, 'pack.png'))
             else:
                 raise FileNotFoundError('need data folder and pack.mcmeta')
+        # Thanks, boq.
+        with open(os.path.join(input, 'pack.mcmeta')) as f:
+            pack_meta = json.load(f)
+            if not pack_meta or not isinstance(pack_meta.get('pack'), dict):
+                raise ValueError('Invalid pack.mcmeta file')
+            pack_format = pack_meta.get('pack').get('pack_format')
+            if not isinstance(pack_format, int):
+                raise ValueError('Invalid pack.mcmeta file')
 
         function_tags: dict[str, list[str]] = {}
         other: dict[str, dict[str, object]] = {}
         for namespace in sorted(namespaces):
             try:
-                if not sources:
-                    shutil.rmtree(os.path.join(output_folder, 'data', namespace, 'sources'))
+                if not source:
+                    shutil.rmtree(os.path.join(output_folder, 'data', namespace, get_folder('source', pack_format)))
             except IOError:
                 continue
             func_files: dict[str, list[str]] = {'': []}
             func_stack: list[str] = ['']
             capturer_stack: list[str] = []
 
             globals = build_globals(func_stack, capturer_stack, func_files, other, namespace, function_tags)
-            working_folder = os.path.join(input, f'data/{namespace}/sources')
+            working_folder = os.path.join(input, f'data/{namespace}/{get_folder('source', pack_format)}')
+            if (not get_folder('source', pack_format).endswith('s') and
+                    os.path.exists(os.path.join(working_folder, f'data/{namespace}/sources'))):
+                raise ValueError('Legacy "sources" folder detected! Rename your folders to be singular!')
             try:
                 for filename in os.listdir(working_folder):
                     if filename.endswith(f'.{DATA_EXT}'):
@@ -238,7 +254,8 @@ def comp(*, input, output, verbose, sources, **_):
             func_files.pop('')
             # Iterate through generated functions
             for name, content in func_files.items():
-                mcfunction_path = os.path.join(output_folder, f'data/{name.replace(":", "/functions/")}.mcfunction')
+                func_dir = get_folder('function', pack_format)
+                mcfunction_path = os.path.join(output_folder, f'data/{name.replace(":", f"/{func_dir}/")}.mcfunction')
                 if not content:
                     continue
                 try:
@@ -250,7 +267,7 @@ def comp(*, input, output, verbose, sources, **_):
 
             # <editor-fold defaultstate="collapsed" desc="Move function tags into 'other' dictionary">
 
-            other.setdefault('tags/functions', {}).update(
+            other.setdefault(f'tags/{get_folder("function", pack_format)}', {}).update(
                 {tag: {'values': func_names} for tag, func_names in function_tags.items()})
 
             # </editor-fold>
@@ -329,12 +346,12 @@ def init_template(*, name: str, description: str, pack_format: int, output: str,
     description = description or input(f'Description (Datapack {name!r}{v}): ') or \
         f'Datapack {name!r}{v}'
     output = output or input(f'Output Directory ({name.replace(" ", "_")}): ') or name.replace(' ', '_')
-    sources = os.path.join(output, f'data/{namespace}/sources')
+    source = os.path.join(output, f'data/{namespace}/{get_folder("source", pf=pack_format)}')
     try:
-        os.makedirs(sources)
+        os.makedirs(source)
     except FileExistsError:
         pass
-    with open(os.path.join(os.path.join(sources, f'main.{DATA_EXT}')), 'w') as w:
+    with open(os.path.join(os.path.join(source, f'main.{DATA_EXT}')), 'w') as w:
         import inspect
         w.write(inspect.cleandoc(f'''
             /function tick [tick]:
@@ -431,7 +448,7 @@ def main():
     parser_compile.add_argument('-i', '--input', type=str, help='Input directory', default='.')
     parser_compile.add_argument('-v', '--verbose', help='Print generated Python code.', default=False,
                                 action='store_true')
-    parser_compile.add_argument('-S', '--sources', help='Include source files in output.', default=False,
+    parser_compile.add_argument('-S', '--source', help='Include source files in output.', default=False,
                                 action='store_true')
 
     # "init" command