v0breaking: converted classes to plain object

- The nodes are no longer classes but simple objects. Readonly has been removed
from all the properties of their interfaces and the parser result is not longer
"sealed". They should still not be mutated, but if you really want to you can.

- Nodes no longer have a parent property to avoid circular references. Instead
you can generate a parents map from a parser result to use getParent on if needed.

- To check a node or token is of a certain type, they now all have a `type` property.

- To check if an object is a node or a token,
you can use the new `isNode` and `isToken` utility functions.

- The non-node normalized Condition and Expression classes
are now the NormalizedCondition and NormalizedExpression interfaces.
Their object will return false if passed to isNode/Token, but they
have an AST_TYPE to be able to tell them apart.

- All node creation functions have been moved to /ast/*, /ast/classes has been removed.

- Several internal helpers have been moved, there is now an internals export
(just in case), it's not really meant to be used.

.gitignore

@@ -10,3 +10,4 @@ coverage
 dist
 !flake.lock
 .direnv
+todo.md

README.md

@@ -34,7 +34,7 @@ pnpm install @witchcraft/expressit
 - **Other Useful Utility Functions:**
 	- `extractTokens`, `getCursorInfo`, `getOppositeDelimiter`, `getSurroundingErrors` - useful for adding custom syntax highlighting.
 	- `prettyAst` - pretty prints a compact version of the ast for debugging
-	- other minor helpers - `isDelimiter`, `isQuote`, etc.
+	- other minor utilities - `isDelimiter`, `isQuote`, etc.
 - **Pre-Configured Parsers** - Includes a pre-configured boolean parser (intended for parsing shortcut contexts in a similar way to VS Code).
 - **Lots of Docs and Tests**
 
@@ -43,7 +43,6 @@ pnpm install @witchcraft/expressit
 ```ts
 // while you can import from "@witchcraft/expressit", if using something like vite, it's recommended you do not use barrel imports.
 import { Parser } from "@witchcraft/expressit/Parser.js"
-import { ErrorToken } from "@witchcraft/expressit/classes/ErrorToken.js"
 
 const parser = new Parser({/* opts */})
 	const context = {
@@ -57,8 +56,11 @@ const parser = new Parser({/* opts */})
 
 	const ast = parser.parse(input)
 
-	if (ast instanceof ErrorToken || !ast.valid) {
+	if (!ast.valid) {
 		// ...show regular errors (no input, missing tokens, etc)
+		if (ast.isToken) {
+			// empty input
+		}
 	} else {
 		// validation can be controlled by parser options
 		const errors = parser.validate(ast)
@@ -67,7 +69,7 @@ const parser = new Parser({/* opts */})
 
 	// ON AUTOCOMPLETE
 	const suggestions = parser.autosuggest(input, ast, cursor)
-	const completions = parser.autocomplete(suggestions, {
+	const completions = parser.autocomplete(ast,suggestions, {
 		// known possible suggestions
 		variables: ["c", "d", "e"],
 		// can also be values, prefixes, keywords, properties, etc

demo/src/main.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /* eslint-disable no-eval */
 
 import "./style.css"
@@ -141,7 +142,7 @@ function onKeyboardInput(e, force = false) {
 		els.suggestion.innerHTML = str
 		els.pos.innerHTML = ` (${index})`
 
-		const autocompletions = parser.autocomplete(suggestions, {
+		const autocompletions = parser.autocomplete(ast,suggestions, {
 			variables: ["variable", "variable requires quoting", "variable requires escaping \""],
 			prefixes: ["prefix", "prefix requires quoting", "prefix requires escaping \""],
 			properties: ["property", "property requires quoting", "property requires escaping \""],

docs-src/DEVELOPMENT.md

@@ -14,16 +14,13 @@ The only exception is the handlers for the parser rules. These are internal, sho
 
 ```text
 src
- ┣ ast
- ┃ ┣ builders - used to quickly build ast classes for testing
- ┃ ┃ - instances returned are unsealed, i.e. their parents are not assigned
- ┃ ┣ classes - the actual ast node classes
- ┃ ┣ handlers.ts - used inside grammar/ParserBase.ts to handle the creation of tokens / ast node classes
+ ┣ ast - contains the base ast node creators 
+ ┃ ┣ builders - used to quickly build ast nodes for testing
+ ┃ ┣ handlers.ts - used inside grammar/ParserBase.ts to handle the creation of tokens / ast nodes 
  ┣ examples - contains fully implemented parser examples
- ┣ helpers
- ┃ ┣ general - ...various internal helper functions not related to parsing + default functions for the default parser options
- ┃ ┣ parser - ...various internal helper functions used before/during parsing
- ┃ ┗ errors.ts - the main error handling class (error types are defined in types/errors)
+ ┣ defaults - contains the default implementations of some parser options
+ ┣ internal - various internal helper functions used before/during parsing
+ ┃ ┗ ExpressitError.ts - the main error handling class (error types are defined in types/errors)
  ┣ types - all the types and enums are stored here in their respective categories
  ┣ utils - exported utility functions
  ┣ global.d.ts - additional global types

package.json

@@ -19,13 +19,13 @@
 			"types": "./dist/ast/*",
 			"import": "./dist/ast/*"
 		},
-		"./helpers": {
-			"types": "./dist/helpers/index.d.ts",
-			"import": "./dist/helpers/index.js"
+		"./internal": {
+			"types": "./dist/internal/index.d.ts",
+			"import": "./dist/internal/index.js"
 		},
-		"./helpers/*": {
-			"types": "./dist/helpers/*",
-			"import": "./dist/helpers/*"
+		"./internal/*": {
+			"types": "./dist/internal/*",
+			"import": "./dist/internal/*"
 		},
 		"./methods": {
 			"types": "./dist/methods/index.d.ts",

src/Lexer.ts

@@ -1,8 +1,8 @@
 import { isBlank } from "@alanscodelog/utils/isBlank.js"
 import { pushIfNotIn } from "@alanscodelog/utils/pushIfNotIn.js"
 
-import { checkParserOpts } from "./helpers/parser/checkParserOpts.js"
-import { parseParserOptions } from "./helpers/parser/parseParserOptions.js"
+import { checkParserOpts } from "./internal/checkParserOpts.js"
+import { parseParserOptions } from "./internal/parseParserOptions.js"
 import type { FullParserOptions } from "./types/index.js"
 
 const regexFlags = /^[a-zA-Z]+/