@ota-meshi/ast-token-store 0.0.0 → 0.2.0

package/README.md

@@ -86,10 +86,18 @@ All methods accept options for filtering, skipping, counting, and including comm
 
 | Method                              | Description                                                  |
 | ----------------------------------- | ------------------------------------------------------------ |
+| `getAllComments()`                  | Gets all comment tokens                                      |
+| `getCommentsInside(nodeOrToken)`    | Gets all comment tokens inside the given node/token          |
 | `getCommentsBefore(nodeOrToken)`    | Gets all comment tokens directly before the given node/token |
 | `getCommentsAfter(nodeOrToken)`     | Gets all comment tokens directly after the given node/token  |
 | `commentsExistBetween(left, right)` | Checks if any comments exist between two nodes               |
 
+#### Spacing Methods
+
+| Method                        | Description                                                     |
+| ----------------------------- | --------------------------------------------------------------- |
+| `isSpaceBetween(left, right)` | Checks if there is whitespace between two non-overlapping nodes |
+
 ### Options
 
 Single token methods (`getFirstToken`, `getLastToken`, etc.) accept skip options:

package/lib/index.d.mts

@@ -46,6 +46,10 @@ declare class TokenStore<Node extends SyntaxElement, Token extends SyntaxElement
    * Gets all tokens, including comments.
    */
   getAllTokens(): (Token | Comment)[];
+  /**
+   * Gets all comments.
+   */
+  getAllComments(): Comment[];
   /**
    * Gets the first token of the given node.
    */
@@ -53,7 +57,7 @@ declare class TokenStore<Node extends SyntaxElement, Token extends SyntaxElement
   /**
    * Gets the first token of the given node with simple options.
    */
-  getFirstToken(node: Node | Token | Comment, options: CursorWithSkipOptionsWithoutFilter): Token | null;
+  getFirstToken(node: Node | Token | Comment, options?: CursorWithSkipOptionsWithoutFilter): Token | null;
   /**
    * Gets the first token of the given node with options.
    */
@@ -81,7 +85,7 @@ declare class TokenStore<Node extends SyntaxElement, Token extends SyntaxElement
   /**
    * Gets the last token of the given node with options.
    */
-  getLastToken(node: Node | Token | Comment, options: CursorWithSkipOptionsWithoutFilter): Token | null;
+  getLastToken(node: Node | Token | Comment, options?: CursorWithSkipOptionsWithoutFilter): Token | null;
   /**
    * Gets the last token of the given node with options.
    */
@@ -222,6 +226,10 @@ declare class TokenStore<Node extends SyntaxElement, Token extends SyntaxElement
    * Gets all of the tokens between two non-overlapping nodes with comment options.
    */
   getTokensBetween<R extends Token | Comment>(left: Node | Token | Comment, right: Node | Token | Comment, options: CursorWithCountOptionsWithComment<Token, Comment, R>): R[];
+  /**
+   * Gets all comment tokens inside the given node or token.
+   */
+  getCommentsInside(nodeOrToken: Node | Token | Comment): Comment[];
   /**
    * Gets all comment tokens directly before the given node or token.
    */
@@ -234,6 +242,10 @@ declare class TokenStore<Node extends SyntaxElement, Token extends SyntaxElement
    * Checks if there are any comment tokens between two non-overlapping nodes.
    */
   commentsExistBetween(left: Node | Token | Comment, right: Node | Token | Comment): boolean;
+  /**
+   * Checks if there is whitespace between two non-overlapping nodes.
+   */
+  isSpaceBetween(left: Node | Token | Comment, right: Node | Token | Comment): boolean;
 }
 //#endregion
 //#region src/index.d.ts

package/lib/index.mjs

