feat: add typedoc

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Build
+name: CI
 
 on:
   push:

.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Docs
+
+run-name: Update API docs
+
+on:
+  workflow_run:
+    workflows: [CI]
+    types: [completed]
+    branches: [master]
+
+concurrency:
+  cancel-in-progress: true
+  group: ${{github.workflow}}-${{github.ref_name}}
+
+permissions:
+  pages: write
+  id-token: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    name: Publish docs on GitHub pages
+    if: github.event.workflow_run.conclusion == 'success'
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+      - name: Generate documentation
+        run: npm run docs
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/api
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package.json

@@ -29,28 +29,31 @@
     "vendor/tree-sitter/lib/src/*"
   ],
   "dependencies": {
-    "node-addon-api": "^8.2.1",
+    "node-addon-api": "^8.2.2",
     "node-gyp-build": "^4.8.2"
   },
   "devDependencies": {
-    "@types/node": "^22.7.8",
+    "@types/node": "^22.9.0",
     "@types/tmp": "^0.2.6",
     "glob": "^11.0.0",
     "node-gyp": "^10.2.0",
     "prebuildify": "^6.0.1",
     "tmp": "^0.2.3",
     "tree-sitter-c": "^0.23.1",
-    "tree-sitter-embedded-template": "^0.23.0",
-    "tree-sitter-html": "^0.23.0",
-    "tree-sitter-java": "^0.23.2",
-    "tree-sitter-javascript": "^0.23.0",
-    "tree-sitter-json": "^0.23.0",
-    "tree-sitter-php": "^0.23.4",
-    "tree-sitter-python": "^0.23.2",
+    "tree-sitter-embedded-template": "^0.23.1",
+    "tree-sitter-html": "^0.23.1",
+    "tree-sitter-java": "^0.23.3",
+    "tree-sitter-javascript": "^0.23.1",
+    "tree-sitter-json": "^0.24.7",
+    "tree-sitter-python": "^0.23.3",
     "tree-sitter-ruby": "^0.23.0",
-    "tree-sitter-rust": "^0.23.0"
+    "tree-sitter-rust": "^0.23.1",
+    "typedoc": "^0.26.11",
+    "typedoc-plugin-rename-defaults": "^0.7.1",
+    "typescript": "^5.6.3"
   },
   "scripts": {
+    "docs": "typedoc --out docs/api tree-sitter.d.ts --readme README.md",
     "install": "node-gyp-build",
     "build": "prebuildify --napi --strip",
     "build_x64": "prebuildify --napi --strip --arch x64 --target 20.9.0",

test/tree_test.js

@@ -1,6 +1,5 @@
 /** @type {typeof import('tree-sitter')} */
 const Parser = require("../index.js");
-const PHP = require('tree-sitter-php').php;
 const JavaScript = require('tree-sitter-javascript');
 const Rust = require('tree-sitter-rust');
 const assert = require('node:assert');

tsconfig.json

@@ -11,7 +11,7 @@
 		]
 	},
 	"include": [
-		"./**/*.js"
+		"./test/*.js"
 	],
 	"exclude": [
 		"node_modules"

tsconfig.typedoc.json

@@ -0,0 +1,8 @@
+{
+	"compilerOptions": {
+		"allowJs": false
+	},
+	"include": [
+		"./tree-sitter.d.ts"
+	]
+}

typedoc.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["tree-sitter.d.ts"],
+  "entryPointStrategy": "expand",
+  "tsconfig": "./tsconfig.typedoc.json",
+  "out": "docs/api",
+  "readme": "README.md",
+  "cleanOutputDir": true,
+  "excludeReferences": true,
+  "excludePrivate": true,
+  "excludeInternal": true,
+  "includeVersion": true,
+  "searchInComments": true,
+  "navigationLinks": {
+    "GitHub": "https://github.com/tree-sitter/node-tree-sitter"
+  },
+  "visibilityFilters": {
+    "protected": false,
+    "private": false,
+    "inherited": true,
+    "external": false
+  },
+  "plugin": ["typedoc-plugin-rename-defaults"]
+}