Cleanup

Author: PaperPrototype

TODO.md

@@ -1,19 +1,20 @@
 Working document of notes/tasks for trying to figure out how to correctly add decorators to AssemblyScript. Will be delete once the PR is complete.
 
-
-- [ ] Ask claude to explain how the AssemblyScript parser works and try to add a garbage throwaway feature myself manually for learning purposes (eg. `mut` keyword for syntax like `mut myVariable = 10`).
-
-- [ ] After implementing re-read all the stuff dcode and Max have been explaining and try to better understand it
-
-- [ ] Need to add a transform hook for valdiating after parse but before compiliation.
-
-- [ ] Need to add a test case for having a transform validate decorators.
-
 NOTES:
 - AST can be extended without breaking changes, this is perfectly fine and anything that is added will just be ignored by the compiler but at least transformer plugins can then make use of it. No need to validate and throw errors unless it is an AST parse error.
     - Need to add a transformer hook so transformers can add their own validation. This way AssemblyScript can delegate validation to transformers instead of having to handle it internally, which doesn't make sense because AS shouldn't be in charge of worring about that in the first place.
 
 - "Transformer" refers the to transformers in /tests/transform
 
 - Rather than have a method validate the decorators, they should just be part of the AST. Once the AST can directly handle the decorators then validating decorators syntax will happen automatically. This also means we need actual AST nodes in ast.ts for the different parts of decorators rather than just inlining the decorators.
-- Correction to the above. The method validation was only 1 part of the problem, the compiler of assemblyscript is for outputting WASM binaries not validating valid AST syntax. The compiler.ts will not need to be touched AT ALL for this PR.
+- Correction to the above. The method validation was only 1 part of the problem, the compiler of assemblyscript is for outputting WASM binaries not validating valid AST syntax. The compiler.ts will not need to be touched AT ALL for this PR.
+
+TODO:
+<!-- 
+- [ ] Ask claude to explain how the AssemblyScript parser works and try to add a garbage throwaway feature myself manually for learning purposes (eg. `mut` keyword for syntax like `mut myVariable = 10`).
+
+- [ ] After implementing re-read all the stuff dcode and Max have been explaining and try to better understand it -->
+
+- [ ] Need to add a transform hook for valdiating after parse but before compiliation.
+
+- [ ] Need to add a test case for having a transform validate decorators.

cli/index.d.ts

@@ -273,6 +273,11 @@ export abstract class Transform {
   /** Lists all files in a directory. */
   listFiles(dirname: string, baseDir: string): (string[] | null) | Promise<string[] | null>;
 
+  /** Called after program initialization, before WASM compilation. Transformers should use
+   *  this hook to perform custom validation of AST constructs such as parameter decorators
+   *  and emit their own diagnostics. Decorators remain in the AST unchanged. */
+  beforeCompile?(program: Program): void | Promise<void>;
+
   /** Called when parsing is complete, before a program is instantiated from the AST. */
   afterParse?(parser: Parser): void | Promise<void>;
 

src/compiler.ts

@@ -536,7 +536,8 @@ export class Compiler extends DiagnosticEmitter {
 
     // initialize lookup maps, built-ins, imports, exports, etc.
     this.program.initialize();
-    
+
+
     // Binaryen treats all function references as being leaked to the outside world when
     // the module isn't marked as closed-world (see WebAssembly/binaryen#7135). Therefore,
     // we should mark the module as closed-world when we're definitely sure it is.

src/program.ts

@@ -462,8 +462,6 @@ export class Program extends DiagnosticEmitter {
   nextSignatureId: i32 = 0;
   /** An indicator if the program has been initialized. */
   initialized: bool = false;
-  /** Indicates whether the one-shot post-transform parameter decorator validation has run. */
-  parameterDecoratorsValidated: bool = false;
 
   // Lookup maps
 

tests/compiler/parameter-decorators.json

@@ -1,5 +1,5 @@
 // Example transform proving that preserved parameter decorators can be stripped
-// during afterInitialize before compilation rejects them.
+// during afterInitialize, since the compiler otherwise ignores them.
 console.log("CommonJS parameter decorator removal transform loaded");
 
 exports.afterInitialize = (program) => {

tests/compiler/parameter-decorators.ts

@@ -1,5 +1,5 @@
 // Example transform proving that preserved parameter decorators can be stripped
-// during afterInitialize before compilation rejects them.
+// during afterInitialize, since the compiler otherwise ignores them.
 console.log("Parameter decorator removal transform loaded");
 
 import type { Program } from "assemblyscript";