@@ -124,7 +124,8 @@ var TokenStore = class {
 			ctx: {
 				isComment: params.isComment,
 				isNotComment: (token) => !params.isComment(token)
-			}
+			},
+			cacheAllComments: null
 		};
 	}
 	/**
@@ -133,6 +134,17 @@ var TokenStore = class {
 	getAllTokens() {
 		return this[PRIVATE].allTokens;
 	}
+	/**
+	* Gets all comments.
+	*/
+	getAllComments() {
+		const { ctx, allTokens, cacheAllComments } = this[PRIVATE];
+		if (cacheAllComments) return cacheAllComments;
+		const result = [];
+		for (const token of allTokens) if (ctx.isComment(token)) result.push(token);
+		this[PRIVATE].cacheAllComments = result;
+		return result;
+	}
 	getFirstToken(node, options) {
 		const { ctx, allTokens, tokenStartToIndex } = this[PRIVATE];
 		const { filter, skip } = normalizeSkipOptions(options, ctx);
@@ -359,6 +371,20 @@ var TokenStore = class {
 		return result;
 	}
 	/**
+	* Gets all comment tokens inside the given node or token.
+	*/
+	getCommentsInside(nodeOrToken) {
+		const { ctx, allTokens, tokenStartToIndex } = this[PRIVATE];
+		const startIndex = getFirstIndex(allTokens, tokenStartToIndex, nodeOrToken.range[0]);
+		const endIndex = getLastIndex(allTokens, tokenStartToIndex, nodeOrToken.range[1]);
+		const result = [];
+		for (let i = startIndex; i <= endIndex && i < allTokens.length; i++) {
+			const token = allTokens[i];
+			if (ctx.isComment(token)) result.push(token);
+		}
+		return result;
+	}
+	/**
 	* Gets all comment tokens directly before the given node or token.
 	*/
 	getCommentsBefore(nodeOrToken) {
@@ -399,12 +425,28 @@ var TokenStore = class {
 		}
 		return false;
 	}
+	/**
+	* Checks if there is whitespace between two non-overlapping nodes.
+	*/
+	isSpaceBetween(left, right) {
+		if (left.range[1] >= right.range[0]) return false;
+		const { allTokens, tokenStartToIndex } = this[PRIVATE];
+		const startIndex = getFirstIndex(allTokens, tokenStartToIndex, left.range[1]);
+		const endIndex = getLastIndex(allTokens, tokenStartToIndex, right.range[0]);
+		let prev = left;
+		for (let i = startIndex; i <= endIndex && i < allTokens.length; i++) {
+			const token = allTokens[i];
+			if (prev.range[1] < token.range[0]) return true;
+			prev = token;
+		}
+		return prev.range[1] < right.range[0];
+	}
 };
 
 //#endregion
 //#region package.json
 var name$1 = "@ota-meshi/ast-token-store";
-var version$1 = "0.0.0";
+var version$1 = "0.2.0";
 
 //#endregion
 //#region src/meta.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ota-meshi/ast-token-store",
-  "version": "0.0.0",
+  "version": "0.2.0",
   "description": "A class library that provides an API similar to ESLint's token store",
   "type": "module",
   "exports": {
@@ -22,15 +22,16 @@
     "lint": "npm run lint:js && npm run lint:ts",
     "lint:js": "eslint .",
     "lint:ts": "npm run tsc",
-    "tsc": "tsc --project tsconfig.build.json",
+    "tsc": "tsc",
     "eslint-fix": "eslint . --fix",
     "test": "npm run mocha -- \"tests/src/**/*.ts\" --reporter=dot --timeout=60000",
     "test:debug": "node --experimental-strip-types --experimental-transform-types ./node_modules/mocha/bin/mocha.js \"tests/src/**/*.ts\" --reporter=dot --timeout=60000",
     "test:cover": "c8 --reporter=lcov --reporter=text npm run test:debug",
     "ts": "node --import=tsx",
     "mocha": "npm run ts -- ./node_modules/mocha/bin/mocha.js",
-    "generate:version": "env-cmd -e version -- npm run update && npm run lint -- --fix",
-    "changeset:version": "env-cmd -e version -- changeset version && npm run generate:version && git add --all",
+    "update": "node --experimental-strip-types --experimental-transform-types ./tools/update.ts",
+    "generate:version": "npm run update && npm run lint -- --fix",
+    "changeset:version": "changeset version && npm run generate:version && git add --all",
     "changeset:publish": "npm run build && changeset publish"
   },
   "repository": {
@@ -73,7 +74,6 @@
     "@types/semver": "^7.5.8",
     "assert": "^2.1.0",
     "c8": "^10.1.3",
-    "env-cmd": "^11.0.0",
     "eslint": "^9.34.0",
     "eslint-compat-utils": "^0.6.4",
     "eslint-config-prettier": "^10.1.1",