Code Prompt Assist

Welcome to Code Prompt Assist, the indispensable Visual Studio Code extension that revolutionizes your coding workflow while prioritizing data privacy.

Code Prompt Assist is unique in its commitment to data privacy with its advanced text redaction feature, making it a pioneer in secure, AI-assisted coding tools.

In today's world, where AI-driven development tools are gaining traction, many organizations remain cautious about using such technologies due to the risk of exposing sensitive information.

Code Prompt Assist is your solution. It features a unique and powerful text redaction tool, ensuring that confidential data never leaves your workspace.

Whether you're an experienced developer or a newcomer, leverage Code Prompt Assist to efficiently generate code solutions, unit tests, and code optimizations, all while safeguarding your company's proprietary information.

Features

0. Effortless Prompt Redaction

Streamline Your Security Practices with Ease: Code Prompt Assist introduces a revolutionary approach to maintaining confidentiality in your coding environment. Our Effortless Prompt Redaction feature allows you to define rules for automatically redacting sensitive information like API keys or personal identifiers from your code. This not only saves time but also significantly enhances the security of your development process. With a few simple configurations, you can ensure that your code remains clean and compliant, free from unintended exposure of critical data.

1. Effortless Code Solutions

Save Time and Simplify Your Workflow: Code Prompt Assist streamlines your coding process by generating code solutions automatically. Just input your file paths and ticket information, and watch as Code Prompt Assist efficiently crafts solutions tailored to your project’s specific needs.

2. Automated Unit Test Generation

Enhance Code Reliability and Reduce Errors: Trust Code Prompt Assist to fortify your code's robustness. With our automated unit test generation feature, your code undergoes a thorough analysis, leading to the creation of comprehensive unit tests. This pivotal feature assists in identifying bugs early and elevating your code quality.

3. Intelligent Code Optimizations

Optimize Performance with Smart Insights: Code Prompt Assist isn’t just about writing code; it’s about writing better code. By offering suggestions for code optimizations, this tool provides invaluable insights into performance enhancements and best coding practices, all uniquely adapted to your existing codebase.

Visual Showcase: See Code Prompt Assist in Action

Explore how Code Prompt Assist transforms your coding experience with our carefully curated visuals. Each image and animation is designed to give you a glimpse of the power and simplicity of our tool.

0. Add in settings for redaction
1. Code Solution Generation: Code Solution Generation
2. Unit Test Creation: Unit Test Creation
3. Code Optimization Suggestions: Code Optimization

Tip: Witness Code Prompt Assist's capabilities through these short, focused animations, demonstrating its ease of use and powerful features. Requirements

Feature 0: Effortless Prompt Redaction

Crafting precise code prompts with ease - see how Code Prompt Assist automates code redaction.

Feature 1: Effortless Code Solutions

Crafting precise code solutions with ease - see how Code Prompt Assist automates and simplifies complex tasks.

Feature 2: Redacted Unit Test Generation

Reliability at its best - our extension automatically generates comprehensive readacted promps for unit tests.

Feature 3: Redacted Code Optimisation

Reliability at its best - our extension automatically generates comprehensive readacted promps for code optimisation.

Before installing Code Prompt Assist, ensure you have the following

• Visual Studio Code (version 1.XX or higher)

This extension contributes to the following settings

Redaction Rules

How To Configure Redaction Rules

1. Open Redaction Settings Tab: In Visual Studio Code, navigate to the Code Assist extension and open the 'Configure Redaction Settings' tab.
2. Enter Redaction Rules:

• Original Text: Enter the text string you wish to redact.
• Replacement Text (optional): Enter the text you want to replace the original text with. If left empty, the extension will automatically use a placeholder in the format `redactedN``.
• Click Add Rule to save the rule.

3. Manage Rules: The added rules will be listed in the tab. You can review and manage these rules directly from this interface.
4. Apply Changes: The extension will automatically apply these rules to redact strings in the generated code according to your configuration.

Understanding the Configuration:

• Original Text: This is the string that you want to redact from the code.
• Replacement Text (Optional): This is what will replace the Original Text in the code. If you do not specify a replacement, the extension uses a default format: redactedN, where N is a unique number.
• The extension applies the replacement to all occurrences of the Original Text in the generated code.
• Using the redactedN format ensures each unique redacted string has a distinct placeholder.

Example

Suppose you want to redact API keys and usernames in your code:

Suppose you want to redact API keys and usernames in your code:

• Open the Redaction Rules Settings tab.
  • For API keys, you might add:
    • Original Text: apiKey
    • Replacement Text: `confidentialKey``
  • For usernames, where you prefer an automatic placeholder:
    • Original Text: username
    • Leave the Replacement Text blank.
    • Click Add Rule after entering each set of texts.

These rules ensure that any occurrence of "apiKey" in your code will be replaced with "confidentialKey", and "username" will be replaced with a placeholder like "redacted1".

Installation Guide

1. Open Visual Studio Code: Launch your VS Code application.

2. Access Extensions: Click on the Extensions icon in the sidebar or press Ctrl+Shift+X (Cmd+Shift+X on macOS).

3. Search for Code Prompt Assist: Type "Code Prompt Assist" in the Extensions search bar.

4. Install the Extension: Find Code Prompt Assist in the search results and click the 'Install' button.

5. Verify Installation: Once installed, you will see 'Code Prompt Assist' listed in your installed extensions.

Screenshot of the Extensions view in VS Code, highlighting the search and install steps.

Known Issues

Currently no known issues found

Frequently Asked Questions (FAQs)

• Q: Is Code Prompt Assist compatible with all versions of Visual Studio Code?

  • A: Code Prompt Assist is compatible with Visual Studio Code version 1.XX and above. We continually update our extension to ensure compatibility with the latest versions.

• Q: What are the future plans for Code Prompt Assist?

  • A: We are constantly working to improve Code Prompt Assist. Upcoming features include support for additional programming languages and enhanced AI-driven code recommendations. Stay tuned for updates!

• Q: How does Code Prompt Assist compare to similar extensions?

  • A: Code Prompt Assist stands out with its unique text redaction feature, which ensures data privacy, and its focus on optimizing both code generation and unit test creation for JavaScript and TypeScript.

Upcoming Features and Roadmap

We are dedicated to making Code Prompt Assist even better. Here's what's on the horizon:

• Support for More Languages: Expanding beyond JavaScript and TypeScript to include Python, C#, and more.
• Advanced AI Features: Implementing more sophisticated AI algorithms for smarter code suggestions.
• Enhanced User Experience: Continuously refining the interface for an even smoother coding experience.

License

• Refer to LICENSE.txt

Community and Support

Join our vibrant community forum where you can share ideas, ask questions, and get help from both the developers and other users. Visit Code Prompt Assist Forum to get involved. For direct support, feel free to reach out via email. Please note that we aim to respond within 48 hours.

Enjoy coding with ease using Code Prompt Assist!