https://github.com/akash-nath29/coderesq
https://github.com/akash-nath29/coderesq
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/akash-nath29/coderesq
- Owner: Akash-nath29
- Created: 2025-03-29T09:33:09.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-03-30T06:22:41.000Z (about 1 month ago)
- Last Synced: 2025-03-30T06:24:46.882Z (about 1 month ago)
- Language: TypeScript
- Size: 67.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# CodeResQ: Simplified User Guide
Welcome to **CodeResQ**, your friendly code-assistant that helps you detect vulnerabilities, analyze code complexity, and refactor your Python, TypeScript, and JavaScript code efficiently—right inside Visual Studio Code!
## 🧑💻 What does CodeResQ do?
CodeResQ makes coding safer and easier by:
- **Finding Vulnerabilities:** Automatically highlights potential security issues directly within your code.
- **Analyzing Complexity:** Easily checks how complex your code is, making it simpler to maintain.
- **Code Refactoring:** Automatically improves your code, making it cleaner and faster without changing its functionality.
---
## 🚀 Getting Started with CodeResQ
### Step 1: Installation
- Open **Visual Studio Code**.
- Go to the **Extensions** panel on the left sidebar (`Ctrl+Shift+X`).
- Search for **"CodeResQ"** in the search bar.
- Click on **"Install"**.
### Step 2: Activate CodeResQ
Once installed, CodeResQ automatically activates whenever you open a Python, TypeScript, or JavaScript file.
### Step 3: Using CodeResQ
When you open a Python, TypeScript, or JavaScript file:
- CodeResQ will **automatically scan** your code and highlight vulnerabilities with red wavy underlines.
- Hover your mouse over underlined lines to see detailed descriptions of the issues.
---
## 🎯 CodeResQ Features Explained
### 🔍 Analyze Selection
1. Highlight any section of your Python, TypeScript, or JavaScript code.
2. Click on the **"Analyze Selection"** button at the top.
3. Instantly see if there are security vulnerabilities in your selected code.
### 📈 Check Complexity
1. Select any function or section of your Python, TypeScript, or JavaScript code.
2. Click on the **"Check Complexity"** button.
3. Get an immediate summary of how easy or difficult your code is to maintain.
### 🛠️ Refactor Your Code
1. Select the Python, TypeScript, or JavaScript function or code you want to improve.
2. Click on the **"Refactor Selection"** button.
3. CodeResQ automatically improves your code, clearly showing you the optimized code on top and preserving the original code safely commented below.
---
## 💡 Tips for Best Use
- Regularly use **"Analyze Selection"** to keep your code secure.
- Frequently check complexity to maintain high-quality, readable code.
- Confidently use the refactoring tool—CodeResQ ensures the original code is preserved and commented for easy review.
---
Happy Coding with CodeResQ!