Skip to content

Commit fc80746

Browse files
committed
remove linter
1 parent 6a112a0 commit fc80746

31 files changed

+62
-12467
lines changed

.github/workflows/release.yml

Lines changed: 0 additions & 37 deletions
This file was deleted.

CODEBASE-CONTEXT.md

Lines changed: 32 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,6 @@ description: A specification for providing explicit context information about a
7777
related-modules:
7878
- name: Context Editor
7979
path: ./examples/context-editor
80-
- name: TypeScript Linter
81-
path: https://github.com/Agentic-Insights/codebase-context-spec/tree/main/linters/typescript
8280
technologies:
8381
- Markdown
8482
- YAML
@@ -94,14 +92,14 @@ architecture:
9492
main-components:
9593
- Specification document
9694
- Context Editor
97-
- TypeScript Linter
95+
- CLI Tool
9896
data-flow:
99-
- Codebase -> .context.md files -> Linter -> Validation results
97+
- Codebase -> .context.md files -> CLI -> Validation results
10098
development:
10199
setup-steps:
102100
- Clone the repository
103101
- Review the specification documents
104-
- Install linter dependencies
102+
- Install dependencies
105103
build-command: npm run build
106104
test-command: npm test
107105
business-requirements:
@@ -119,13 +117,13 @@ quality-assurance:
119117
- Pytest
120118
coverage-threshold: "90%"
121119
performance-benchmarks:
122-
- Linting speed for large codebases
123-
- Memory usage during linting
120+
- Processing speed for large codebases
121+
- Memory usage during processing
124122
deployment:
125123
platform: GitHub
126124
cicd-pipeline: GitHub Actions
127125
staging-environment: GitHub Pages (Documentation)
128-
production-environment: npm registry (Linter package)
126+
production-environment: npm registry (CLI package)
129127
---
130128

131129
# Codebase Context Specification
@@ -138,18 +136,18 @@ The Codebase Context Specification follows a documentation-driven architecture,
138136

139137
1. Specification Document: The core definition of the Codebase Context format and usage.
140138
2. Context Editor: A tool for creating and editing .context.md files.
141-
3. TypeScript Linter: A linter implementation to validate .context.md files against the specification.
139+
3. CLI Tool: A command-line tool to validate .context.md files against the specification.
142140

143141
The data flow in this system is as follows:
144-
Codebase -> .context.md files -> Linter -> Validation results
142+
Codebase -> .context.md files -> CLI -> Validation results
145143

146144
This architecture ensures that the specification is well-defined, easy to implement, and can be validated automatically.
147145

148146
## Development Guidelines
149147

150148
- Follow the conventions listed in the front matter, including Markdown best practices and consistent naming conventions.
151149
- Use YAML for structured data within the .context.md files.
152-
- When contributing to the TypeScript linter, use lowercase and underscores for all .ts files.
150+
- When contributing to the project, use lowercase and underscores for all .ts files.
153151
- Write clear, concise documentation for all components of the specification.
154152
- Use feature branches and pull requests for all changes to the specification or related tools.
155153

@@ -169,7 +167,7 @@ Our QA process ensures high-quality, reliable tools and documentation through:
169167

170168
- Comprehensive unit and integration testing using Jest and Pytest
171169
- Maintaining a test coverage threshold of 90%
172-
- Performance benchmarking for linting speed and memory usage
170+
- Performance benchmarking for processing speed and memory usage
173171
- Regular review and updates to the specification based on community feedback
174172

175173
## Deployment and Operations
@@ -179,7 +177,7 @@ The Codebase Context Specification project is managed and deployed as follows:
179177
1. The specification and related tools are hosted on GitHub
180178
2. GitHub Actions are used for continuous integration and deployment
181179
3. Documentation is hosted on GitHub Pages (staging environment)
182-
4. The TypeScript linter is published as an npm package (production environment)
180+
4. The CLI tool is published as an npm package (production environment)
183181

