DROP-I Base Version

Author: soumyaprasadrana

.github/workflows/publish.yaml

@@ -0,0 +1,48 @@
+name: Publish VS Code Extension on Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Step 1: Check out the repository
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Step 2: Set up Node.js (required for vsce)
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'  # specify the Node.js version compatible with your project
+
+      # Step 3: Install dependencies
+      - name: Install dependencies
+        run: npm install
+
+      # Step 4: Package and publish the extension using vsce
+      - name: Publish Extension
+        env:
+          VSCE_TOKEN: ${{ secrets.VSCE_TOKEN }}
+        run: |
+          npm install -g @vscode/vsce
+          vsce package
+          vsce publish || exit 1  # Fail the workflow if publish fails
+
+      # Step 5: Update Release Notes (optional)
+      - name: Update release to published
+        if: success()
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const { context, github } = require('@actions/github');
+            await github.rest.repos.updateRelease({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              release_id: context.payload.release.id,
+              draft: false,   # Make it a published release only if the workflow succeeds
+              prerelease: false
+            });

.gitignore

@@ -1,130 +1,4 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-.pnpm-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
 node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional stylelint cache
-.stylelintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variable files
-.env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
 out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-.temp
-.cache
-
-# Docusaurus cache and generated files
-.docusaurus
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
+classes/
+macros/

.settings/org.eclipse.jdt.core.prefs

@@ -0,0 +1,8 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
+org.eclipse.jdt.core.compiler.compliance=1.8
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.source=1.8

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "extensionHost",
+            "request": "launch",
+            "name": "Launch Extension",
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}"
+            ],
+            "outFiles": [
+                "${workspaceFolder}/out/**/*.js"
+            ],
+            "sourceMaps": true,
+            "trace": true,
+            "preLaunchTask": "${defaultBuildTask}",
+            "autoAttachChildProcesses": true
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+    "java.trace.server": "messages",
+    "java.autobuild.enabled": true,
+    "java.dependency.refreshDelay": 2000,
+    "java.debug.settings.debugSupportOnDecompiledSource": "off",
+    "files.watcherExclude": {
+            "**/.git/objects/**": true,
+            "**/.git/subtree-cache/**": true,
+            "**/node_modules/*/**": true
+        },
+    "redhat.telemetry.enabled":false,
+    "java.settings.url": ".settings/org.eclipse.jdt.core.prefs",
+    "java.debug.settings.onBuildFailureProceed": true,
+
+}

.vscode/tasks.json

@@ -0,0 +1,19 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "watch",
+			"problemMatcher": "$tsc-watch",
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never"
+			},
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		},
+		
+	]
+}

.vscodeignore

