[DEV] All Plugin Changes

.env

@@ -1,6 +1,6 @@
-SERVER_URL='127.0.0.1:8000'
-SMELL_MAP_KEY='workspaceSmells'
-FILE_CHANGES_KEY='lastSavedHashes'
-LAST_USED_SMELLS_KEY='lastUsedSmells'
-CURRENT_REFACTOR_DATA_KEY='refactorData'
-ACTIVE_DIFF_KEY='activeDiff'
+SERVER_URL='127.0.0.1'
+HASH_PATH_MAP_KEY='hashPathMap'
+SMELL_CACHE_KEY='smellCache'
+WORKSPACE_METRICS_DATA='metricsData'
+WORKSPACE_CONFIGURED_PATH='workspaceConfiguredPath'
+UNFINISHED_REFACTORING='unfinishedRefactoring'

.github/workflows/jest-tests.yaml

@@ -18,8 +18,9 @@ jobs:
         with:
           node-version: 20
 
-      - name: Install dependencies
-        run: npm install
+      - name: Clean install
+        run: |
+          npm ci
 
       - name: Run Jest tests
         run: npm test -- --coverage

.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+name: Publish Extension
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # Needed for tag/release creation
+      id-token: write # For OIDC auth
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Full history needed for tagging
+
+      - name: Get version
+        id: version
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "tag_name=v$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Create and push tag
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "actions@github.com"
+          git tag ${{ steps.version.outputs.tag_name }}
+          git push origin ${{ steps.version.outputs.tag_name }}
+
+      - name: Install dependencies
+        run: |
+          npm install
+          npm install -g @vscode/vsce
+
+      - name: Package Extension
+        run: |
+          mkdir -p dist
+          vsce package --out ./dist/extension-${{ steps.version.outputs.tag_name }}.vsix
+
+      - name: Create Draft Release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: ${{ steps.version.outputs.tag_name }}
+          name: ${{ steps.version.outputs.tag_name }}
+          body: 'Release notes'
+          files: |
+            dist/extension-${{ steps.version.outputs.tag_name }}.vsix
+          draft: true
+          prerelease: false
+
+      - name: Publish to Marketplace
+        run: |
+          vsce publish -p $VSCE_PAT
+        env:
+          VSCE_PAT: ${{ secrets.VSCE_PAT }}

.github/workflows/version-check.yaml

@@ -0,0 +1,59 @@
+name: PR Version Check
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  validate_version:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout PR branch
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0 # Required for branch comparison
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - run: npm install compare-versions
+
+      - name: Get PR version
+        id: pr_version
+        run: |
+          PR_VERSION=$(node -p "require('./package.json').version")
+          echo "pr_version=$PR_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Fetch main branch
+        run: git fetch origin main
+
+      - name: Get main's version
+        id: main_version
+        run: |
+          MAIN_VERSION=$(git show origin/main:package.json | node -p "JSON.parse(require('fs').readFileSync(0)).version")
+          echo "main_version=$MAIN_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Validate version bump
+        run: |
+          # Write a temporary Node.js script for version comparison
+          cat > compare-versions.mjs << 'EOF'
+          import { compareVersions } from 'compare-versions';
+
+          const mainVersion = process.argv[2];
+          const prVersion = process.argv[3];
+
+          console.log("Main version:", mainVersion)
+          console.log("PR version:", prVersion)
+
+          if (compareVersions(prVersion, mainVersion) < 1) {
+            console.error(`::error::Version ${prVersion} must be greater than ${mainVersion}`);
+            process.exit(1);
+          }
+          EOF
+
+          node compare-versions.mjs "${{ steps.main_version.outputs.main_version }}" "${{ steps.pr_version.outputs.pr_version }}"
+
+          echo "✓ Version validated"

.gitignore

@@ -4,3 +4,4 @@ node_modules
 .vscode-test/
 *.vsix
 coverage/
+.venv/

.prettierrc

@@ -3,6 +3,7 @@
   "printWidth": 85,
   "semi": true,
   "singleQuote": true,
+  "endOfLine": "auto",
   "tabWidth": 2,
   "trailingComma": "all",
   "plugins": ["prettier-plugin-tailwindcss"]

.vscodeignore

