threadlines 0.1.0 → 0.1.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.
- package/README.md +56 -2
- package/package.json +1 -2
package/README.md
CHANGED
|
@@ -25,7 +25,61 @@ threadlines check
|
|
|
25
25
|
- `THREADLINE_API_URL` - Server URL (default: http://localhost:3000)
|
|
26
26
|
- `OPENAI_API_KEY` - Your OpenAI API key (required)
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Threadline Files
|
|
29
29
|
|
|
30
|
-
Create a `/threadlines` folder in your repository
|
|
30
|
+
Create a `/threadlines` folder in your repository. Each markdown file is a threadline defining a code quality standard.
|
|
31
|
+
|
|
32
|
+
### Format
|
|
33
|
+
|
|
34
|
+
Each threadline file must have YAML frontmatter and a markdown body:
|
|
35
|
+
|
|
36
|
+
```markdown
|
|
37
|
+
---
|
|
38
|
+
id: unique-id
|
|
39
|
+
version: 1.0.0
|
|
40
|
+
patterns:
|
|
41
|
+
- "**/api/**"
|
|
42
|
+
- "**/*.ts"
|
|
43
|
+
context_files:
|
|
44
|
+
- "path/to/context-file.ts"
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
# Your Threadline Title
|
|
48
|
+
|
|
49
|
+
Your guidelines and standards here...
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Required Fields
|
|
53
|
+
|
|
54
|
+
- **`id`**: Unique identifier (e.g., `sql-queries`, `error-handling`)
|
|
55
|
+
- **`version`**: Semantic version (e.g., `1.0.0`)
|
|
56
|
+
- **`patterns`**: Array of glob patterns matching files to check (e.g., `["**/api/**", "**/*.ts"]`)
|
|
57
|
+
- **Body**: Markdown content describing your standards
|
|
58
|
+
|
|
59
|
+
### Optional Fields
|
|
60
|
+
|
|
61
|
+
- **`context_files`**: Array of file paths that provide context (always included, even if unchanged)
|
|
62
|
+
|
|
63
|
+
### Example: SQL Queries with Schema Context
|
|
64
|
+
|
|
65
|
+
```markdown
|
|
66
|
+
---
|
|
67
|
+
id: sql-queries
|
|
68
|
+
version: 1.0.0
|
|
69
|
+
patterns:
|
|
70
|
+
- "**/queries/**"
|
|
71
|
+
- "**/*.sql"
|
|
72
|
+
context_files:
|
|
73
|
+
- "schema.sql"
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
# SQL Query Standards
|
|
77
|
+
|
|
78
|
+
All SQL queries must:
|
|
79
|
+
- Reference tables and columns that exist in schema.sql
|
|
80
|
+
- Use parameterized queries (no string concatenation)
|
|
81
|
+
- Include proper indexes for WHERE clauses
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
The `schema.sql` file will always be included as context, even if you're only changing query files.
|
|
31
85
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "threadlines",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Threadline CLI - AI-powered linter based on your natural language documentation",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"bin": {
|
|
@@ -45,4 +45,3 @@
|
|
|
45
45
|
"typescript": "^5.7.2"
|
|
46
46
|
}
|
|
47
47
|
}
|
|
48
|
-
|