feat: Add initial *-ast-analyze packages (#115)

Author: xeho91

.changeset/flat-parrots-battle.md

@@ -0,0 +1,5 @@
+---
+"svelte-ast-print": minor
+---
+
+feat: Use `svelte-ast-analyze` as dependency

.changeset/happy-dingos-speak.md

@@ -0,0 +1,5 @@
+---
+"svelte-ast-analyze": minor
+---
+
+feat: Add initial type-guards and schemas

.changeset/nervous-grapes-grow.md

@@ -3,16 +3,31 @@
           - any-glob-to-any-file:
                 - ".github/workflows/**"
 
+"pkg:js-ast-analyze":
+    - changed-files:
+          - any-glob-to-any-file:
+                - "pkgs/js-ast-analyze/**"
+
 "pkg:js-ast-build":
     - changed-files:
           - any-glob-to-any-file:
                 - "pkgs/js-ast-build/**"
 
+"pkg:ts-ast-analyze":
+    - changed-files:
+          - any-glob-to-any-file:
+                - "pkgs/ts-ast-analyze/**"
+
 "pkg:ts-ast-build":
     - changed-files:
           - any-glob-to-any-file:
                 - "pkgs/ts-ast-build/**"
 
+"pkg:svelte-ast-analyze":
+    - changed-files:
+          - any-glob-to-any-file:
+                - "pkgs/svelte-ast-analyze/**"
+
 "pkg:svelte-ast-build":
     - changed-files:
           - any-glob-to-any-file:
@@ -22,3 +37,8 @@
     - changed-files:
           - any-glob-to-any-file:
                 - "pkgs/svelte-ast-print/**"
+
+"tests":
+    - changed-files:
+          - any-glob-to-any-file:
+                - "**/*.test.ts"

.changeset/wicked-rockets-fold.md

@@ -1,9 +1,3 @@
-# Dependencies which are downloadable
-node_modules/
-
-# Documentation output (auto-generated)
-docs/
-
 # Logs
 pnpm-debug.log*
 
@@ -13,5 +7,17 @@ pnpm-debug.log*
 # Sensitive data
 .env
 
+# TypeScript build caching
+tsconfig.tsbuildinfo
+
+# Build output with TypeScript
+dist/
+
 # Tests coverage (auto-generated)
 coverage/
+
+# Documentation output (auto-generated)
+docs/
+
+# Dependencies which are downloadable
+node_modules/

.github/labeler.yml

@@ -13,8 +13,7 @@ This is a monorepo with packages to **boost the [DX]** of working with [AST] _(u
 1. [DX] friendly.
 1. **Cross-runtime** friendly—👈 this also means [ESM] only.
 1. [e18e] friendly.
-1. **No build step**—meaning you can debug/edit source code inside `node_modules` as it is.
-1. Extensive tests.
+1. Extensive tests and benchmarks.
 
 ---
 
@@ -25,6 +24,7 @@ In order to work with AST, the following processes are recognized:
 1. [Building](#build) programmatically the [AST] node(s), or an entire object.
 1. [Parsing](#parse) _stringified_ code syntax into [AST] object.
 1. [Traversing](#traverse) the [AST] object.
+1. [Analyzing](#analyze) the [AST] object(s).
 1. [Printing](#print) the [AST] object back into _stringified_ code syntax.
 
 > [!IMPORTANT]
@@ -62,6 +62,16 @@ In other words, _walk_ on the AST object.
 | --------------- | ---------------------------------- | ------------------- |
 | [`zimmerframe`] | ![icon-js]![icon-ts]![icon-svelte] | ❌                  |
 
+### Analyze
+
+Analyze the received [AST] object(s). Contains type-guards and utilities.
+
+| Name                   | Languages                          | In this repository? |
+| ---------------------- | ---------------------------------- | ------------------- |
+| [`js-ast-analyze`]     | ![icon-js]                         | ✅                  |
+| [`ts-ast-analyze`]     | ![icon-js]![icon-ts]               | ✅                  |
+| [`svelte-ast-analyze`] | ![icon-js]![icon-ts]![icon-svelte] | ✅                  |
+
 ### Print
 
 Print the [AST] object or nodes into stringified code syntax.
@@ -93,10 +103,13 @@ Mateusz "[xeho91](https://github.com/xeho91)" Kadlubowski
 [ESTree]: https://github.com/estree/estree
 [e18e]: https://github.com/e18e/e18e
 [ESM]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+[`js-ast-analyze`]: ./pkgs/js-ast-build
 [`js-ast-build`]: ./pkgs/js-ast-build
-[`ts-ast-build`]: ./pkgs/ts-ast-build
+[`svelte-ast-analyze`]: ./pkgs/js-ast-build
 [`svelte-ast-build`]: ./pkgs/svelte-ast-build
 [`svelte-ast-print`]: ./pkgs/svelte-ast-print
+[`ts-ast-analyze`]: ./pkgs/js-ast-build
+[`ts-ast-build`]: ./pkgs/ts-ast-build
 [`@swc/core`]: https://github.com/swc-project/swc
 [`svelte/compiler`]: https://github.com/sveltejs/svelte
 [`zimmerframe`]: https://github.com/Rich-Harris/zimmerframe

.gitignore

@@ -8,20 +8,32 @@
 			},
 			"vite": false
 		},
+		"pkgs/js-ast-analyze": {
+			"entry": ["src/lib.ts"],
+			"project": ["**/*.{json,js,ts}"]
+		},
 		"pkgs/js-ast-build": {
-			"entry": ["src/lib.js"],
+			"entry": ["src/lib.ts"],
+			"project": ["**/*.{json,js,ts}"]
+		},
+		"pkgs/ts-ast-analyze": {
+			"entry": ["src/lib.ts"],
 			"project": ["**/*.{json,js,ts}"]
 		},
 		"pkgs/ts-ast-build": {
-			"entry": ["src/lib.js"],
+			"entry": ["src/lib.ts"],
+			"project": ["**/*.{json,js,ts}"]
+		},
+		"pkgs/svelte-ast-analyze": {
+			"entry": ["src/lib.ts"],
 			"project": ["**/*.{json,js,ts}"]
 		},
 		"pkgs/svelte-ast-build": {
-			"entry": ["src/lib.js"],
+			"entry": ["src/lib.ts"],
 			"project": ["**/*.{json,js,ts}"]
 		},
 		"pkgs/svelte-ast-print": {
-			"entry": ["src/lib.js"],
+			"entry": ["src/lib.ts"],
 			"project": ["**/*.{json,js,ts}"]
 		}
 	}

README.md

@@ -32,14 +32,14 @@
 		"@biomejs/biome": "^1.9.0",
 		"@changesets/changelog-github": "^0.5.0",
 		"@changesets/cli": "^2.27.0",
-		"@types/node": "^22.13.0",
+		"@types/node": "^22.0.0",
 		"@vitest/coverage-v8": "^3.0.5",
 		"@vitest/ui": "^3.0.5",
-		"knip": "^5.43.0",
+		"knip": "^5.44.0",
 		"serve": "^14.2.0",
 		"typedoc": "^0.27.0",
 		"typedoc-plugin-coverage": "^3.4.0",
-		"typedoc-plugin-dt-links": "^1.1.10",
+		"typedoc-plugin-dt-links": "^1.1.0",
 		"typedoc-plugin-mdn-links": "^4.0.0",
 		"typedoc-plugin-missing-exports": "^3.1.0",
 		"typescript": "catalog:",

knip.json

@@ -0,0 +1,19 @@
+# MIT License
+
+Copyright (c) 2024-present [these people](https://github.com/xeho91/svelte-ast-print/graphs/contributors)
+
+Permission is hereby granted, free of charge,
+to any person obtaining a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package.json

@@ -0,0 +1,17 @@
+# `ts-ast-analyze`
+
+![NPM Version](https://img.shields.io/npm/v/ts-ast-analyze?style=for-the-badge&logo=npm)
+
+> [!CAUTION]
+> 🚧 Work In Progress 🚧
+
+---
+
+## Author
+
+Mateusz "[xeho91](https://github.com/xeho91)" Kadlubowski
+
+<!-- LINKS -->
+
+[AST]: https://en.wikipedia.org/wiki/Abstract_syntax_tree
+[Svelte]: https://github.com/sveltejs/svelte

pkgs/js-ast-analyze/LICENSE.md

@@ -0,0 +1,72 @@
+{
+	"$schema": "https://json.schemastore.org/package",
+	"name": "js-ast-analyze",
+	"version": "0.0.1",
+	"type": "module",
+	"description": "Analyze JavaScript AST nodes conveniently.",
+	"keywords": ["ast", "analyze", "javascript"],
+	"license": "MIT",
+	"author": {
+		"name": "Mateusz Kadlubowski",
+		"email": "[email protected]",
+		"url": "https://github.com/xeho91"
+	},
+	"homepage": "https://github.com/xeho91/js-ast",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/xeho91/js-ast.git",
+		"directory": "pkgs/js-ast-analyze"
+	},
+	"bugs": "https://github.com/xeho91/js-ast/issues",
+	"funding": [
+		{
+			"type": "github",
+			"url": "https://github.com/sponsors/xeho91"
+		},
+		{
+			"type": "opencollective",
+			"url": "https://opencollective.com/xeho91"
+		}
+	],
+	"publishConfig": {
+		"access": "public",
+		"provenance": true
+	},
+	"engines": {
+		"node": ">=18"
+	},
+	"files": ["dist/"],
+	"exports": {
+		".": {
+			"development": "./src/lib.ts",
+			"types": "./dist/lib.d.ts",
+			"default": "./dist/lib.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"scripts": {
+		"build": "pnpm run \"/^build:.*/\" ",
+		"build:doc": "typedoc",
+		"build:pkg": "tsc",
+		"check": "tsc --noEmit",
+		"clean": "pnpm run \"/^clean:.*/\"; rm -rf \"./**/node_modules\" ",
+		"clean:build": "rm -rf \"./dist\" && rm -f \"tsconfig.tsbuildinfo\" ",
+		"clean:cache": "rm -rf \"./node_modules/.cache\" ",
+		"clean:doc": "rm -rf \"./docs\" ",
+		"clean:test": "rm -rf \"./coverage\" ",
+		"dev": "pnpm run \"/^dev:.*/\" ",
+		"dev:doc": "typedoc --watch",
+		"dev:test": "pnpm vitest watch --passWithNoTests --ui",
+		"fix": "pnpm run \"/^fix:.*/\" ",
+		"fix:biome": "biome check . --verbose --write",
+		"fix:format": "biome format . --verbose --write",
+		"fix:js": "biome lint . --verbose --fix --unsafe",
+		"lint": "pnpm run \"/^lint:.*/\" ",
+		"lint:biome": "biome check . --verbose",
+		"lint:format": "biome format . --verbose",
+		"lint:js": "biome lint . --verbose",
+		"prepublishOnly": "pnpm --filter js-ast-analyze run --parallel \"/^lint|^test|^build:pkg/\"",
+		"serve:doc": "serve \"./docs\" ",
+		"test": "vitest run . --passWithNoTests"
+	}
+}

pkgs/js-ast-analyze/README.md

@@ -0,0 +1,10 @@
+{
+	"$schema": "https://json.schemastore.org/tsconfig",
+	"extends": ["../../tsconfig.json"],
+	"compilerOptions": {
+		"rootDir": "src/",
+		"outDir": "dist/"
+	},
+	"exclude": ["src/**/*.test.ts", "tests/"],
+	"include": ["src/"]
+}

pkgs/js-ast-analyze/package.json

@@ -0,0 +1,6 @@
+{
+	"$schema": "https://typedoc.org/schema.json",
+	"extends": ["../../typedoc.base.json"],
+	"exclude": ["src/**/*.test.ts", "tests/"],
+	"entryPoints": ["src/**/*.ts"]
+}

pkgs/js-ast-build/src/mod.js renamed to pkgs/js-ast-analyze/src/lib.ts

@@ -35,19 +35,22 @@
 	"engines": {
 		"node": ">=18"
 	},
-	"files": ["src/", "types.d.ts"],
+	"files": ["dist/"],
 	"exports": {
 		".": {
-			"types": "./types.d.ts",
-			"default": "./src/mod.js"
+			"development": "./src/lib.ts",
+			"types": "./dist/lib.d.ts",
+			"default": "./dist/lib.js"
 		},
 		"./package.json": "./package.json"
 	},
 	"scripts": {
 		"build": "pnpm run \"/^build:.*/\" ",
 		"build:doc": "typedoc",
+		"build:pkg": "tsc",
 		"check": "tsc --noEmit",
 		"clean": "pnpm run \"/^clean:.*/\"; rm -rf \"./**/node_modules\" ",
+		"clean:build": "rm -rf \"./dist\" && rm -f \"tsconfig.tsbuildinfo\" ",
 		"clean:cache": "rm -rf \"./node_modules/.cache\" ",
 		"clean:doc": "rm -rf \"./docs\" ",
 		"clean:test": "rm -rf \"./coverage\" ",
@@ -62,7 +65,7 @@
 		"lint:biome": "biome check . --verbose",
 		"lint:format": "biome format . --verbose",
 		"lint:js": "biome lint . --verbose",
-		"prepublishOnly": "pnpm lint && pnpm test",
+		"prepublishOnly": "pnpm --filter js-ast-build run --parallel \"/^lint|^test|^build:pkg/\"",
 		"serve:doc": "serve \"./docs\" ",
 		"test": "vitest run . --passWithNoTests"
 	}

pkgs/js-ast-analyze/tsconfig.json

@@ -1,21 +1,10 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig",
+	"extends": ["../../tsconfig.json"],
 	"compilerOptions": {
-		"allowJs": true,
-		"allowImportingTsExtensions": true,
-		"allowSyntheticDefaultImports": true,
-		"checkJs": true,
-		"lib": ["ESNext"],
-		"module": "ESNext",
-		"moduleResolution": "bundler",
-		"noEmit": true,
-		"noEmitOnError": true,
-		"noErrorTruncation": true,
-		"resolveJsonModule": true,
-		"skipLibCheck": true,
-		"strict": true,
-		"target": "ESNext",
-		"verbatimModuleSyntax": true
+		"rootDir": "src/",
+		"outDir": "dist/"
 	},
+	"exclude": ["src/**/*.test.ts", "tests/"],
 	"include": ["src/"]
 }

pkgs/js-ast-analyze/typedoc.json

@@ -1,5 +1,6 @@
 {
 	"$schema": "https://typedoc.org/schema.json",
 	"extends": ["../../typedoc.base.json"],
-	"entryPoints": ["src/**/*"]
+	"exclude": ["src/**/*.test.ts", "tests/"],
+	"entryPoints": ["src/**/*.ts"]
 }