Merge pull request #19 from continuedev/nate/list

Nate/list

Author: sestinj

.continue/rules/add-feature.md

@@ -0,0 +1,12 @@
+---
+alwaysApply: false
+---
+
+# Adding a feature
+
+When you want to add a new feature to the CLI, you should take the following steps:
+
+1. Begin by making updates to the [spec](../../spec/index.md) so that the feature is described well in English
+2. Implement the feature to align with the spec, writing unit tests for any pure functions as you go
+3. Check that the tests pass and fix any problems
+4. If a new command was added, or a change was made that would alter the behavior of a command, make sure to update the golden file tests

.gitignore

@@ -21,3 +21,5 @@ bin/
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+.DS_Store

cmd/list.go

@@ -0,0 +1,84 @@
+package cmd
+
+import (
+	"fmt"
+	"rules-cli/internal/formats"
+	"rules-cli/internal/ruleset"
+
+	"github.com/fatih/color"
+	"github.com/spf13/cobra"
+)
+
+// listCmd represents the list command
+var listCmd = &cobra.Command{
+	Use:   "list",
+	Short: "List all rules currently installed in the project",
+	Long: `List all rules currently installed in the project, similar to 'npm list'.
+This command reads from the rules.json file and displays the installed rules
+with their versions in a tree-like format.
+
+The command only reads local files and does not require network access.`,
+	Example: `  rules list`,
+	Args:    cobra.NoArgs,
+	RunE:    runListCommand,
+}
+
+// runListCommand implements the main logic for the list command
+func runListCommand(cmd *cobra.Command, args []string) error {
+	// Get rules.json path
+	rulesJSONPath, err := formats.GetRulesJSONPath(format)
+	if err != nil {
+		return fmt.Errorf("failed to get rules.json path: %w", err)
+	}
+
+	// Load the ruleset
+	rs, err := ruleset.LoadRuleSet(rulesJSONPath)
+	if err != nil {
+		return fmt.Errorf("No rules.json file found in current directory\nRun 'rules init' to initialize a new project")
+	}
+
+	// Display the project name and version
+	color.Cyan("%s@%s", rs.Name, rs.Version)
+
+	// Check if rules are empty
+	if len(rs.Rules) == 0 {
+		color.Yellow("(empty)")
+		return nil
+	}
+
+	// Sort rules for consistent output
+	ruleNames := make([]string, 0, len(rs.Rules))
+	for name := range rs.Rules {
+		ruleNames = append(ruleNames, name)
+	}
+
+	// Simple alphabetical sort
+	for i := 0; i < len(ruleNames); i++ {
+		for j := i + 1; j < len(ruleNames); j++ {
+			if ruleNames[i] > ruleNames[j] {
+				ruleNames[i], ruleNames[j] = ruleNames[j], ruleNames[i]
+			}
+		}
+	}
+
+	// Display rules in tree format
+	for i, name := range ruleNames {
+		version := rs.Rules[name]
+
+		// Use appropriate tree characters
+		var prefix string
+		if i == len(ruleNames)-1 {
+			prefix = "└── "
+		} else {
+			prefix = "├── "
+		}
+
+		fmt.Printf("%s%s@%s\n", prefix, name, version)
+	}
+
+	return nil
+}
+
+func init() {
+	rootCmd.AddCommand(listCmd)
+}

spec/commands/list.md

@@ -0,0 +1,74 @@
+# Rules List Command
+
+## Overview
+
+The `rules list` command displays all rules currently installed in the project, similar to `npm list`. It reads from the `rules.json` file and shows the installed rules with their versions in a tree-like format.
+
+## Usage
+
+```bash
+rules list [flags]
+```
+
+## Behavior
+
+1. **Check for rules.json**: Verifies that a `rules.json` file exists in the current directory
+2. **Parse Dependencies**: Reads and parses the rules from the `rules.json` file
+3. **Display Tree**: Shows the rules in a hierarchical tree format with versions
+
+## Output Format
+
+### Default Tree Format
+
+```
+[email protected]
+├── [email protected]
+├── workos/[email protected]
+└── gh:owner/[email protected]
+```
+
+## Error Cases
+
+### No rules.json Found
+
+```
+Error: No rules.json file found in current directory
+Run 'rules init' to initialize a new project
+```
+
+**Exit Code**: 1
+
+### Invalid rules.json Format
+
+```
+Error: Invalid rules.json format
+Failed to parse JSON: <error details>
+```
+
+**Exit Code**: 1
+
+### Empty Rules
+
+When no rules are installed:
+
+```
+[email protected]
+(empty)
+```
+
+## Examples
+
+### Basic Usage
+
+```bash
+$ rules list
+[email protected]
+├── [email protected]
+├── workos/[email protected]
+└── gh:owner/[email protected]
+```
+
+## Implementation Notes
+
+- Should be fast and not require network calls (only reads local files)
+- Should respect terminal width for formatting

spec/index.md

@@ -24,6 +24,7 @@ rules-cli/
 │   ├── create.go       # Create command
 │   ├── add.go          # Add command
 │   ├── remove.go       # Remove command
+│   ├── list.go       # List command
 │   ├── render.go       # Render command
 │   ├── install.go      # Install command
 │   ├── publish.go      # Publish command
@@ -82,6 +83,7 @@ This is the body of the rule. It supports Markdown syntax.
 - [`rules create`](commands/create.md) - Creates a new rule file in the rules directory
 - [`rules add`](commands/add.md) - Adds a rule to the project
 - [`rules remove`](commands/remove.md) - Removes a rule from the project
+- [`rules list`](commands/list.md) - Lists all rules currently installed in the project
 - [`rules render`](commands/render.md) - Renders existing rules to a specified format
 - [`rules install`](commands/install.md) - Synchronizes the `.rules` directory with the contents of `rules.json`
 

tests/golden/h/help.golden

@@ -14,6 +14,7 @@ Available Commands:
   help        Help about any command
   init        Initialize a new rules directory
   install     Synchronize rules directory with rules.json
+  list        List all rules currently installed in the project
   login       Authenticate with the registry service
   logout      Log out from the registry service
   publish     Publish a rule package to the registry