Undo comment visitor logic

Author: TwitchBronBron

docs/plugins.md

@@ -558,8 +558,7 @@ This plugin will search through every LiteralExpression in the entire project, a
 
 Another common use case is to remove print statements and comments. Here's a plugin to do that:
 
-Note: Comments are not regular nodes in the AST, so to visit comments, there is an additional requirement to specify
-that the AST walk should also `visitComments`. In the case of comments, the first argument of the visitor function is a `Token`, not an `AstNode`.
+Note: Comments are not regular nodes in the AST. They're considered "trivia". To access them, you need to ask each AstNode for its trivia. to help with this, we've included the `AstNode` visitor method. Here's how you'd do that:
 
 ```typescript
 import { isBrsFile, createVisitor, WalkMode, BeforeFileTranspileEvent, CompilerPlugin } from 'brighterscript';
@@ -575,9 +574,15 @@ export default function plugin() {
                         //replace `PrintStatement` transpilation with empty string
                         event.editor.overrideTranspileResult(statement, '');
                     },
-                    CommentToken: (_token, _parent, owner, key) => {
-                        //remove comment tokens
-                        event.editor.removeProperty(owner, key);
+                    AstNode: (node: AstNode, _parent, owner, key) => {
+                        const trivia = node.getLeadingTrivia();
+                        for(let i = 0; i < trivia.length; i++) {
+                            let triviaItem = trivia[i].
+                            if (triviaItem.kind === TokenKind.Comment) {
+                                //remove comment tokens
+                                event.editor.removeProperty(trivia, i);
+                            }
+                        }
                     }
                 }), {
                     walkMode: WalkMode.visitStatements | WalkMode.visitComments

src/astUtils/visitors.spec.ts

@@ -1164,76 +1164,5 @@ describe('astUtils visitors', () => {
                 'VariableExpression'
             ]);
         });
-
-        describe('visitComments', () => {
-
-            it('visits a comment when walkmode includes visitComments', () => {
-                const items = [];
-                const { ast } = Parser.parse(`
-                    '1
-                    sub main()
-                      '2
-                      '3
-                      print "hello"
-                    end sub
-                    '4
-                `);
-                ast.walk(createVisitor({
-                    CommentToken: (comment, parent, owner, key) => {
-                        items.push(comment.text);
-                    }
-                }), {
-                    // eslint-disable-next-line no-bitwise
-                    walkMode: WalkMode.visitAllRecursive | WalkMode.visitComments
-                });
-                expect(items).to.be.length(4);
-            });
-
-            it('has access to the next statement', () => {
-                const { ast } = Parser.parse(`
-                    sub main()
-                      'comment
-                      print "hello"
-                    end sub
-                `);
-                ast.walk(createVisitor({
-                    CommentToken: (comment, parent, owner, key) => {
-                        expect(comment.text).to.eq('\'comment');
-                        expect(isPrintStatement(parent)).to.true;
-                        expect(parent.getLeadingTrivia()).to.eq(owner);
-                        expect(key).to.eq(2); //0: newline, 1: whitespace, 2: COMMENT, 3: newline, 4:whitespace
-                    }
-                }), {
-                    // eslint-disable-next-line no-bitwise
-                    walkMode: WalkMode.visitAllRecursive | WalkMode.visitComments
-                });
-            });
-
-            it('can change the value of teh comment', () => {
-                const { ast } = Parser.parse(`
-                    sub main()
-                      'comment
-                      print "hello"
-                    end sub
-                `);
-                ast.walk(createVisitor({
-                    CommentToken: (comment, parent, owner, key) => {
-                        return createToken(TokenKind.Comment, 'changed');
-                    }
-                }), {
-                    // eslint-disable-next-line no-bitwise
-                    walkMode: WalkMode.visitAllRecursive | WalkMode.visitComments
-                });
-                ast.walk(createVisitor({
-                    CommentToken: (comment, parent, owner, key) => {
-                        expect(comment.text).to.eq('changed');
-                    }
-                }), {
-                    // eslint-disable-next-line no-bitwise
-                    walkMode: WalkMode.visitAllRecursive | WalkMode.visitComments
-                });
-            });
-
-        });
     });
 });

src/astUtils/visitors.ts

@@ -5,9 +5,6 @@ import type { AALiteralExpression, AAMemberExpression, AnnotationExpression, Arr
 import { isExpression, isStatement } from './reflection';
 import type { Editor } from './Editor';
 import type { Statement, Expression, AstNode } from '../parser/AstNode';
-import { TokenKind } from '../lexer/TokenKind';
-import { isToken, type Token } from '../lexer/Token';
-
 
 /**
  * Walks the statements of a block and descendent sub-blocks, and allow replacing statements
@@ -24,8 +21,6 @@ export function walkStatements(
 }
 
 export type WalkVisitor = <T = AstNode>(node: AstNode, parent?: AstNode, owner?: any, key?: any) => void | T;
-export type WalkTokenVisitor = <K = TokenKind>(token: Token & { kind: K }, parent?: AstNode, owner?: any, key?: any) => void | (Token & { kind: K });
-
 
 /**
  * A helper function for Statement and Expression `walkAll` calls.
@@ -47,25 +42,6 @@ export function walk<T>(owner: T, key: keyof T, visitor: WalkVisitor, options: W
 
     //notify the visitor of this element
     if (element.visitMode & options.walkMode) {
-
-        if (options.walkMode & WalkMode.visitComments) {
-            const leadingTrivia = element.getLeadingTrivia();
-            for (let i = 0; i < leadingTrivia.length; i++) {
-                const trivia = leadingTrivia[i];
-                if (trivia.kind === TokenKind.Comment) {
-                    const result = (visitor as unknown as WalkTokenVisitor)?.(trivia, element as any, leadingTrivia, i);
-                    if (result && isToken(result)) {
-                        if (options.editor) {
-                            options.editor.setProperty(leadingTrivia, i, result as any);
-                        } else {
-                            leadingTrivia[i] = result;
-
-                        }
-                    }
-                }
-            }
-        }
-
         const result = visitor?.(element, element.parent as any, owner, key);
 
         //replace the value on the parent if the visitor returned a Statement or Expression (this is how visitors can edit AST)
@@ -193,14 +169,9 @@ export function createVisitor(
         RegexLiteralExpression?: (expression: RegexLiteralExpression, parent?: AstNode, owner?: any, key?: any) => Expression | void;
         TypeExpression?: (expression: TypeExpression, parent?: AstNode, owner?: any, key?: any) => Expression | void;
         TypecastExpression?: (expression: TypecastExpression, parent?: AstNode, owner?: any, key?: any) => Expression | void;
-        //Tokens
-        CommentToken?: (token: Token & { kind: TokenKind.Comment }, parent?: AstNode, owner?: any, key?: any) => Token & { kind: TokenKind.Comment } | void;
     }
 ) {
-    return <WalkVisitor>((statement: Statement | Token, parent?: Statement, owner?: any, key?: any): Statement | void => {
-        if (isToken(statement)) {
-            return visitor[statement.kind + 'Token']?.(statement, parent, owner, key);
-        }
+    return <WalkVisitor>((statement: Statement, parent?: Statement, owner?: any, key?: any): Statement | void => {
         return visitor[statement.constructor.name]?.(statement, parent, owner, key);
     });
 }
@@ -266,11 +237,7 @@ export enum InternalWalkMode {
     /**
      * If child function expressions are encountered, this will allow the walker to step into them.
      */
-    recurseChildFunctions = 16,
-    /**
-     * If a visited node has comments in its leadingTrivia, visit those comments
-     */
-    visitComments = 32
+    recurseChildFunctions = 16
 }
 
 /* eslint-disable @typescript-eslint/prefer-literal-enum-member */
@@ -315,9 +282,5 @@ export enum WalkMode {
     /**
      * Visit all descendent statements and expressions, and DOES step into child functions
      */
-    visitAllRecursive = InternalWalkMode.walkStatements | InternalWalkMode.visitStatements | InternalWalkMode.walkExpressions | InternalWalkMode.visitExpressions | InternalWalkMode.recurseChildFunctions,
-    /**
-     * Visit comment tokens in leading trivia
-     */
-    visitComments = InternalWalkMode.visitComments
+    visitAllRecursive = InternalWalkMode.walkStatements | InternalWalkMode.visitStatements | InternalWalkMode.walkExpressions | InternalWalkMode.visitExpressions | InternalWalkMode.recurseChildFunctions
 }