184182
Regular updates and maintenance are performed to keep the specification and tools up-to-date with evolving development practices and AI capabilities.
185183
```
@@ -197,8 +195,6 @@ description: A specification for providing explicit context information about a
197195
related-modules:
198196
- name: Context Editor
199197
path: ./examples/context-editor
200-
- name: TypeScript Linter
201-
path: https://github.com/Agentic-Insights/codebase-context-spec/tree/main/linters/typescript
202198
technologies:
203199
- Markdown
204200
- YAML
@@ -214,14 +210,14 @@ architecture:
214210
main-components:
215211
- Specification document
216212
- Context Editor
217-
- TypeScript Linter
213+
- CLI Tool
218214
data-flow:
219-
- Codebase -> .context.md files -> Linter -> Validation results
215+
- Codebase -> .context.md files -> CLI -> Validation results
220216
development:
221217
setup-steps:
222218
- Clone the repository
223219
- Review the specification documents
224-
- Install linter dependencies
220+
- Install dependencies
225221
build-command: npm run build
226222
test-command: npm test
227223
business-requirements:
@@ -239,13 +235,13 @@ quality-assurance:
239235
- Pytest
240236
coverage-threshold: "90%"
241237
performance-benchmarks:
242-
- Linting speed for large codebases
243-
- Memory usage during linting
238+
- Processing speed for large codebases
239+
- Memory usage during processing
244240
deployment:
245241
platform: GitHub
246242
cicd-pipeline: GitHub Actions
247243
staging-environment: GitHub Pages (Documentation)
248-
production-environment: npm registry (Linter package)
244+
production-environment: npm registry (CLI package)
249245
```
250246
251247
### 4.3 JSON Format
@@ -263,10 +259,6 @@ Example:
263259
{
264260
"name": "Context Editor",
265261
"path": "./examples/context-editor"
266-
},
267-
{
268-
"name": "TypeScript Linter",
269-
"path": "https://github.com/Agentic-Insights/codebase-context-spec/tree/main/linters/typescript"
270262
}
271263
],
272264
"mainTechnologies": [
@@ -286,17 +278,17 @@ Example:
286278
"mainComponents": [
287279
"Specification document",
288280
"Context Editor",
289-
"TypeScript Linter"
281+
"CLI Tool"
290282
],
291283
"dataFlow": [
292-
"Codebase -> .context.md files -> Linter -> Validation results"
284+
"Codebase -> .context.md files -> CLI -> Validation results"
293285
]
294286
},
295287
"development": {
296288
"setupSteps": [
297289
"Clone the repository",
298290
"Review the specification documents",
299-
"Install linter dependencies"
291+
"Install dependencies"
300292
],
301293
"buildCommand": "npm run build",
302294
"testCommand": "npm test"
@@ -320,15 +312,15 @@ Example:
320312
],
321313
"coverageThreshold": "90%",
322314
"performanceBenchmarks": [
323-
"Linting speed for large codebases",
324-
"Memory usage during linting"
315+
"Processing speed for large codebases",
316+
"Memory usage during processing"
325317
]
326318
},
327319
"deployment": {
328320
"platform": "GitHub",
329321
"cicdPipeline": "GitHub Actions",
330322
"stagingEnvironment": "GitHub Pages (Documentation)",
331-
"productionEnvironment": "npm registry (Linter package)"
323+
"productionEnvironment": "npm registry (CLI package)"
332324
}
333325
}
334326
```
@@ -399,21 +391,21 @@ The `.contextdocs` file should contain an array of documentation sources. Each s
399391
---
400392
contextdocs:
401393
- name: TypeScript
402-
relationship: Main language for linter implementation
394+
relationship: Main language for implementation
403395
resources:
404396
- Official Documentation: https://www.typescriptlang.org/docs/
405397
- TypeScript Handbook: https://www.typescriptlang.org/docs/handbook/intro.html
406398
- TypeScript Deep Dive: https://basarat.gitbook.io/typescript/
407399

408400
- name: Node.js
409-
relationship: Runtime environment for TypeScript linter
401+
relationship: Runtime environment
410402
resources:
411403
- Official Documentation: https://nodejs.org/en/docs/
412404
- Getting Started Guide: https://nodejs.org/en/docs/guides/getting-started-guide/
413405
- Node.js Best Practices: https://github.com/goldbergyoni/nodebestpractices
414406

415407
- name: Jest
416-
relationship: Testing framework for TypeScript linter
408+
relationship: Testing framework
417409
resources:
418410
- Official Documentation: https://jestjs.io/docs/getting-started
419411
- Testing TypeScript with Jest: https://basarat.gitbook.io/typescript/intro-1/jest
@@ -430,21 +422,21 @@ This section can include any free-form text to provide context about the listed
430422
```yaml
431423
contextdocs:
432424
- name: TypeScript
433-
relationship: Main language for linter implementation
425+
relationship: Main language for implementation
434426
resources:
435427
- Official Documentation: https://www.typescriptlang.org/docs/
436428
- TypeScript Handbook: https://www.typescriptlang.org/docs/handbook/intro.html
437429
- TypeScript Deep Dive: https://basarat.gitbook.io/typescript/
438430

