feat: Add TypeScript linter for AI Context Convention files

Author: killerapp

linters/typescript/.npmignore

@@ -0,0 +1,29 @@
+# Source files
+src/
+
+# TypeScript config
+tsconfig.json
+
+# Development files
+.gitignore
+.npmignore
+
+# Tests
+__tests__/
+*.test.ts
+
+# Editor directories and files
+.vscode/
+.idea/
+
+# Logs
+*.log
+
+# Environment variables
+.env
+
+# Build artifacts
+*.tsbuildinfo
+
+# Dependency directories
+node_modules/

linters/typescript/README.md

@@ -1,111 +1,87 @@
 # AI Context Convention TypeScript Linter
 
-This is a TypeScript implementation of the linter for validating AI Context Convention files.
+This is a TypeScript-based CLI linter for validating AI Context Convention files, including `.context.md`, `.context.yaml`, `.context.json`, `.contextdocs.md`, and `.contextignore` files.
 
 ## Installation
 
-1. Ensure you have Node.js (v14+) and npm installed.
-2. Clone the entire repository:
-   ```
-   git clone https://github.com/your-repo/ai-context-convention.git
-   ```
-3. Navigate to the `linters/typescript` directory:
-   ```
-   cd ai-context-convention/linters/typescript
-   ```
-4. Run `npm install` to install the dependencies.
-
-## Usage
-
-To use the TypeScript linter:
-
-1. Build the TypeScript code:
-   ```
-   npm run build
-   ```
-
-2. Run the linter on a directory:
-   ```
-   npm run lint <directory_to_lint>
-   ```
-
-   Replace `<directory_to_lint>` with the path to the directory containing the context files you want to lint.
-
-   Note: You can use relative paths. For example, to lint the parent directory:
-   ```
-   npm run lint ../..
-   ```
-
-## Example Output
-
-When you run the linter, you'll see output similar to this:
+You can install the linter globally using npm:
 
 ```
-========================================================
-AI Context Convention TypeScript Linter (v1.0.0)
-========================================================
+npm install -g ai-context-convention-linter
+```
 
-Linting directory: ../..
+## Usage
 
-Linting file: .context.md
-  - Validating Markdown structure
-  - Checking YAML frontmatter
-  - Verifying content against AI Context Convention Specification
+After installation, you can use the linter from the command line:
 
-Linting completed.
+```
+ai-context-lint <directory_to_lint>
 ```
 
-## Features
+Replace `<directory_to_lint>` with the path to the directory containing your AI Context Convention files.
 
-The TypeScript linter performs the following checks:
+## Features
 
-- Identifies and processes .context.md, .context.yaml, and .context.json files
-- Validates the structure of context files
-- Ensures required fields are present
-- Checks for proper YAML frontmatter in Markdown files
-- Verifies the content adheres to the AI Context Convention Specification
+- Validates the structure and content of `.context.md`, `.context.yaml`, and `.context.json` files
+- Checks for required fields and sections
+- Verifies the format of `.contextdocs.md` files
+- Validates ignore patterns in `.contextignore` files
+- Provides detailed error messages and warnings
 
 ## Development
 
-To contribute to the development of this linter:
+To contribute to this project:
 
-1. Make your changes in the `typescript_linter.ts` file.
-2. Build the TypeScript code:
+1. Clone the repository:
    ```
-   npm run build
+   git clone https://github.com/your-repo/ai-context-convention-typescript-linter.git
+   cd ai-context-convention-typescript-linter
    ```
-3. Test your changes by running the linter on sample files.
 
-Note: The `dist` directory, which contains the compiled JavaScript files, is ignored by git. Make sure to rebuild the project after making changes.
+2. Install dependencies:
+   ```
+   npm install
+   ```
 
-## Contributing
+3. Build the project:
+   ```
+   npm run build
+   ```
 
-When working on the TypeScript linter:
+4. To test the CLI locally, you can use:
+   ```
+   npm link
+   ```
+   This will create a symlink to your local development version of the package.
 