@@ -1,14 +1,18 @@
-.vscode/**
-.vscode-test/**
-out/**
-node_modules/**
 src/**
-.gitignore
-.yarnrc
+.vscode
+node_modules
+package-lock.json
+tsconfig.json
 webpack.config.js
-vsc-extension-quickstart.md
-**/tsconfig.json
-**/eslint.config.mjs
+eslint.config.mjs
+.prettier*
+.gitignore
+run/**
+.venv/**
+test/**
+.github/**
+.husky/**
+coverage/**
 **/*.map
-**/*.ts
-**/.vscode-test.*
+.vscode-test.mjs
+.env

LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2024-2025 Ayushi Amin, Mya Hussain, Nivetha Kuruparan, Sevhena Walker, Tanveer Brar
+
+Permission is hereby granted, on a case-by-case basis, to specific individuals or organizations ("Licensee") to use and access the software and associated documentation files (the "Software") strictly for evaluation or development purposes. This permission is non-transferable, non-exclusive, and does not grant the Licensee any rights to modify, merge, publish, distribute, sublicense, sell, or otherwise exploit the Software in any manner without explicit prior written consent from the copyright holder.
+
+Any unauthorized use, modification, distribution, or sale of the Software is strictly prohibited and may result in legal action.
+
+The Software is provided "AS IS," without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, or non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the Software or the use or other dealings in the Software.
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

README.md