439431
- name: Node.js
440-
relationship: Runtime environment for TypeScript linter
432+
relationship: Runtime environment
441433
resources:
442434
- Official Documentation: https://nodejs.org/en/docs/
443435
- Getting Started Guide: https://nodejs.org/en/docs/guides/getting-started-guide/
444436
- Node.js Best Practices: https://github.com/goldbergyoni/nodebestpractices
445437

446438
- name: Jest
447-
relationship: Testing framework for TypeScript linter
439+
relationship: Testing framework
448440
resources:
449441
- Official Documentation: https://jestjs.io/docs/getting-started
450442
- Testing TypeScript with Jest: https://basarat.gitbook.io/typescript/intro-1/jest
@@ -458,7 +450,7 @@ contextdocs:
458450
"contextdocs": [
459451
{
460452
"name": "TypeScript",
461-
"relationship": "Main language for linter implementation",
453+
"relationship": "Main language for implementation",
462454
"resources": [
463455
{
464456
"Official Documentation": "https://www.typescriptlang.org/docs/"
@@ -473,7 +465,7 @@ contextdocs:
473465
},
474466
{
475467
"name": "Node.js",
476-
"relationship": "Runtime environment for TypeScript linter",
468+
"relationship": "Runtime environment",
477469
"resources": [
478470
{
479471
"Official Documentation": "https://nodejs.org/en/docs/"
@@ -488,7 +480,7 @@ contextdocs:
488480
},
489481
{
490482
"name": "Jest",
491-
"relationship": "Testing framework for TypeScript linter",
483+
"relationship": "Testing framework",
492484
"resources": [
493485
{
494486
"Official Documentation": "https://jestjs.io/docs/getting-started"
@@ -531,7 +523,3 @@ contextdocs:
531523
## 8. Conclusion
532524

533525
The Codebase Context Specification provides a flexible, standardized approach to enriching codebases with contextual information for AI models. By adopting this convention and including role-specific information, development teams can enhance AI-assisted workflows, improving code quality and development efficiency across projects of any scale or complexity. The addition of role-specific guidelines and consistent naming conventions ensures that AI models have access to comprehensive, relevant, and well-structured information tailored to different aspects of the software development lifecycle.
534-
535-
## 9. TypeScript Linter Implementation
536-
537-
For details on the TypeScript implementation of the linter for validating Codebase Context Specification files, please refer to the [TypeScript Linter README](linters/typescript/README.md).

GENERATE-CONTEXT-PROMPT.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -190,18 +190,26 @@ When referencing diagrams in the .context.md file:
190190

191191
Remember, the goal is to create .context.md and .contextdocs.md files that provide valuable context for both human developers and AI assistants, enabling more effective collaboration and development on the project.
192192

193-
## Linting and testing the new .context.md and .contextdocs.md
193+
## Validating the .context.md and .contextdocs.md Files
194194

195-
Use the terminal to run the linting command to review the output.
195+
Use the terminal to run the validation command to review the output.
196196
Fix any errors or warnings by reviewing the codebase and filling in the missing pieces.
197197

198-
Usage of official linter for .context.md and .contextdocs.md files:
198+
Usage of the official CLI tool for validating .context.md and .contextdocs.md files:
199199

200-
1. Run the linter from the directory the files are in:
201-
`npx codebase-context-lint .`
202-
2. Repair and re-run until you have full coverage for both files.
203-
3. Pay special attention to the format of the resources in .contextdocs.md, ensuring they are objects with single key-value pairs.
200+
1. Install the CLI tool:
201+
```bash
202+
npm install -g @agentic-insights/cc-cli
203+
```
204204

205-
By following these guidelines and instructions, you should be able to create comprehensive and properly formatted .context.md and .contextdocs.md files that will pass the linter checks and provide valuable context for the project.
205+
2. Run the validation command from the directory containing the files:
206+
```bash
207+
cc validate
208+
```
209+
210+
3. Review any validation errors and fix them according to the specification.
211+
4. Pay special attention to the format of the resources in .contextdocs.md, ensuring they are objects with single key-value pairs.
212+
213+
By following these guidelines and instructions, you should be able to create comprehensive and properly formatted .context.md and .contextdocs.md files that will pass validation and provide valuable context for the project.
206214

207215
Review the CODEBASE-CONTEXT.md file provided for the full specification.

0 commit comments

Comments
 (0)