TypeMap (#32)

* Update dependencies

* Add the typemap feature

* 2.1.0

Author: BenBaryoPX

README.md

@@ -41,6 +41,7 @@ npm install
 - Tracks scope and connects each declaration to its references.  
   See [eslint-scope](https://github.com/eslint/eslint-scope) for more info on the scopes used.
 - Adds a unique id to each node to simplify tracking and understanding relations between nodes.
+- Maps the types to the nodes for easier access.
 - <u>Arborist</u> - marks nodes for replacement or deletion and applies all changes in a single iteration over the tree.
 
 ### flAST Data Structure

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "flast",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "Flatten JS AST",
   "main": "src/index.js",
   "type": "module",
@@ -27,12 +27,12 @@
   "homepage": "https://github.com/PerimeterX/flast#readme",
   "dependencies": {
     "escodegen": "npm:@javascript-obfuscator/escodegen",
-    "eslint-scope": "^8.1.0",
+    "eslint-scope": "^8.2.0",
     "espree": "^10.3.0",
     "estraverse": "^5.3.0"
   },
   "devDependencies": {
-    "eslint": "^9.12.0",
+    "eslint": "^9.14.0",
     "husky": "^9.1.6"
   }
 }

package.json

@@ -19,7 +19,7 @@ function parseCode(inputCode, opts = {}) {
 
 const excludedParentKeys = [
 	'type', 'start', 'end', 'range', 'sourceType', 'comments', 'srcClosure', 'nodeId',
-	'childNodes', 'parentNode', 'parentKey', 'scope',
+	'childNodes', 'parentNode', 'parentKey', 'scope', 'typeMap', 'lineage', 'allScopes',
 ];
 
 /**
@@ -123,6 +123,7 @@ function extractNodesFromRoot(rootNode, opts) {
 	opts = { ...generateFlatASTDefaultOptions, ...opts };
 	const tree = [];
 	let nodeId = 0;
+	const typeMap = {};
 
 	// noinspection JSUnusedGlobalSymbols
 	estraverse.traverse(rootNode, {
@@ -133,6 +134,8 @@ function extractNodesFromRoot(rootNode, opts) {
 		enter(node, parentNode) {
 			tree.push(node);
 			node.nodeId = nodeId++;
+			if (!typeMap[node.type]) typeMap[node.type] = [node];
+			else typeMap[node.type].push(node);
 			node.childNodes = [];
 			node.parentNode = parentNode;
 			node.parentKey = parentNode ? getParentKey(node) : '';
@@ -146,6 +149,7 @@ function extractNodesFromRoot(rootNode, opts) {
 			});
 		}
 	});
+	if (tree?.length) tree[0].typeMap = typeMap;
 	return tree;
 }
 

src/flast.js

@@ -73,6 +73,7 @@ import {Scope} from 'eslint-scope';
  * @property {ASTNode} [test]
  * @property {ASTNode} [tokens]
  * @property {Object[]} [trailingComments]
+ * @property {Object} [typeMap]
  * @property {ASTNode} [update]
  * @property {ASTNode|string|number|boolean} [value]
  */

src/types.js

@@ -55,4 +55,22 @@ describe('Parsing tests', () => {
 		const result = generateCode(ast[0]);
 		assert.strictEqual(result, expected);
 	});
+	it(`Verify the type map is generated accurately`, () => {
+		const code = `class a {
+  static b = 1;
+  #c = 2;
+}`;
+		const ast = generateFlatAST(code);
+		const expected = {
+			Program: [ast[0]],
+			ClassDeclaration: [ast[1]],
+			Identifier: [ast[2], ast[5]],
+			ClassBody: [ast[3]],
+			PropertyDefinition: [ast[4], ast[7]],
+			Literal: [ast[6], ast[9]],
+			PrivateIdentifier: [ast[8]],
+		};
+		const result = ast[0].typeMap;
+		assert.deepEqual(result, expected);
+	});
 });