@@ -1,12 +1,55 @@
-VS Code Plugin for Source Code Optimizer
-
-1. clone this repo
-2. open terminal and write:
-    `npm install` (only the first time)
-    `npm run compile` | `npm run watch` <- second command will auto compile on save
-3. open another vs code window with the ecooptimzer repo
-4. start venv in the ecooptimizer repo
-5. run "python -m ecooptimizer.api.main" in terminal to start the developement server manually
-6. come back to this repo, go to run and debug (or just click `F5` key)
-7. run extension (should open a new vs code window so open the repo u want in this)
-8. in the vscode search bar (`ctrl+shift+p`) type ">eco: detect smells" and run it
+# EcoOptimizers - Sustainable Python Code Refactoring
+
+EcoOptimizers is a VS Code extension that detects and refactors inefficient Python code, reducing unnecessary computations and lowering CO₂ emissions. By identifying common code smells and providing automated refactoring suggestions, EcoOptimizers helps you write cleaner, more efficient, and environmentally friendly code.
+
+## Features
+
+- **Detect Code Smells** – Automatically analyze your Python code to find inefficiencies.
+- **Refactor Code Smells** – Get instant suggestions and apply refactorings with ease.
+- **Reduce CO₂ Emissions** – Improve computational efficiency and contribute to a greener future.
+- **Seamless VS Code Integration** – Analyze and optimize your code directly within the editor.
+
+## Supported Code Smells
+
+EcoOptimizers detects and refactors the following common code smells:
+
+- **Cache Repeated Calls** – Identifies functions that repeatedly compute the same result and suggests caching techniques.
+- **Long Lambda Functions** – Flags excessively long lambda expressions and converts them into named functions for readability and maintainability.
+- **Use A Generator** – Suggests using generators instead of list comprehensions for memory efficiency.
+- **Long Element Chain** – Detects deeply nested attribute accesses and recommends breaking them into intermediate variables for clarity.
+- **Member Ignoring Method** – Identifies methods that do not use their class members and suggests converting them into static methods or external functions.
+- **Long Message Chains** – Finds excessive method chaining and refactors them for better readability.
+- **String Concatenation in Loop** – Detects inefficient string concatenation inside loops and suggests using lists or other optimized methods.
+- **Long Parameter List** – Flags functions with too many parameters and suggests refactoring strategies such as grouping related parameters into objects.
+
+## How It Works
+
+1. **Detect Smells** – Run the EcoOptimizers analysis tool to scan your code for inefficiencies.
+2. **Refactor Suggestions** – View recommended changes and apply them with a click.
+3. **Optimize Your Code** – Enjoy cleaner, more efficient Python code with reduced computational overhead.
+
+## Demo Videos
+
+Watch EcoOptimizers in action:
+
+- [Detecting Code Smells](https://drive.google.com/file/d/1Uyz0fpqjWVZVe_WXuJLB0bTtzOvjhefu/view?usp=sharing) 🔍
+- [Refactoring Code Smells](https://drive.google.com/file/d/1LQFdnKhuZ7nQGFEXZl3HQtF3TFgMJr6F/view?usp=sharing) 🔧
+
+## Installation
+
+1. Open VS Code.
+2. Go to the Extensions Marketplace.
+3. Search for **EcoOptimizers**.
+4. Click **Install**.
+5. Intall the `ecooptimizer` python package.
+    - run: `pip install ecooptimizer`
+    - run: `eco-ext`
+6. Start optimizing your Python code!
+
+## Contribute
+
+EcoOptimizers is open-source! Help improve the extension by contributing to our GitHub repository: [GitHub Repository](https://github.com/ssm-lab/capstone--source-code-optimizer)
+
+---
+
+🚀 Start writing cleaner, more efficient Python code today with EcoOptimizers!

data/default_smells_config.json

@@ -0,0 +1,101 @@
+{
+  "use-a-generator": {
+    "message_id": "R1729",
+    "name": "Use A Generator (UGEN)",
+    "acronym": "UGEN",
+    "enabled": true,
+    "smell_description": "Using generators instead of lists reduces memory consumption and avoids unnecessary allocations, leading to more efficient CPU and energy use.",
+    "analyzer_options": {}
+  },
+  "too-many-arguments": {
+    "message_id": "R0913",
+    "name": "Too Many Arguments (LPL)",
+    "acronym": "LPL",
+    "enabled": true,
+    "smell_description": "Functions with many arguments are harder to optimize and often require more memory and call overhead, increasing CPU load and energy usage.",
+    "analyzer_options": {
+      "max_args": {
+        "label": "Number of Arguments",
+        "description": "Detecting functions with this many arguments.",
+        "value": 6
+      }
+    }
+  },
+  "no-self-use": {
+    "message_id": "R6301",
+    "name": "No Self Use (NSU)",
+    "acronym": "NSU",
+    "enabled": true,
+    "smell_description": "Methods that don't use 'self' can be static, reducing object overhead and avoiding unnecessary memory binding at runtime.",
+    "analyzer_options": {}
+  },
+  "long-lambda-expression": {
+    "message_id": "LLE001",
+    "name": "Long Lambda Expression (LLE)",
+    "acronym": "LLE",
+    "enabled": true,
+    "smell_description": "Complex lambdas are harder for the interpreter to optimize and may lead to repeated evaluations, which can increase CPU usage and energy draw.",
+    "analyzer_options": {
+      "threshold_length": {
+        "label": "Lambda Length",
+        "description": "Detects lambda expressions exceeding this length.",
+        "value": 9
+      },
+      "threshold_count": {
+        "label": "Repetition Count",
+        "description": "Flags patterns that repeat at least this many times.",
+        "value": 5
+      }
+    }
+  },
+  "long-message-chain": {
+    "message_id": "LMC001",
+    "name": "Long Message Chain (LMC)",
+    "acronym": "LMC",
+    "enabled": true,
+    "smell_description": "Deeply nested calls create performance bottlenecks due to increased dereferencing and lookup time, which adds to CPU cycles and energy usage.",
+    "analyzer_options": {
+      "threshold": {
+        "label": "Threshold",
+        "description": "Defines a threshold for triggering this smell.",
+        "value": 9
+      }
+    }
+  },
+  "long-element-chain": {
+    "message_id": "LEC001",
+    "name": "Long Element Chain (LEC)",
+    "acronym": "LEC",
+    "enabled": true,
+    "smell_description": "Chained element access can be inefficient in large structures, increasing access time and CPU effort, thereby consuming more energy.",
+    "analyzer_options": {
+      "threshold": {
+        "label": "Threshold",
+        "description": "Defines a threshold for triggering this smell.",
+        "value": 3
+      }
+    }
+  },
+  "cached-repeated-calls": {
+    "message_id": "CRC001",
+    "name": "Cached Repeated Calls (CRC)",
+    "acronym": "CRC",
+    "enabled": true,
+    "smell_description": "Failing to cache repeated expensive calls leads to redundant computation, which wastes CPU cycles and drains energy needlessly.",
+    "analyzer_options": {
+      "threshold": {
+        "label": "Cache Threshold",
+        "description": "Number of times a function must repeat before caching.",
+        "value": 2
+      }
+    }
+  },
+  "string-concat-loop": {
+    "message_id": "SCL001",
+    "name": "String Concatenation in Loops (SCL)",
+    "acronym": "SCL",
+    "enabled": true,
+    "smell_description": "String concatenation in loops creates new objects each time, increasing memory churn and CPU workload, which leads to higher energy consumption.",
+    "analyzer_options": {}
+  }
+}