threadlines 0.1.0 → 0.1.2

package/README.md

@@ -25,7 +25,61 @@ threadlines check
 - `THREADLINE_API_URL` - Server URL (default: http://localhost:3000)
 - `OPENAI_API_KEY` - Your OpenAI API key (required)
 
-## Expert Files
+## Threadline Files
 
-Create a `/threadlines` folder in your repository with markdown files. See [Threadline Format](../../docs/EXPERT_FORMAT.md) for details.
+Create a `/threadlines` folder in your repository. Each markdown file is a threadline defining a code quality standard.
+
+### Format
+
+Each threadline file must have YAML frontmatter and a markdown body:
+
+```markdown
+---
+id: unique-id
+version: 1.0.0
+patterns:
+  - "**/api/**"
+  - "**/*.ts"
+context_files:
+  - "path/to/context-file.ts"
+---
+
+# Your Threadline Title
+
+Your guidelines and standards here...
+```
+
+### Required Fields
+
+- **`id`**: Unique identifier (e.g., `sql-queries`, `error-handling`)
+- **`version`**: Semantic version (e.g., `1.0.0`)
+- **`patterns`**: Array of glob patterns matching files to check (e.g., `["**/api/**", "**/*.ts"]`)
+- **Body**: Markdown content describing your standards
+
+### Optional Fields
+
+- **`context_files`**: Array of file paths that provide context (always included, even if unchanged)
+
+### Example: SQL Queries with Schema Context
+
+```markdown
+---
+id: sql-queries
+version: 1.0.0
+patterns:
+  - "**/queries/**"
+  - "**/*.sql"
+context_files:
+  - "schema.sql"
+---
+
+# SQL Query Standards
+
+All SQL queries must:
+- Reference tables and columns that exist in schema.sql
+- Use parameterized queries (no string concatenation)
+- Include proper indexes for WHERE clauses
+```
+
+The `schema.sql` file will always be included as context, even if you're only changing query files.
 

package/dist/commands/check.js

@@ -52,7 +52,8 @@ async function checkCommand(options) {
         const threadlines = await (0, experts_1.findThreadlines)(repoRoot);
         console.log(chalk_1.default.green(`✓ Found ${threadlines.length} threadline(s)\n`));
         if (threadlines.length === 0) {
-            console.log(chalk_1.default.yellow('⚠️  No valid threadlines found. Add threadline files to /threadlines folder.'));
+            console.log(chalk_1.default.yellow('⚠️  No valid threadlines found.'));
+            console.log(chalk_1.default.gray('   Run `npx threadlines init` to create your first threadline.'));
             process.exit(0);
         }
         // 2. Get git diff

package/dist/commands/init.js

@@ -0,0 +1,103 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initCommand = initCommand;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const TEMPLATE = `---
+id: example-threadline
+version: 1.0.0
+patterns:
+  - "**/*.ts"
+  - "**/*.tsx"
+context_files: []
+---
+
+# Example Threadline
+
+Describe your coding standard or convention here.
+
+This threadline will check all TypeScript files (\`**/*.ts\` and \`**/*.tsx\`) against the guidelines you define below.
+
+## Guidelines
+
+- Add your first guideline here
+- Add your second guideline here
+- Add examples or patterns to follow
+
+## Examples
+
+\`\`\`typescript
+// Good example
+\`\`\`
+
+\`\`\`typescript
+// Bad example - avoid this
+\`\`\`
+`;
+async function initCommand() {
+    const repoRoot = process.cwd();
+    const threadlinesDir = path.join(repoRoot, 'threadlines');
+    const exampleFile = path.join(threadlinesDir, 'example.md');
+    try {
+        // Create threadlines directory if it doesn't exist
+        if (!fs.existsSync(threadlinesDir)) {
+            fs.mkdirSync(threadlinesDir, { recursive: true });
+            console.log(chalk_1.default.green(`✓ Created /threadlines directory`));
+        }
+        // Check if example file already exists
+        if (fs.existsSync(exampleFile)) {
+            console.log(chalk_1.default.yellow(`⚠️  ${exampleFile} already exists`));
+            console.log(chalk_1.default.gray('   Edit it to create your threadline, or delete it and run init again.'));
+            return;
+        }
+        // Write template file
+        fs.writeFileSync(exampleFile, TEMPLATE, 'utf-8');
+        console.log(chalk_1.default.green(`✓ Created ${exampleFile}`));
+        console.log('');
+        console.log(chalk_1.default.blue('Next steps:'));
+        console.log(chalk_1.default.gray('  1. Edit threadlines/example.md with your coding standards'));
+        console.log(chalk_1.default.gray('  2. Rename it to something descriptive (e.g., error-handling.md)'));
+        console.log(chalk_1.default.gray('  3. Run: npx threadlines check'));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red(`\n❌ Error: ${error.message}`));
+        process.exit(1);
+    }
+}

package/dist/index.js

@@ -3,14 +3,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const check_1 = require("./commands/check");
+const init_1 = require("./commands/init");
 const program = new commander_1.Command();
 program
-    .name('threadline')
+    .name('threadlines')
     .description('AI-powered linter based on your natural language documentation')
     .version('0.1.0');
+program
+    .command('init')
+    .description('Create a template threadline file to get started')
+    .action(init_1.initCommand);
 program
     .command('check')
-    .description('Check code against your experts')
+    .description('Check code against your threadlines')
     .option('--api-url <url>', 'Threadline server URL', process.env.THREADLINE_API_URL || 'http://localhost:3000')
     .option('--api-key <key>', 'OpenAI API key', process.env.OPENAI_API_KEY)
     .action(check_1.checkCommand);

package/dist/validators/experts.js

@@ -42,12 +42,12 @@ const REQUIRED_FIELDS = ['id', 'version', 'patterns'];
 async function findThreadlines(repoRoot) {
     const expertsDir = path.join(repoRoot, 'threadlines');
     if (!fs.existsSync(expertsDir)) {
-        throw new Error('No /threadlines folder found. Create a /threadlines folder with your threadline markdown files.');
+        throw new Error('No /threadlines folder found. Run `npx threadlines init` to create your first threadline.');
     }
     const files = fs.readdirSync(expertsDir);
     const expertFiles = files.filter(f => f.endsWith('.md'));
     if (expertFiles.length === 0) {
-        throw new Error('No threadline files found in /threadlines folder. Add .md files with threadline definitions.');
+        throw new Error('No threadline files found in /threadlines folder. Run `npx threadlines init` to create a template.');
     }
     const threadlines = [];
     for (const file of expertFiles) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "threadlines",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Threadline CLI - AI-powered linter based on your natural language documentation",
   "main": "dist/index.js",
   "bin": {
@@ -45,4 +45,3 @@
     "typescript": "^5.7.2"
   }
 }
-