ng-explorer 0.0.1

package/dist/types/compodoc.js

@@ -0,0 +1,40 @@
+/**
+ * TypeScript type definitions for Compodoc's documentation.json format
+ */
+/**
+ * Type guard to check if a construct is a Component
+ */
+export function isComponent(construct) {
+    return construct.type === 'component';
+}
+/**
+ * Type guard to check if a construct is an Injectable
+ */
+export function isInjectable(construct) {
+    return construct.type === 'injectable';
+}
+/**
+ * Type guard to check if a construct is a Directive
+ */
+export function isDirective(construct) {
+    return construct.type === 'directive';
+}
+/**
+ * Type guard to check if a construct is a Pipe
+ */
+export function isPipe(construct) {
+    return construct.type === 'pipe';
+}
+/**
+ * Type guard to check if a construct is a Module
+ */
+export function isModule(construct) {
+    return construct.type === 'module';
+}
+/**
+ * Type guard to check if a construct is a Class
+ */
+export function isClass(construct) {
+    return construct.type === 'class';
+}
+//# sourceMappingURL=compodoc.js.map

package/dist/types/compodoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compodoc.js","sourceRoot":"","sources":["../../src/types/compodoc.ts"],"names":[],"mappings":"AAAA;;GAEG;AAiRH;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,SAA2B;IACrD,OAAO,SAAS,CAAC,IAAI,KAAK,WAAW,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,SAA2B;IACtD,OAAO,SAAS,CAAC,IAAI,KAAK,YAAY,CAAC;AACzC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,SAA2B;IACrD,OAAO,SAAS,CAAC,IAAI,KAAK,WAAW,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,MAAM,CAAC,SAA2B;IAChD,OAAO,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC;AACnC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,SAA2B;IAClD,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC;AACrC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,SAA2B;IACjD,OAAO,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC;AACpC,CAAC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "ng-explorer",
+  "version": "0.0.1",
+  "description": "CLI tool to explore Angular components and services using Compodoc documentation",
+  "type": "module",
+  "main": "dist/index.js",
+  "packageManager": "pnpm@10.28.1",
+  "bin": {
+    "ng-explorer": "./bin/ng-explorer.js"
+  },
+  "files": [
+    "dist",
+    "bin",
+    ".claude-plugin",
+    "skills"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "clean": "rm -rf dist"
+  },
+  "keywords": [
+    "angular",
+    "cli",
+    "compodoc",
+    "explorer",
+    "documentation",
+    "claude-code",
+    "claude-plugin"
+  ],
+  "author": "Will Martin",
+  "license": "GPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/willmartian/ng-explorer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/willmartian/ng-explorer/issues"
+  },
+  "homepage": "https://github.com/willmartian/ng-explorer#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^12.0.0",
+    "fuse.js": "^7.0.0",
+    "minimatch": "^9.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "typescript": "^5.3.3"
+  }
+}

package/skills/ng-explorer/SKILL.md

@@ -0,0 +1,141 @@
+---
+name: ng-explorer
+description: Search and explore Angular components, services, directives, and other constructs in Angular projects using Compodoc documentation
+argument-hint: [query] [--type component|injectable|directive|pipe|module|class] [--verbose] [--exact]
+allowed-tools: Bash(ng-explorer*)
+---
+
+# ng-explorer
+
+Use the `ng-explorer` CLI to search and explore Angular constructs in the codebase.
+
+## Prerequisites
+
+The project must have a `documentation.json` file generated by Compodoc. If it doesn't exist, generate it first:
+
+```bash
+npx compodoc -p tsconfig.json -e json -d . --disablePrivate --disableProtected
+```
+
+## Usage
+
+```bash
+ng-explorer [query] [options]
+```
+
+### Options
+
+- `--type <type>` - Filter by type: component, injectable, directive, pipe, module, class, all (default: all)
+- `--path <pattern>` - Filter by file path pattern (supports wildcards)
+- `--limit <number>` - Limit number of results (default: 50)
+- `--verbose` or `-v` - Show full API details for each result
+- `--exact` or `-e` - Use exact name matching instead of fuzzy search
+- `--doc-path <path>` - Path to documentation.json (default: ./documentation.json)
+
+## Common Operations
+
+### Search for a construct (fuzzy)
+Fuzzy search automatically strips common Angular suffixes (Component, Service, Directive, Pipe) for better matching.
+
+```bash
+# Search for "Foo" matches FooComponent, FooService, etc.
+ng-explorer foo
+
+# Search only components
+ng-explorer foo --type component
+
+# Search only services
+ng-explorer bar --type injectable
+```
+
+### Find exact construct by name
+
+```bash
+# Exact name match
+ng-explorer FooComponent --exact
+
+# Exact match with verbose output
+ng-explorer BarService --exact --verbose
+```
+
+### List all constructs of a type
+
+```bash
+# List all components
+ng-explorer --type component
+
+# List all services
+ng-explorer --type injectable
+
+# List all directives
+ng-explorer --type directive
+```
+
+### View detailed API information
+
+```bash
+# Show full API details for search results
+ng-explorer foo --verbose
+
+# Exact match with full details
+ng-explorer FooComponent --exact --verbose
+```
+
+### Filter by path
+
+```bash
+# Search in specific directory
+ng-explorer foo --path "apps/web/**"
+
+# Search in library
+ng-explorer bar --path "libs/common/**"
+```
+
+## Output Formats
+
+### List view (default)
+Shows construct type, name, file path, and selector/pipe name in a compact format.
+
+### Verbose view (--verbose)
+Shows complete API information:
+- **Components**: selector, standalone status, inputs, outputs, properties, methods, constructor dependencies
+- **Services/Injectables**: properties, methods, constructor dependencies
+- **Directives**: selector, inputs, outputs, methods
+- **Pipes**: pipe name, pure status
+
+## How to use this skill
+
+When the user asks about Angular components, services, or project structure:
+
+1. Use `ng-explorer` to search for relevant constructs
+2. Interpret the results and explain them to the user
+3. Use `--verbose` when the user needs detailed API information
+4. Use `--exact` when you know the precise name
+
+## Examples
+
+**User asks: "What components do we have for navigation?"**
+```bash
+ng-explorer nav --type component
+```
+
+**User asks: "Show me the API for the AuthService"**
+```bash
+ng-explorer AuthService --exact --verbose --type injectable
+```
+
+**User asks: "What services are in the common library?"**
+```bash
+ng-explorer --type injectable --path "libs/common/**"
+```
+
+**User asks: "Find all directives that handle tooltips"**
+```bash
+ng-explorer tooltip --type directive
+```
+
+## Notes
+
+- Exact search requires the full construct name
+- Results are limited to 50 by default; use `--limit` to show more
+- The tool requires Compodoc documentation to be generated first