ng-explorer 0.0.1 → 0.0.2
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.
|
@@ -1,14 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ng-explorer",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "Search and explore Angular components, services, directives, and other constructs using Compodoc documentation",
|
|
5
|
-
"author":
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
"type": "git",
|
|
9
|
-
"url": "https://github.com/willmartian/ng-explorer.git"
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "willmartian",
|
|
7
|
+
"url": "https://github.com/willmartian"
|
|
10
8
|
},
|
|
11
|
-
"
|
|
12
|
-
"skills/ng-explorer"
|
|
13
|
-
]
|
|
9
|
+
"repository": "https://github.com/willmartian/ng-explorer"
|
|
14
10
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ng-explorer",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"description": "CLI tool to explore
|
|
3
|
+
"version": "0.0.2",
|
|
4
|
+
"description": "CLI tool and Claude plugin to search and explore components, services, directives, and other constructs in Angular projects",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"packageManager": "pnpm@10.28.1",
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ng-explorer
|
|
3
|
-
description: Search and explore Angular components, services, directives, and other constructs in Angular projects
|
|
3
|
+
description: Search and explore Angular components, services, directives, and other constructs in Angular projects.
|
|
4
4
|
argument-hint: [query] [--type component|injectable|directive|pipe|module|class] [--verbose] [--exact]
|
|
5
5
|
allowed-tools: Bash(ng-explorer*)
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# ng-explorer
|
|
9
9
|
|
|
10
|
-
Use the `ng-explorer` CLI to search and explore Angular constructs in the codebase.
|
|
10
|
+
Use the `ng-explorer` CLI to search and explore Angular constructs in the codebase. Use this when exploring what Angular code exists and how to use it.
|
|
11
11
|
|
|
12
12
|
## Prerequisites
|
|
13
13
|
|
|
@@ -20,7 +20,7 @@ npx compodoc -p tsconfig.json -e json -d . --disablePrivate --disableProtected
|
|
|
20
20
|
## Usage
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
ng-explorer [query] [options]
|
|
23
|
+
npx ng-explorer [query] [options]
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
### Options
|
|
@@ -39,56 +39,56 @@ Fuzzy search automatically strips common Angular suffixes (Component, Service, D
|
|
|
39
39
|
|
|
40
40
|
```bash
|
|
41
41
|
# Search for "Foo" matches FooComponent, FooService, etc.
|
|
42
|
-
ng-explorer foo
|
|
42
|
+
npx ng-explorer foo
|
|
43
43
|
|
|
44
44
|
# Search only components
|
|
45
|
-
ng-explorer foo --type component
|
|
45
|
+
npx ng-explorer foo --type component
|
|
46
46
|
|
|
47
47
|
# Search only services
|
|
48
|
-
ng-explorer bar --type injectable
|
|
48
|
+
npx ng-explorer bar --type injectable
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
### Find exact construct by name
|
|
52
52
|
|
|
53
53
|
```bash
|
|
54
54
|
# Exact name match
|
|
55
|
-
ng-explorer FooComponent --exact
|
|
55
|
+
npx ng-explorer FooComponent --exact
|
|
56
56
|
|
|
57
57
|
# Exact match with verbose output
|
|
58
|
-
ng-explorer BarService --exact --verbose
|
|
58
|
+
npx ng-explorer BarService --exact --verbose
|
|
59
59
|
```
|
|
60
60
|
|
|
61
61
|
### List all constructs of a type
|
|
62
62
|
|
|
63
63
|
```bash
|
|
64
64
|
# List all components
|
|
65
|
-
ng-explorer --type component
|
|
65
|
+
npx ng-explorer --type component
|
|
66
66
|
|
|
67
67
|
# List all services
|
|
68
|
-
ng-explorer --type injectable
|
|
68
|
+
npx ng-explorer --type injectable
|
|
69
69
|
|
|
70
70
|
# List all directives
|
|
71
|
-
ng-explorer --type directive
|
|
71
|
+
npx ng-explorer --type directive
|
|
72
72
|
```
|
|
73
73
|
|
|
74
74
|
### View detailed API information
|
|
75
75
|
|
|
76
76
|
```bash
|
|
77
77
|
# Show full API details for search results
|
|
78
|
-
ng-explorer foo --verbose
|
|
78
|
+
npx ng-explorer foo --verbose
|
|
79
79
|
|
|
80
80
|
# Exact match with full details
|
|
81
|
-
ng-explorer FooComponent --exact --verbose
|
|
81
|
+
npx ng-explorer FooComponent --exact --verbose
|
|
82
82
|
```
|
|
83
83
|
|
|
84
84
|
### Filter by path
|
|
85
85
|
|
|
86
86
|
```bash
|
|
87
87
|
# Search in specific directory
|
|
88
|
-
ng-explorer foo --path "apps/web/**"
|
|
88
|
+
npx ng-explorer foo --path "apps/web/**"
|
|
89
89
|
|
|
90
90
|
# Search in library
|
|
91
|
-
ng-explorer bar --path "libs/common/**"
|
|
91
|
+
npx ng-explorer bar --path "libs/common/**"
|
|
92
92
|
```
|
|
93
93
|
|
|
94
94
|
## Output Formats
|
|
@@ -116,22 +116,22 @@ When the user asks about Angular components, services, or project structure:
|
|
|
116
116
|
|
|
117
117
|
**User asks: "What components do we have for navigation?"**
|
|
118
118
|
```bash
|
|
119
|
-
ng-explorer nav --type component
|
|
119
|
+
npx ng-explorer nav --type component
|
|
120
120
|
```
|
|
121
121
|
|
|
122
122
|
**User asks: "Show me the API for the AuthService"**
|
|
123
123
|
```bash
|
|
124
|
-
ng-explorer AuthService --exact --verbose --type injectable
|
|
124
|
+
npx ng-explorer AuthService --exact --verbose --type injectable
|
|
125
125
|
```
|
|
126
126
|
|
|
127
127
|
**User asks: "What services are in the common library?"**
|
|
128
128
|
```bash
|
|
129
|
-
ng-explorer --type injectable --path "libs/common/**"
|
|
129
|
+
npx ng-explorer --type injectable --path "libs/common/**"
|
|
130
130
|
```
|
|
131
131
|
|
|
132
132
|
**User asks: "Find all directives that handle tooltips"**
|
|
133
133
|
```bash
|
|
134
|
-
ng-explorer tooltip --type directive
|
|
134
|
+
npx ng-explorer tooltip --type directive
|
|
135
135
|
```
|
|
136
136
|
|
|
137
137
|
## Notes
|