structx 2.2.0 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/cli.js +1 -1
  2. package/package.json +1 -1
  3. package/dist/instructions/claude.md +0 -70
  4. package/dist/instructions/codex.md +0 -70
  5. package/dist/instructions/copilot.md +0 -70
  6. package/dist/instructions/cursor.md +0 -68
  7. package/dist/instructions/generic.md +0 -70
package/dist/cli.js CHANGED
@@ -56,7 +56,7 @@ const program = new commander_1.Command();
56
56
  program
57
57
  .name('structx')
58
58
  .description('Graph-powered code intelligence CLI for TypeScript')
59
- .version('2.2.0')
59
+ .version('2.2.1')
60
60
  .option('--verbose', 'Enable verbose logging')
61
61
  .hook('preAction', (thisCommand) => {
62
62
  if (thisCommand.opts().verbose) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "structx",
3
- "version": "2.2.0",
3
+ "version": "2.2.1",
4
4
  "main": "dist/cli.js",
5
5
  "bin": {
6
6
  "structx": "dist/cli.js"
package/dist/instructions/claude.md DELETED
@@ -1,70 +0,0 @@
1
- # StructX — Code Intelligence Graph (MANDATORY)
2
-
3
- This project uses **StructX**, a graph-powered code intelligence tool for TypeScript.
4
- StructX maintains a knowledge graph of the codebase including functions, types, routes,
5
- constants, and file summaries. **You MUST use StructX as your primary source of codebase
6
- understanding. Do NOT read raw source files to learn about the codebase.**
7
-
8
- ## Mandatory Workflow
9
-
10
- ### Step 1: Initialize (ALWAYS do this first)
11
- Run `npx structx status` to check the graph state.
12
- - If it says "not initialized", run `npx structx setup .`
13
- - If Functions/Types/Routes counts are 0, run `npx structx setup .`
14
- - **Do NOT proceed to any code task until StructX is initialized and populated.**
15
-
16
- ### Step 2: Understand the codebase via StructX (NEVER skip this)
17
- Before writing ANY code, you MUST query StructX to understand the codebase:
18
- ```
19
- npx structx overview --repo .
20
- npx structx ask "what types and interfaces exist?" --repo .
21
- npx structx ask "what routes/endpoints exist?" --repo .
22
- npx structx ask "how does <relevant feature> work?" --repo .
23
- ```
24
- **You are FORBIDDEN from reading .ts source files to understand the codebase architecture,
25
- discover what functions exist, learn about types, or understand how features work.
26
- StructX provides all of this. Use it.**
27
-
28
- ### Step 3: Read source files ONLY for editing
29
- You may ONLY use raw file reads (Read/cat) when you have ALREADY queried StructX and
30
- now need to see the exact code at a specific location to make an edit. The workflow is:
31
- 1. Ask StructX what exists and where it is
32
- 2. StructX tells you the file path and line numbers
33
- 3. THEN read that specific file to make your edit
34
-
35
- **Reading source files to "explore" or "understand" the codebase is PROHIBITED.
36
- That is what StructX is for.**
37
-
38
- ### Step 4: After making changes
39
- After editing any TypeScript files:
40
- ```
41
- npx structx ingest .
42
- npx structx analyze . --yes
43
- ```
44
-
45
- ### Step 5: Impact analysis before modifying existing code
46
- Before changing any existing function, type, or route:
47
- ```
48
- npx structx ask "what breaks if I change <name>?" --repo .
49
- ```
50
-
51
- ## Available Commands
52
-
53
- | Command | Description |
54
- |---------|-------------|
55
- | `npx structx status` | Check graph state — ALWAYS run first |
56
- | `npx structx setup .` | Full bootstrap (init + ingest + analyze) |
57
- | `npx structx overview --repo .` | Full codebase summary in one shot |
58
- | `npx structx ask "<question>" --repo .` | Query the knowledge graph |
59
- | `npx structx ingest .` | Re-parse codebase after changes |
60
- | `npx structx analyze . --yes` | Run semantic analysis on new/changed entities |
61
-
62
- ## Rules Summary
63
-
64
- 1. **ALWAYS** run `structx status` at session start
65
- 2. **ALWAYS** run `structx setup .` if not initialized
66
- 3. **ALWAYS** use `structx ask` or `structx overview` to understand the codebase
67
- 4. **NEVER** read .ts files to explore/understand architecture — use StructX
68
- 5. **ONLY** read .ts files when you know exactly what file+line to edit (from StructX output)
69
- 6. **ALWAYS** run `structx ingest .` after making code changes
70
- 7. **ALWAYS** run impact analysis before modifying existing functions
package/dist/instructions/codex.md DELETED
@@ -1,70 +0,0 @@
1
- # StructX — Code Intelligence Graph (MANDATORY)
2
-
3
- This project uses **StructX**, a graph-powered code intelligence tool for TypeScript.
4
- StructX maintains a knowledge graph of the codebase including functions, types, routes,
5
- constants, and file summaries. **You MUST use StructX as your primary source of codebase
6
- understanding. Do NOT read raw source files to learn about the codebase.**
7
-
8
- ## Mandatory Workflow
9
-
10
- ### Step 1: Initialize (ALWAYS do this first)
11
- Run `npx structx status` to check the graph state.
12
- - If it says "not initialized", run `npx structx setup .`
13
- - If Functions/Types/Routes counts are 0, run `npx structx setup .`
14
- - **Do NOT proceed to any code task until StructX is initialized and populated.**
15
-
16
- ### Step 2: Understand the codebase via StructX (NEVER skip this)
17
- Before writing ANY code, you MUST query StructX to understand the codebase:
18
- ```
19
- npx structx overview --repo .
20
- npx structx ask "what types and interfaces exist?" --repo .
21
- npx structx ask "what routes/endpoints exist?" --repo .
22
- npx structx ask "how does <relevant feature> work?" --repo .
23
- ```
24
- **You are FORBIDDEN from reading .ts source files to understand the codebase architecture,
25
- discover what functions exist, learn about types, or understand how features work.
26
- StructX provides all of this. Use it.**
27
-
28
- ### Step 3: Read source files ONLY for editing
29
- You may ONLY use raw file reads when you have ALREADY queried StructX and now need to
30
- see the exact code at a specific location to make an edit. The workflow is:
31
- 1. Ask StructX what exists and where it is
32
- 2. StructX tells you the file path and line numbers
33
- 3. THEN read that specific file to make your edit
34
-
35
- **Reading source files to "explore" or "understand" the codebase is PROHIBITED.
36
- That is what StructX is for.**
37
-
38
- ### Step 4: After making changes
39
- After editing any TypeScript files:
40
- ```
41
- npx structx ingest .
42
- npx structx analyze . --yes
43
- ```
44
-
45
- ### Step 5: Impact analysis before modifying existing code
46
- Before changing any existing function, type, or route:
47
- ```
48
- npx structx ask "what breaks if I change <name>?" --repo .
49
- ```
50
-
51
- ## Available Commands
52
-
53
- | Command | Description |
54
- |---------|-------------|
55
- | `npx structx status` | Check graph state — ALWAYS run first |
56
- | `npx structx setup .` | Full bootstrap (init + ingest + analyze) |
57
- | `npx structx overview --repo .` | Full codebase summary in one shot |
58
- | `npx structx ask "<question>" --repo .` | Query the knowledge graph |
59
- | `npx structx ingest .` | Re-parse codebase after changes |
60
- | `npx structx analyze . --yes` | Run semantic analysis on new/changed entities |
61
-
62
- ## Rules Summary
63
-
64
- 1. **ALWAYS** run `structx status` at session start
65
- 2. **ALWAYS** run `structx setup .` if not initialized
66
- 3. **ALWAYS** use `structx ask` or `structx overview` to understand the codebase
67
- 4. **NEVER** read .ts files to explore/understand architecture — use StructX
68
- 5. **ONLY** read .ts files when you know exactly what file+line to edit (from StructX output)
69
- 6. **ALWAYS** run `structx ingest .` after making code changes
70
- 7. **ALWAYS** run impact analysis before modifying existing functions
package/dist/instructions/copilot.md DELETED
@@ -1,70 +0,0 @@
1
- # StructX — Code Intelligence Graph (MANDATORY)
2
-
3
- This project uses **StructX**, a graph-powered code intelligence tool for TypeScript.
4
- StructX maintains a knowledge graph of the codebase including functions, types, routes,
5
- constants, and file summaries. **You MUST use StructX as your primary source of codebase
6
- understanding. Do NOT read raw source files to learn about the codebase.**
7
-
8
- ## Mandatory Workflow
9
-
10
- ### Step 1: Initialize (ALWAYS do this first)
11
- Run `npx structx status` to check the graph state.
12
- - If it says "not initialized", run `npx structx setup .`
13
- - If Functions/Types/Routes counts are 0, run `npx structx setup .`
14
- - **Do NOT proceed to any code task until StructX is initialized and populated.**
15
-
16
- ### Step 2: Understand the codebase via StructX (NEVER skip this)
17
- Before writing ANY code, you MUST query StructX to understand the codebase:
18
- ```
19
- npx structx overview --repo .
20
- npx structx ask "what types and interfaces exist?" --repo .
21
- npx structx ask "what routes/endpoints exist?" --repo .
22
- npx structx ask "how does <relevant feature> work?" --repo .
23
- ```
24
- **You are FORBIDDEN from reading .ts source files to understand the codebase architecture,
25
- discover what functions exist, learn about types, or understand how features work.
26
- StructX provides all of this. Use it.**
27
-
28
- ### Step 3: Read source files ONLY for editing
29
- You may ONLY use raw file reads when you have ALREADY queried StructX and now need to
30
- see the exact code at a specific location to make an edit. The workflow is:
31
- 1. Ask StructX what exists and where it is
32
- 2. StructX tells you the file path and line numbers
33
- 3. THEN read that specific file to make your edit
34
-
35
- **Reading source files to "explore" or "understand" the codebase is PROHIBITED.
36
- That is what StructX is for.**
37
-
38
- ### Step 4: After making changes
39
- After editing any TypeScript files:
40
- ```
41
- npx structx ingest .
42
- npx structx analyze . --yes
43
- ```
44
-
45
- ### Step 5: Impact analysis before modifying existing code
46
- Before changing any existing function, type, or route:
47
- ```
48
- npx structx ask "what breaks if I change <name>?" --repo .
49
- ```
50
-
51
- ## Available Commands
52
-
53
- | Command | Description |
54
- |---------|-------------|
55
- | `npx structx status` | Check graph state — ALWAYS run first |
56
- | `npx structx setup .` | Full bootstrap (init + ingest + analyze) |
57
- | `npx structx overview --repo .` | Full codebase summary in one shot |
58
- | `npx structx ask "<question>" --repo .` | Query the knowledge graph |
59
- | `npx structx ingest .` | Re-parse codebase after changes |
60
- | `npx structx analyze . --yes` | Run semantic analysis on new/changed entities |
61
-
62
- ## Rules Summary
63
-
64
- 1. **ALWAYS** run `structx status` at session start
65
- 2. **ALWAYS** run `structx setup .` if not initialized
66
- 3. **ALWAYS** use `structx ask` or `structx overview` to understand the codebase
67
- 4. **NEVER** read .ts files to explore/understand architecture — use StructX
68
- 5. **ONLY** read .ts files when you know exactly what file+line to edit (from StructX output)
69
- 6. **ALWAYS** run `structx ingest .` after making code changes
70
- 7. **ALWAYS** run impact analysis before modifying existing functions
package/dist/instructions/cursor.md DELETED
@@ -1,68 +0,0 @@
1
- # StructX — Code Intelligence Graph (MANDATORY)
2
-
3
- This project uses **StructX**, a graph-powered code intelligence tool for TypeScript.
4
- StructX maintains a knowledge graph of the codebase including functions, types, routes,
5
- constants, and file summaries. **You MUST use StructX as your primary source of codebase
6
- understanding. Do NOT read raw source files to learn about the codebase.**
7
-
8
- ## Mandatory Workflow
9
-
10
- ### Step 1: Initialize (ALWAYS do this first)
11
- Run `npx structx status` to check the graph state.
12
- - If it says "not initialized", run `npx structx setup .`
13
- - If Functions/Types/Routes counts are 0, run `npx structx setup .`
14
- - **Do NOT proceed to any code task until StructX is initialized and populated.**
15
-
16
- ### Step 2: Understand the codebase via StructX (NEVER skip this)
17
- Before writing ANY code, you MUST query StructX to understand the codebase:
18
- ```
19
- npx structx overview --repo .
20
- npx structx ask "what types and interfaces exist?" --repo .
21
- npx structx ask "what routes/endpoints exist?" --repo .
22
- npx structx ask "how does <relevant feature> work?" --repo .
23
- ```
24
- **You are FORBIDDEN from reading .ts source files to understand the codebase architecture,
25
- discover what functions exist, learn about types, or understand how features work.
26
- StructX provides all of this. Use it.**
27
-
28
- ### Step 3: Read source files ONLY for editing
29
- You may ONLY use raw file reads when you have ALREADY queried StructX and now need to
30
- see the exact code at a specific location to make an edit. The workflow is:
31
- 1. Ask StructX what exists and where it is
32
- 2. StructX tells you the file path and line numbers
33
- 3. THEN read that specific file to make your edit
34
-
35
- **Reading source files to "explore" or "understand" the codebase is PROHIBITED.
36
- That is what StructX is for.**
37
-
38
- ### Step 4: After making changes
39
- After editing any TypeScript files:
40
- ```
41
- npx structx ingest .
42
- npx structx analyze . --yes
43
- ```
44
-
45
- ### Step 5: Impact analysis before modifying existing code
46
- Before changing any existing function, type, or route:
47
- ```
48
- npx structx ask "what breaks if I change <name>?" --repo .
49
- ```
50
-
51
- ## Available Commands
52
-
53
- - `npx structx status` — Check graph state — ALWAYS run first
54
- - `npx structx setup .` — Full bootstrap (init + ingest + analyze)
55
- - `npx structx overview --repo .` — Full codebase summary in one shot
56
- - `npx structx ask "<question>" --repo .` — Query the knowledge graph
57
- - `npx structx ingest .` — Re-parse codebase after changes
58
- - `npx structx analyze . --yes` — Run semantic analysis on new/changed entities
59
-
60
- ## Rules Summary
61
-
62
- 1. **ALWAYS** run `structx status` at session start
63
- 2. **ALWAYS** run `structx setup .` if not initialized
64
- 3. **ALWAYS** use `structx ask` or `structx overview` to understand the codebase
65
- 4. **NEVER** read .ts files to explore/understand architecture — use StructX
66
- 5. **ONLY** read .ts files when you know exactly what file+line to edit (from StructX output)
67
- 6. **ALWAYS** run `structx ingest .` after making code changes
68
- 7. **ALWAYS** run impact analysis before modifying existing functions
package/dist/instructions/generic.md DELETED
@@ -1,70 +0,0 @@
1
- # StructX — Code Intelligence Graph (MANDATORY)
2
-
3
- This project uses **StructX**, a graph-powered code intelligence tool for TypeScript.
4
- StructX maintains a knowledge graph of the codebase including functions, types, routes,
5
- constants, and file summaries. **You MUST use StructX as your primary source of codebase
6
- understanding. Do NOT read raw source files to learn about the codebase.**
7
-
8
- ## Mandatory Workflow
9
-
10
- ### Step 1: Initialize (ALWAYS do this first)
11
- Run `npx structx status` to check the graph state.
12
- - If it says "not initialized", run `npx structx setup .`
13
- - If Functions/Types/Routes counts are 0, run `npx structx setup .`
14
- - **Do NOT proceed to any code task until StructX is initialized and populated.**
15
-
16
- ### Step 2: Understand the codebase via StructX (NEVER skip this)
17
- Before writing ANY code, you MUST query StructX to understand the codebase:
18
- ```
19
- npx structx overview --repo .
20
- npx structx ask "what types and interfaces exist?" --repo .
21
- npx structx ask "what routes/endpoints exist?" --repo .
22
- npx structx ask "how does <relevant feature> work?" --repo .
23
- ```
24
- **You are FORBIDDEN from reading .ts source files to understand the codebase architecture,
25
- discover what functions exist, learn about types, or understand how features work.
26
- StructX provides all of this. Use it.**
27
-
28
- ### Step 3: Read source files ONLY for editing
29
- You may ONLY use raw file reads when you have ALREADY queried StructX and now need to
30
- see the exact code at a specific location to make an edit. The workflow is:
31
- 1. Ask StructX what exists and where it is
32
- 2. StructX tells you the file path and line numbers
33
- 3. THEN read that specific file to make your edit
34
-
35
- **Reading source files to "explore" or "understand" the codebase is PROHIBITED.
36
- That is what StructX is for.**
37
-
38
- ### Step 4: After making changes
39
- After editing any TypeScript files:
40
- ```
41
- npx structx ingest .
42
- npx structx analyze . --yes
43
- ```
44
-
45
- ### Step 5: Impact analysis before modifying existing code
46
- Before changing any existing function, type, or route:
47
- ```
48
- npx structx ask "what breaks if I change <name>?" --repo .
49
- ```
50
-
51
- ## Available Commands
52
-
53
- | Command | Description |
54
- |---------|-------------|
55
- | `npx structx status` | Check graph state — ALWAYS run first |
56
- | `npx structx setup .` | Full bootstrap (init + ingest + analyze) |
57
- | `npx structx overview --repo .` | Full codebase summary in one shot |
58
- | `npx structx ask "<question>" --repo .` | Query the knowledge graph |
59
- | `npx structx ingest .` | Re-parse codebase after changes |
60
- | `npx structx analyze . --yes` | Run semantic analysis on new/changed entities |
61
-
62
- ## Rules Summary
63
-
64
- 1. **ALWAYS** run `structx status` at session start
65
- 2. **ALWAYS** run `structx setup .` if not initialized
66
- 3. **ALWAYS** use `structx ask` or `structx overview` to understand the codebase
67
- 4. **NEVER** read .ts files to explore/understand architecture — use StructX
68
- 5. **ONLY** read .ts files when you know exactly what file+line to edit (from StructX output)
69
- 6. **ALWAYS** run `structx ingest .` after making code changes
70
- 7. **ALWAYS** run impact analysis before modifying existing functions