-1. Follow TypeScript best practices and coding conventions.
-2. Use strict mode and appropriate type annotations.
-3. Write unit tests for new functionality.
-4. Keep the linter consistent with other language implementations.
-5. Update comments and documentation as necessary.
+5. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+6. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+7. Push to the branch (`git push origin feature/AmazingFeature`)
+8. Open a Pull Request
 
-Refer to the main README.md in the project root for the full AI Context Convention Specification and contribution guidelines.
+## Publishing to npm
 
-## Troubleshooting
+To publish the package to npm:
 
-If you encounter any issues:
+1. Make sure you have an npm account and are logged in:
+   ```
+   npm login
+   ```
 
-1. Ensure you've run `npm install` to install all dependencies.
-2. Make sure you've built the project using `npm run build` before running the linter.
-3. Check that you're in the correct directory (`linters/typescript`) when running npm commands.
-4. If you see "unknown" as the version number, it means the linter couldn't read the package.json file. This doesn't affect functionality but you may want to check file permissions.
+2. Update the version in `package.json`:
+   ```
+   npm version patch # for bug fixes
+   npm version minor # for new features
+   npm version major # for breaking changes
+   ```
 
-## License
+3. Publish the package:
+   ```
+   npm publish
+   ```
 
-This project is licensed under the ISC License.
+Note: Make sure you have the necessary permissions to publish to the npm registry under the chosen package name.
 
-## Future Enhancements
+## License
 
-- Integration with VSCode extension for in-editor linting
-- More detailed error reporting and suggestions for fixing issues
-- Configuration options for customizing linting rules
-- Support for custom file extensions and naming conventions
+This project is licensed under the ISC License.

linters/typescript/package.json

@@ -1,23 +1,40 @@
 {
-  "name": "ai-context-convention-typescript-linter",
-  "version": "1.0.0",
-  "description": "TypeScript linter for AI Context Convention files",
+  "name": "ai-context-convention-linter",
+  "version": "0.0.1",
+  "description": "CLI linter for AI Context Convention files",
   "main": "dist/typescript_linter.js",
+  "bin": {
+    "ai-context-lint": "./dist/cli.js"
+  },
   "scripts": {
     "build": "tsc",
-    "start": "node dist/typescript_linter.js",
-    "lint": "node dist/typescript_linter.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "start": "node dist/cli.js",
+    "lint": "node dist/cli.js",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "npm run build"
   },
-  "keywords": ["linter", "typescript", "ai", "context", "convention"],
-  "author": "",
+  "keywords": ["linter", "typescript", "ai", "context", "convention", "cli"],
+  "author": "Your Name <[email protected]>",
   "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/your-repo/ai-context-convention-typescript-linter.git"
+  },
+  "bugs": {
+    "url": "https://github.com/your-repo/ai-context-convention-typescript-linter/issues"
+  },
+  "homepage": "https://github.com/your-repo/ai-context-convention-typescript-linter#readme",
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",
     "@types/markdown-it": "^14.1.2",
     "@types/node": "^22.5.1",
-    "js-yaml": "^4.1.0",
-    "markdown-it": "^14.1.0",
     "typescript": "^5.5.4"
+  },
+  "dependencies": {
+    "js-yaml": "^4.1.0",
+    "markdown-it": "^14.1.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
   }
 }

linters/typescript/src/cli.ts

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+
+import { TypeScriptLinter } from './typescript_linter';
+import { getPackageVersion } from './utils';
+
+async function main() {
+  const args = process.argv.slice(2);
+  if (args.length !== 1) {
+    console.error(`
+Usage: ai-context-lint <directory_to_lint>
+
+AI Context Convention TypeScript Linter
+This tool validates context files, including .contextdocs.md and .contextignore, according to the AI Context Convention Specification.
+`);
+    process.exit(1);
+  }
+
+  const directoryToLint = args[0];
+  const packageVersion = await getPackageVersion();
+  const linter = new TypeScriptLinter();
+  await linter.lintDirectory(directoryToLint, packageVersion);
+}
+
+main().catch(error => {
+  console.error('An error occurred:', error);
+  process.exit(1);
+});