codeboltjs/read_lints_example.json at main · codeboltai/codeboltjs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
{
  "tool_definition": {
    "name": "read_lints",
    "description": "Read and display linter errors from the current workspace",
    "parameters": {
      "paths": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Optional. An array of paths to files or directories to read linter errors for. You can use either relative paths in the workspace or absolute paths. If provided, returns diagnostics for the specified files/directories only. If not provided, returns diagnostics for all files in the workspace.",
        "required": false
      }
    }
  },
  "example_calls": {
    "check_single_file": {
      "description": "Check linting errors in a single file",
      "input": {
        "paths": [
          "packages/codeboltjs/src/modules/task.ts"
        ]
      },
      "output_example": {
        "errors": [],
        "message": "No linter errors found."
      }
    },
    "check_multiple_files": {
      "description": "Check linting errors in multiple files",
      "input": {
        "paths": [
          "agents/taskTestAgent/src/index.ts",
          "packages/codeboltjs/src/modules/task.ts",
          "common/types/src/codeboltjstypes/message.enum.ts"
        ]
      },
      "output_example": {
        "errors": [],
        "message": "No linter errors found."
      }
    },
    "check_directory": {
      "description": "Check linting errors in all files within a directory",
      "input": {
        "paths": [
          "packages/codeboltjs/src/modules"
        ]
      },
      "output_example": {
        "errors": [],
        "message": "No linter errors found."
      }
    },
    "check_all_files": {
      "description": "Check linting errors in all files in the workspace",
      "input": {},
      "output_example": {
        "errors": [],
        "message": "No linter errors found."
      }
    }
  },
  "output_format": {
    "description": "When linting errors are found, the output typically includes:",
    "structure": {
      "errors": [
        {
          "file": "path/to/file.ts",
          "line": 42,
          "column": 10,
          "severity": "error",
          "message": "Unexpected any. Specify a different type.",
          "rule": "@typescript-eslint/no-explicit-any",
          "source": "eslint"
        },
        {
          "file": "path/to/file.ts",
          "line": 15,
          "column": 5,
          "severity": "warning",
          "message": "Unused variable 'x'",
          "rule": "@typescript-eslint/no-unused-vars",
          "source": "eslint"
        }
      ]
    },
    "no_errors": {
      "errors": [],
      "message": "No linter errors found."
    }
  },
  "common_use_cases": {
    "after_editing_file": {
      "description": "Check for linting errors after making code changes",
      "example": {
        "paths": [
          "packages/codeboltjs/src/modules/actionPlan.ts"
        ]
      }
    },
    "before_commit": {
      "description": "Check all modified files before committing",
      "example": {
        "paths": [
          "agents/taskTestAgent/src/index.ts",
          "packages/codeboltjs/src/modules/task.ts"
        ]
      }
    },
    "project_wide_check": {
      "description": "Check entire project for linting issues",
      "example": {}
    }
  }
}