@@ -0,0 +1,10 @@
+src/**            
+tests/**          
+node_modules/**   
+*.ts              
+.vscode/**        
+tsconfig.json     
+.eslintrc.json    
+.vscodeignore     
+vscode-java-debugx-ext-bridge/**
+.settings/**

README.md

@@ -1,2 +1,118 @@
-# vscode-java-debugx
-vscode-java-debugx enhances Java debugging in VS Code with advanced features like macro recording, runtime insights, and dynamic method invocation.
+<h1>
+  <img src="media/vscode-java-debugx.gif" alt="Java DebugX" width="100" style="vertical-align: middle;"/>
+  vscode-java-debugx
+</h1>
+
+
+## Overview
+
+**Java DebugX** is a Visual Studio Code extension aimed at improving Java debugging by offering advanced macro recording and playback features. It allows developers to record key debugging events such as step-in, step-out, and breakpoints in a macro JSON format. This feature enables users to capture complex debugging sessions and replay them later, saving time and eliminating the need to manually redo the debugging process.
+
+
+## Features
+
+- **Macro Recording and Playback**: Record debugging sessions, including step-ins, step-outs, and breakpoints. Play back the recorded sessions at any time.
+- **Customizable Bridge Configurations**: Define custom bridge classes and methods to integrate additional debugging insights.
+- **Advanced Debug Insights**: View detailed, real-time debugging information in a dedicated Insights view.
+- **Search External Files**: Search and index external files during debugging to improve traceability.
+- **Customizable File Patterns**: Define which files to include when indexing external files.
+
+
+
+
+## Installation
+
+To install the **Java DebugX** extension in Visual Studio Code:
+
+1. Open **Visual Studio Code**.
+2. Go to the **Extensions** view by clicking on the Extensions icon in the Activity Bar or pressing `Ctrl+Shift+X`.
+3. Search for **Vscode Java DebugX**.
+4. Click **Install**.
+
+Alternatively, you can install it directly from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=soumyaprasadrana.vscode-java-debugx).
+
+## Getting Started
+
+Once installed, the extension is activated when a Java project is opened. You can then start using the extension to record, play, and analyze debugging sessions.
+
+### Key Features and Commands
+
+- **Start Macro Recording**: Begin recording your debugging session. This will capture step-ins, step-outs, and breakpoints.
+- **Stop Macro Recording**: Stop recording and save the session data.
+- **Play Macro Recording**: Re-execute the recorded session.
+- **Pause/Resume/Stop Macro Playback**: Pause,resume or stop the playback of your recorded debugging session.
+- **Generate Sample Bridge Config**: Generate a sample configuration file to set up your custom bridge and define commands.
+- **Debug Insights**: View detailed insights from bridge configuration into your debugging session through a dedicated panel.
+
+You can access these commands via the **Command Palette** (`Ctrl+Shift+P`), or find them in the **JavaDebugX** menu.
+
+*You can add screenshots or GIFs of key actions here to guide users through the workflow.*
+
+## Configuration
+
+You can configure the extension by modifying the settings in your `settings.json`. The available settings are:
+
+- **java.debugx.filePatterns**: Define file patterns to include when indexing external files (e.g., `*.java`, `*.js`, `*.xml`).
+- **java.debugx.externalFolder**: Set the path to an external folder that you want to index.
+- **java.debugx.macro.stepDelayInSeconds**: Configure the step delay during macro playback.
+- **java.debugx.bridgeConfigPath**: Set the absolute path to your custom bridge configuration file.
+
+You can access and modify these settings in the **Settings** tab or directly in your `settings.json` file.
+
+## Views and Menus
+
+- **Insights View**: A dedicated view to show real-time debugging insights.
+![DebugInsightView](/media/vscode-java-debugx-bridge-insights.gif)
+
+- **Debug Toolbar**: Commands for controlling the macro recording and playback are available in the debug toolbar.
+
+*You can add a screenshot or GIF of the Insights view here.*
+
+## Example Usage
+
+### Generating a Sample Bridge Config
+
+To generate a sample bridge configuration file:
+
+1. Open the Command Palette (`Ctrl+Shift+P`).
+2. Search for and select **Generate Sample Bridge Config**.
+
+This will generate a new bridge configuration file in your workspace, which you can modify to create your custom bridge logic.
+
+![DebugInsight](/media/vscode-java-debugx-bridge.gif)
+
+## Development
+
+If you'd like to contribute or develop the extension locally, follow these steps:
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/soumyaprasadrana/vscode-java-debugx.git
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Build the extension:
+   ```bash
+   npm run build-prod
+   ```
+4. Launch the extension in VS Code with:
+   ```bash
+   npm run watch
+   ```
+
+## License
+
+This project is licensed under the [SEE LICENSE IN LICENSE](LICENSE).
+
+## Author
+
+**Soumya Prasad Rana**  
+Email: soumyaprasad.rana@gmail.com  
+GitHub: [soumyaprasadrana](https://github.com/soumyaprasadrana)
+
+## Support
+
+If you encounter any issues or need help, please visit the [issues page](https://github.com/soumyaprasadrana/vscode-java-debugx/issues) and open a new issue or check for existing discussions.
+

build.js

@@ -0,0 +1,12 @@
+const esbuild = require('esbuild');
+
+esbuild.build({
+    entryPoints: ['src/extension.ts'], // Your entry file
+    bundle: true,
+    outfile: 'out/extension.js',
+    external: ['vscode'], // Mark vscode as external
+    platform: 'node', // This ensures the output is suitable for Node.js
+    target: 'node14', // Set your desired Node.js version
+    sourcemap: false,
+    minify: true, // Optionally minify the output
+}).catch(() => process.exit(1));