Welcome to the README for the codestory VS Code extension. This extension is designed to help you manage project information, code snippets, and generate structured content, making it easier for you to work on projects by synthesizing code, questions, principles, and additional context.
Features
Project Information Management: View and edit important project details such as project description, question to answer, and generation principles directly in the sidebar.
Code Snippets Integration: Automatically fetch and display code from your project files, allowing you to reference relevant parts of your codebase quickly.
Synthesize Functionality: Combine project background, questions, principles, and code into a well-structured document that can be easily accessed and copied.
Interactive Webview Interface: Access all features via an interactive Webview interface inside VS Code that lets you browse files, select content, and see everything in one place.
Requirements
Visual Studio Code: Version 1.60.0 or higher
TypeScript: This extension is developed using TypeScript, so make sure to have the necessary environment to support TypeScript development.
Extension Settings
codestory does not require specific settings to be configured by the user. However, it provides functionality to manage project information, principles, and code, which is automatically populated from the codestory.json file located at the root of your workspace.
Known Issues
Code Fetching: If files are in folders excluded from the workspace or ignored in .vscode/settings.json, they might not be included in the synthesized content.
Initial Load: The first time you load the extension in a workspace without a codestory.json, you may encounter a delay while the extension initializes the file structure.
Release Notes
1.0.1
fix bug: the generation process of code will overwrite other json sections.
1.0.0
Initial release of codestory extension.
Added support for viewing and editing project information (background, question, principles).
Introduced functionality to synthesize information from code, principles, and project description into a structured format.
Added interactive Webview for managing project information and code content.
Following Extension Guidelines
Ensure that you've read through the VS Code Extension Guidelines to maintain the best practices for building and releasing your extension.
