Skip to content

Commit

Permalink
changed the name of the extension, updated README and packaged the ex…
Browse files Browse the repository at this point in the history
…tension as " activedoc-0.0.1.vsix"
  • Loading branch information
yaad96 committed Mar 27, 2024
1 parent 4c52d1c commit e6a3ae4
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 21 deletions.
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
# first-extension README
# activeDoc Extension for VSCode

This is the README for your extension "first-extension". After writing up a brief description, we recommend including the following sections.
This is the README for the "activeDoc" extension for VSCode.

# VSCode Extension doesn't have recentSearchedKeywords array
## version 0.0.1.vsix state
- The search keywords of a vscode workspace is not accessible to the VSCode API users. So, `searchedElements` property is not present in the vscode extension
- In mac, clicking on a code snippet on the client (web) app is not redirecting the vscode workspace focused file's intended code snippet as it should.

# running the extension
after cloning the repo, open terminal and run "npm install"
then in the vscode, you can press F5 to run the extension, or there should be a button in the left side of the vscode that looks like
a beetle under the play icon called "Run and Debug".
Clicking on it you should see green play icon.
After that you can refresh the client.
## Features

- Describe the key features.
- Explain how these features improve the user experience or development process.

## Installation

### Running the Extension Codebase

1. After cloning the repo, open a terminal in the project directory.
2. Run `npm install` to install the necessary dependencies.
3. To run the extension in a development environment, press `F5` in VSCode, or click on the "Run and Debug" icon (resembles a beetle under the play icon) on the left sidebar. Then, click on the green play icon to start.

### Installing the Packaged Extension

To install the `.vsix` packaged extension:

1. Open VS Code.
2. Go to the Extensions view by clicking on the square icon on the sidebar or pressing `Ctrl+Shift+X`.
3. Click on the "..." menu at the top of the Extensions view and select "Install from VSIX...".
4. Navigate to the `.vsix` file, select it, and click "Open".

4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 7 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "first-extension",
"displayName": "first_extension",
"name": "activedoc",
"displayName": "ActiveDoc",
"description": "testing",
"version": "0.0.1",
"engines": {
Expand All @@ -11,25 +11,24 @@
],
"activationEvents": [
"onStartupFinished"
]
,
],
"main": "./out/extension.js",
"contributes": {
"commands": [
{
"command": "first-extension.helloWorld",
"command": "activedoc.helloWorld",
"title": "Hello World"
},
{
"command": "extension.mineRules",
"command": "activedoc.mineRules",
"title": "Mine Rules"
}
],
"menus": {
"editor/context": [
{
"when": "editorTextFocus",
"command": "extension.mineRules",
"command": "activedoc.mineRules",
"group": "navigation"
}
]
Expand Down Expand Up @@ -58,4 +57,4 @@
"dependencies": {
"ws": "^8.16.0"
}
}
}
4 changes: 2 additions & 2 deletions src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ export function activate(context: vscode.ExtensionContext) {


// Adding "Mine Rules" command functionality
context.subscriptions.push(vscode.commands.registerCommand('extension.mineRules', () => {
context.subscriptions.push(vscode.commands.registerCommand('activedoc.mineRules', () => {
const editor = vscode.window.activeTextEditor;
if (editor) {
const document = editor.document;
Expand Down Expand Up @@ -216,7 +216,7 @@ export function activate(context: vscode.ExtensionContext) {



context.subscriptions.push(vscode.commands.registerCommand('first-extension.helloWorld', () => {
context.subscriptions.push(vscode.commands.registerCommand('activedoc.helloWorld', () => {
vscode.window.showInformationMessage('Hello World from ActiveDocumentation!');
}));

Expand Down

0 comments on commit e6a3ae4

Please sign in to comment.