surya742/intellectify

A smart VS-Code extension

VS Code Extension - Smart Automations

Your smart companion for your educational journey.

Run Locally

Clone the project

  git clone https://link-to-project

Go to the project directory

  cd my-project

Install dependencies

  npm install

Open it in VS Code and start the server

  Press F5

Features

• Allows for code collaboration between different programming languages. (Code conversion from one programming language to another).
• Writing programming code using instructions in any natural language(e.g. English, Hindi, etc..).
• Automatically generates documentation for all provided code functions and classes.
• Semantic search in any file.
• Summarization of any provided text.
• Language Translation
• Question & Answer feature

Demo

Code conversion

• In first-line write from which language you want to Convert and to which language you want to Convert in. (Preferably commented)
• In the second line write the "From_Language_Name" followed by a colon (":"). (Preferably commented)
• From the third line onwards write your code.
• The last line will be "To_Language_Name" followed by a colon (":"). (Preferably commented)
• Now select the whole text and Open the Command Palette (Ctrl+Shift+P).
• Select Intellectify: Convert code Format:

  "From_Language_Name" to "To_Language_Name"
  "From_Language_Name:"
   Your_Code
  "To_Language_Name:"

Generate code from instructions

• Write proper step-wise instructions to get the desired result.
• Use any language for writing instructions, here I've shown two demos, one in English and one in Hindi.
• Now select the whole text and Open the Command Palette (Ctrl+Shift+P).
• Select Intellectify: Write code

Generate documentation

• [imp.] Leave at least one empty line at the bottom of your selected text and do not include this empty line in your selection. (Else whole code will be commented out)
• Now select the required code snippets for its documentation and Open the Command Palette (Ctrl+Shift+P).
• Select Intellectify: Generate documentation

Semantic search

• [imp.] Do not search in a file having more than 1800 tokens, search on a small file as this API have a limit for now hence request will get failed if the limit exceeds.
• Open any file and Open the Command Palette (Ctrl+Shift+P).
• Select Intellectify: Do semantic search, an input search box will appear.
• Search anything with logical sense and Press Enter.
• Whichever line is making most sense with your search will be get highlighted with viewpoint centered.

Text summarization

• Open any file and Open the Command Palette (Ctrl+Shift+P).
• Select the portion of the file (or whole file) of which you want to get a summary of.
• Select Intellectify: Summarize.
• Summary will be get printed above the selected area.

Language Translation

• Select the portion of the file (or whole file) which you want to translate.
• Select Intellectify: Convert code.
• Traslation will be get printed above the selected area.

Requirements

Open AI API Key - visit the website to get one.

Extension settings

• Disable SSL Verification in your VS Code manually on a temporary basis in order to make this Extension run.
• Follow these steps to Disable SSL Verification ("http.systemCertificates": false,):

  1. Open user settings in VSCode.
  2. Now click on "Application",
  3. Now click on "Proxy".
  4. Uncheck "System Certificates".

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

OPENAI_API

Make sure to checkout the the path of .env file while importing it into the extension.js file.

Release Notes

0.1.0

Initial release

Author

• @Surya742

intellectify's Issues

The extension is not working

After following all the steps when I press F5, a new window opens for the extension. But after 10 secs there is an error pop-up saying the extension did not run in 10 secs. What is this about? I am unable to fix it.

Installing the plugin

once i have a project open this is my error

I am error Error: Request failed with status code 401
at createError (g:\Intellectify\node_modules\axios\lib\core\createError.js:16:15)
at settle (g:\Intellectify\node_modules\axios\lib\core\settle.js:17:12)
at IncomingMessage.handleStreamEnd (g:\Intellectify\node_modules\axios\lib\adapters\http.js:312:11)
at IncomingMessage.emit (G:\Intellectify\lib\events.js:538:35)
at endReadableNT (G:\Intellectify\lib\internal\streams\readable.js:1345:12)
at process.processTicksAndRejections (node:internal/process/task_queues:83:21) {config: {…}, request: ClientRequest, response: {…}, isAxiosError: true, toJSON: ƒ, …}

arg1:
Error: Request failed with status code 401\n\tat createError (g:\Intellectify\node_modules\axios\lib\core\createError.js:16:15)\n\tat settle (g:\Intellectify\node_modules\axios\lib\core\settle.js:17:12)\n\tat IncomingMessage.handleStreamEnd (g:\Intellectify\node_modules\axios\lib\adapters\http.js:312:11)\n\tat IncomingMessage.emit (node:events:538:35)\n\tat endReadableNT (node:internal/streams/readable:1345:12)\n\tat process.processTicksAndRejections (node:internal/process/task_queues:83:21) {config: {…}, request: ClientRequest, response: {…}, isAxiosError: true, toJSON: ƒ, …}
f @ d:\Users\vamp\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:98:6

Run locally from a docker container on a dev machine/build server

I've been able to create an docker image, and run a docker container using a docker-compose file.

How can Intellectify hook in to my local dev enviroment ? Do i need to give it access to my local file-system where my projects are saved so it can read the files, or is it better to run my dev-environment from within for example code server with Intellectify intergration ?

(both in a new image while combining them)