- future command surface
+ parse · transform
@@ -453,18 +386,19 @@ function Terminal() {
--language auto --backend rust --format summary
- {" "}
+
+
+ # run a codemod in check mode, then write
+
uvx graph-sitter
- transform ./codemods/rename.py{" "}
+ transform delete_dead_code.py:run .{" "}
--check
- {" "}
-
- # branch wheel proof:
-
-
- # uvx --from dist/*.whl graph-sitter parse . --backend rust
+
+ uvx graph-sitter
+ transform delete_dead_code.py:run .{" "}
+ --write
diff --git a/site/lib/docs.ts b/site/lib/docs.ts
index 42fd59e4c..5086c15a1 100644
--- a/site/lib/docs.ts
+++ b/site/lib/docs.ts
@@ -263,9 +263,6 @@ const docsSectionOrder = [
["blog", "Blog"],
["api-reference", "API Reference"],
["graph-sitter", "Graph-sitter"],
- ["use-cases", "Use Cases"],
- ["organizations", "Organizations"],
- ["users", "Users"],
] as const;
const sectionTitleBySlug = new Map
(docsSectionOrder);
@@ -320,7 +317,14 @@ function buildDocsNavItems(
}
return [...bySegment.entries()]
- .sort(([left], [right]) => sortNavSegments(left, right))
+ .sort(([left], [right]) => {
+ const leftOrder = navOrder(parentSlug, left);
+ const rightOrder = navOrder(parentSlug, right);
+ if (leftOrder !== rightOrder) {
+ return leftOrder - rightOrder;
+ }
+ return sortNavSegments(left, right);
+ })
.map(([segment, segmentSlugs]) => {
if (!segment) {
return navLeaf(parentSlug, section);
@@ -356,6 +360,22 @@ function navLeaf(slug: string, section: string): DocsNavItem {
};
}
+function navOrder(parentSlug: string, segment: string) {
+ // The section's own index page always leads its group.
+ if (!segment) {
+ return Number.NEGATIVE_INFINITY;
+ }
+
+ const filePath = findDocFile(`${parentSlug}/${segment}`);
+ if (!filePath) {
+ return Number.POSITIVE_INFINITY;
+ }
+
+ const parsed = matter(fs.readFileSync(filePath, "utf8"));
+ const order = parsed.data.sidebarOrder;
+ return typeof order === "number" ? order : Number.POSITIVE_INFINITY;
+}
+
function sortNavSegments(left: string, right: string) {
if (!left) {
return -1;
- 2. Open the Command Palette (Cmd/Ctrl + Shift + P)
- 3. Type "Python: Select Interpreter"
- 
- 4. Choose "Enter interpreter path"
- 5. Navigate to and select:
- ```bash
- .codegen/.venv/bin/python
- ```
-
- Alternatively, create a `.vscode/settings.json`:
- ```json
- {
- "python.defaultInterpreterPath": "${workspaceFolder}/.codegen/.venv/bin/python",
- "python.analysis.extraPaths": [
- "${workspaceFolder}/.codegen/.venv/lib/python3.12/site-packages"
- ]
- }
- ```
- 
- Collaborating with Cursor's assistant and the Graph-sitter system prompt
-
-
-In addition, when you [create](/cli/create) a codemod with "-d", Graph-sitter generates an optimized system prompt in `.codegen/codemods/{name}/{name}-system-prompt.txt`. This prompt contains:
-- Relevant Codegen API documentation
-- Examples of relevant transformations
-- Context about your specific task
-
-
-
-
-# Neo4j Graph
-
-Graph-sitter can export codebase graphs to Neo4j for visualization and analysis.
-
-## Installation
-In order to use Neo4j you will need to install it and run it locally using Docker.
-
-### Neo4j
-First, install Neo4j using the official [installation guide](https://neo4j.com/docs/desktop-manual/current/installation/download-installation/).
-
-### Docker
-To run Neo4j locally using Docker, follow the instructions [here](https://neo4j.com/docs/apoc/current/installation/#docker).
-
-## Launch Neo4j Locally
-
-```bash
-docker run \
- -p 7474:7474 -p 7687:7687 \
- -v $PWD/data:/data -v $PWD/plugins:/plugins \
- --name neo4j-apoc \
- -e NEO4J_apoc_export_file_enabled=true \
- -e NEO4J_apoc_import_file_enabled=true \
- -e NEO4J_apoc_import_file_use__neo4j__config=true \
- -e NEO4J_PLUGINS=\[\"apoc\"\] \
- neo4j:latest
-```
-## Usage
-
-```python
-from graph_sitter import Codebase
-from graph_sitter.extensions.graph.main import visualize_codebase
-
-# parse codebase
-codebase = Codebase("path/to/codebase")
-
-# export to Neo4j
-visualize_codebase(codebase, "bolt://localhost:7687", "neo4j", "password")
-```
-
-## Visualization
-
-Once exported, you can open the Neo4j browser at `http://localhost:7474`, sign in with the username `neo4j` and the password `password`, and use the following Cypher queries to visualize the codebase:
-
-### Class Hierarchy
-
-```cypher
-Match (s: Class )-[r: INHERITS_FROM*]-> (e:Class) RETURN s, e LIMIT 10
-```
-
- 
-
-
-### Methods Defined by Each Class
-
-```cypher
-Match (s: Class )-[r: DEFINES]-> (e:Method) RETURN s, e LIMIT 10
-```
-
- 
-
-
-### Function Calls
-
-```cypher
-Match (s: Func )-[r: CALLS]-> (e:Func) RETURN s, e LIMIT 10
-```
-
-
- 
-
-
-### Call Graph
-
-```cypher
-Match path = (:(Method|Func)) -[:CALLS*5..10]-> (:(Method|Func))
-Return path
-LIMIT 20
-```
-
-
-