{"id":17335076,"url":"https://github.com/feroult/vulcan","last_synced_at":"2025-08-01T11:31:48.551Z","repository":{"id":241031108,"uuid":"804133495","full_name":"feroult/vulcan","owner":"feroult","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-22T02:46:03.000Z","size":40,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-16T15:08:07.963Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/feroult.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-22T02:44:45.000Z","updated_at":"2024-10-01T09:52:19.000Z","dependencies_parsed_at":"2024-05-22T03:23:48.490Z","dependency_job_id":"71ebc91c-6175-4309-8c7e-0a1c4e0ce1c0","html_url":"https://github.com/feroult/vulcan","commit_stats":null,"previous_names":["feroult/vulcan"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feroult%2Fvulcan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feroult%2Fvulcan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feroult%2Fvulcan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feroult%2Fvulcan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/feroult","download_url":"https://codeload.github.com/feroult/vulcan/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228370989,"owners_count":17909387,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-15T15:08:09.617Z","updated_at":"2024-12-05T20:42:09.817Z","avatar_url":"https://github.com/feroult.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vulcan\n\n## Exposing Eclipse JDT OSGi Bundle Programmatically\n\n![License](https://img.shields.io/badge/license-MIT-blue.svg)\n![Java](https://img.shields.io/badge/java-17+-blue.svg)\n![Maven](https://img.shields.io/badge/maven-3.6.3+-blue.svg)\n\nVulcan is an experimental tool designed to expose the Eclipse JDT (Java Development Tools) OSGi bundle in a programmatic way, accessible via REST API, without the need to run the Eclipse workbench.\n\n**Note:** This is an experimental project and is not actively maintained.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Running the Application](#running-the-application)\n  - [Client Usage](#client-usage)\n  - [Testing](#testing)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- **Extract Method**: Extracts a block of code into a new method.\n- **Rename Type**: Renames a class or interface.\n- **Rename Method**: Renames a method.\n- **Rename Field**: Renames a field.\n- **Rename Local Variable**: Renames a local variable.\n- **Chained Refactorings**: Allows multiple refactorings to be applied in sequence.\n\n## Installation\n\n### Prerequisites\n\n- Java 17 or higher\n- Maven 3.6.3 or higher\n\n### Build\n\nClone the repository and build the project using Maven:\n\n```bash\ngit clone https://github.com/yourusername/vulcan.git\ncd vulcan\n./build.sh\n```\n\n## Usage\n\n### Running the Application\n\nYou can run the application using the provided `run.sh` script. This script allows you to specify a workspace and whether to run in debug mode.\n\n```bash\n./run.sh [-w|--workspace \u003cworkspace_path\u003e] [-d|--debug \u003cy/n\u003e]\n```\n\n- `-w|--workspace`: Path to the workspace (default: `../sample-workspace`)\n- `-d|--debug`: Enable debug mode (`y` for yes, `n` for no, default: `n`)\n\nExample:\n\n```bash\n./run.sh -w /path/to/workspace -d y\n```\n\n### Client Usage\n\nYou can use the `client.sh` script to send refactoring requests to the running application.\n\n```bash\n./client.sh\n```\n\nThis script sends a POST request with a JSON payload specifying the refactorings to be applied.\n\nExample payload:\n\n```json\n[\n  {\n    \"type\": \"refactorings/core/extract-method\",\n    \"methodName\": \"extractedPrintProduct\",\n    \"offset\": 123,\n    \"length\": 61 \n  },\n  {\n    \"type\": \"refactorings/core/rename-type\",\n    \"newName\": \"ProductX\"  \n  }\n]\n```\n\n### Testing\n\nRun the tests using the `test.sh` script:\n\n```bash\n./test.sh [-w|--workspace \u003cworkspace_path\u003e]\n```\n\n- `-w|--workspace`: Path to the workspace (default: `/tmp/vulcan-test-workspace`)\n\nExample:\n\n```bash\n./test.sh -w /path/to/test-workspace\n```\n\n## Contributing\n\nWe welcome contributions to the Vulcan project! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request.\n\n### Steps to Contribute\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Make your changes.\n4. Commit your changes (`git commit -am 'Add new feature'`).\n5. Push to the branch (`git push origin feature-branch`).\n6. Create a new Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fferoult%2Fvulcan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fferoult%2Fvulcan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fferoult%2Fvulcan/lists"}