Add ParseBehavior to parser settings (#393)

* initial commit

* incrementing version

* adjusting name to be explicit

* Update src/powerquery-parser/parser/parser/parserUtils.ts

Co-authored-by: Copilot <[email protected]>

* ran 'npm audit fix'

* fixing lint issue from copilot

* removing ':'

* about to work on IdentifierUtilsOptions

* perhaps complete

* Revert "perhaps complete"

This reverts commit aef0085.

* Revert "about to work on IdentifierUtilsOptions"

This reverts commit 6fdbe2f.

* removing unneeded try/catch

* added tryParseHelper

* simplified further

---------

Co-authored-by: Copilot <[email protected]>

Author: JordanBoltonMN

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/powerquery-parser",
-    "version": "0.16.1",
+    "version": "0.17.0",
     "description": "A parser for the Power Query/M formula language.",
     "author": "Microsoft",
     "license": "MIT",

package.json

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export enum ParseBehavior {
+    ParseEitherExpressionOrSection = "ParseEitherExpressionOrSection",
+    ParseExpression = "ParseExpression",
+    ParseSection = "ParseSection",
+}

src/powerquery-parser/parser/parseBehavior.ts

@@ -4,12 +4,14 @@
 import { Ast } from "../language";
 import { CommonSettings } from "../common";
 import { LexerSnapshot } from "../lexer";
+import { ParseBehavior } from "./parseBehavior";
 import { Parser } from "./parser";
 import { ParseState } from "./parseState";
 
 export interface ParseSettings extends CommonSettings {
+    readonly parseBehavior: ParseBehavior;
     readonly parser: Parser;
-    readonly newParseState: (lexerSnapshot: LexerSnapshot, overrides: Partial<ParseState> | undefined) => ParseState;
+    readonly newParseState: (lexerSnapshot: LexerSnapshot, overrides?: Partial<ParseState>) => ParseState;
     readonly parserEntryPoint:
         | ((state: ParseState, parser: Parser, correlationId: number | undefined) => Promise<Ast.TNode>)
         | undefined;

src/powerquery-parser/parser/parseSettings.ts

@@ -4,6 +4,7 @@
 import { Disambiguation } from "../disambiguation";
 import { ICancellationToken } from "../../common";
 import { LexerSnapshot } from "../../lexer";
+import { ParseBehavior } from "../parseBehavior";
 import { ParseContext } from "..";
 import { Token } from "../../language";
 import { TraceManager } from "../../common/trace";
@@ -13,6 +14,7 @@ export interface ParseState {
     readonly disambiguationBehavior: Disambiguation.DismabiguationBehavior;
     readonly lexerSnapshot: LexerSnapshot;
     readonly locale: string;
+    readonly parseBehavior: ParseBehavior;
     readonly traceManager: TraceManager;
     contextState: ParseContext.State;
     currentContextNode: ParseContext.TNode | undefined;

src/powerquery-parser/parser/parseState/parseState.ts

@@ -8,10 +8,11 @@ import { NoOpTraceManagerInstance, Trace } from "../../common/trace";
 import { DefaultLocale } from "../../localization";
 import { Disambiguation } from "../disambiguation";
 import { LexerSnapshot } from "../../lexer";
+import { ParseBehavior } from "../parseBehavior";
 import { ParseState } from "./parseState";
 import { SequenceKind } from "../error";
 
-export function newState(lexerSnapshot: LexerSnapshot, overrides: Partial<ParseState> | undefined): ParseState {
+export function newState(lexerSnapshot: LexerSnapshot, overrides?: Partial<ParseState>): ParseState {
     const tokenIndex: number = overrides?.tokenIndex ?? 0;
     const currentToken: Token.Token | undefined = lexerSnapshot.tokens[tokenIndex];
     const currentTokenKind: Token.TokenKind | undefined = currentToken?.kind;
@@ -30,6 +31,7 @@ export function newState(lexerSnapshot: LexerSnapshot, overrides: Partial<ParseS
 
     return {
         ...overrides,
+        parseBehavior: overrides?.parseBehavior ?? ParseBehavior.ParseEitherExpressionOrSection,
         disambiguationBehavior: overrides?.disambiguationBehavior ?? Disambiguation.DismabiguationBehavior.Thorough,
         lexerSnapshot,
         locale: overrides?.locale ?? DefaultLocale,

src/powerquery-parser/parser/parseState/parseStateUtils.ts

@@ -50,13 +50,6 @@ export interface Parser {
         correlationId: number | undefined,
     ) => Ast.IdentifierExpression;
 
-    // 12.2.1 Documents
-    readonly readDocument: (
-        state: ParseState,
-        parser: Parser,
-        correlationId: number | undefined,
-    ) => Promise<Ast.TDocument>;
-
     // 12.2.2 Section Documents
     readonly readSectionDocument: (
         state: ParseState,