Skip to content

Commit 377b533

Browse files
committed
feat: Add AI Context Convention Linters module
1 parent bddb9c9 commit 377b533

File tree

3 files changed

+99
-6
lines changed

3 files changed

+99
-6
lines changed

linters/.context.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,52 @@
11
---
2-
directoryName: linters
2+
module-name: AI Context Convention Linters
3+
related-modules:
4+
- ../examples
5+
version: 1.0.0
36
description: Contains linting tools for validating AI Context Convention files
4-
languages:
7+
diagrams: []
8+
technologies:
59
- Python
610
- TypeScript
11+
conventions:
12+
- Follow language-specific best practices
13+
- Adhere to AI Context Convention Specification
14+
directives:
15+
- Ensure consistency between different language implementations
16+
- Write clear, well-documented code
17+
architecture:
18+
style: Multi-language
19+
components:
20+
- Python linter
21+
- TypeScript linter
22+
data-flow:
23+
- Input files -> Language-specific linter -> Validation results
24+
development:
25+
setup-steps:
26+
- Clone the repository
27+
- Follow language-specific setup instructions in each subdirectory
28+
build-command: See individual linter directories
29+
test-command: See individual linter directories
30+
business-requirements:
31+
key-features:
32+
- Validate structure of context files
33+
- Ensure required fields are present
34+
- Check for proper YAML frontmatter in Markdown files
35+
target-audience: Developers using the AI Context Convention
36+
success-metrics:
37+
- Consistency of linting results across languages
38+
- Adoption rate among project contributors
39+
quality-assurance:
40+
testing-frameworks:
41+
- Language-specific testing frameworks (see subdirectories)
42+
coverage-threshold: 90%
43+
performance-benchmarks:
44+
- Linting speed for various file sizes and complexities
45+
deployment:
46+
platform: GitHub
47+
cicd-pipeline: GitHub Actions
48+
staging-environment: N/A
49+
production-environment: GitHub Releases
750
---
851

952
# Linters Directory

linters/python/.context.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ related-modules:
44
- ../typescript
55
version: 0.0.1
66
description: Python implementation of the AI Context Convention linter (placeholder)
7+
project-type: Linter
8+
diagrams: []
79
technologies:
810
- Python
911
conventions:

linters/typescript/.context.md

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,59 @@
11
---
2-
directoryName: typescript
2+
module-name: TypeScript Linter for AI Context Convention
3+
related-modules:
4+
- ../python
5+
version: 1.0.0
36
description: TypeScript implementation of the AI Context Convention linter
4-
mainFile: typescript_linter.ts
5-
language: TypeScript
6-
dependencies:
7+
project-type: Linter
8+
diagrams: []
9+
technologies:
10+
- TypeScript
11+
- Node.js
712
- js-yaml
813
- markdown-it
14+
conventions:
15+
- Follow TypeScript best practices and coding conventions
16+
- Use strict mode and appropriate type annotations
17+
directives:
18+
- Keep the linter consistent with the Python implementation
19+
- Write unit tests for all functionality
20+
architecture:
21+
style: Module-based
22+
components:
23+
- typescript_linter.ts (main linter script)
24+
- YAML parser
25+
- Markdown parser
26+
- JSON parser
27+
data-flow:
28+
- Input files -> Parser -> Validator -> Output results
29+
development:
30+
setup-steps:
31+
- Install Node.js (v14+) and npm
32+
- Install required dependencies
33+
- Compile TypeScript code
34+
build-command: tsc typescript_linter.ts
35+
test-command: npm test
36+
business-requirements:
37+
key-features:
38+
- Validate structure of context files
39+
- Ensure required fields are present
40+
- Check for proper YAML frontmatter in Markdown files
41+
- Verify content adheres to AI Context Convention Specification
42+
target-audience: Developers using the AI Context Convention
43+
success-metrics:
44+
- Accuracy of linting results
45+
- Performance on large codebases
46+
quality-assurance:
47+
testing-frameworks:
48+
- Jest
49+
coverage-threshold: 90%
50+
performance-benchmarks:
51+
- Linting speed for various file sizes and complexities
52+
deployment:
53+
platform: npm
54+
cicd-pipeline: GitHub Actions
55+
staging-environment: npm staging registry
56+
production-environment: npm public registry
957
---
1058

1159
# TypeScript Linter for AI Context Convention

0 commit comments

Comments
 (0)