https://github.com/smeghead/vscode-php-class-diagram

https://github.com/smeghead/vscode-php-class-diagram

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/smeghead/vscode-php-class-diagram
• Owner: smeghead
• License: apache-2.0
• Created: 2025-02-13T11:44:49.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-02-20T14:21:51.000Z (3 months ago)
• Last Synced: 2025-02-20T15:29:52.055Z (3 months ago)
• Language: TypeScript
• Size: 210 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# php-class-diagram README

## Features

This VSCode extension allows you to generate and view class diagram scripts using [php-class-diagram](https://packagist.org/packages/smeghead/php-class-diagram) directly from the file explorer's folder context menu.

With this extension, you can:

* Execute the php-class-diagram CLI command from the context menu of a folder.

* Open the generated PlantUML class diagram script in VSCode.

* Use [the PlantUML extension](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) to visualize the class diagram.

![Context Menu](docs/vscode-php-class-diagram01.jpg)

![Preview](docs/vscode-php-class-diagram02.jpg)

## Requirements

Before using this extension, ensure the following requirements are met:

* PHP 8 or later must be installed and available in your system.

* php-class-diagram must be installed in the project folder via Composer:

```bash

composer require --dev smeghead/php-class-diagram

```

## Extension Settings

- `php-class-diagram.executablePath`: Specify the path to the php-class-diagram executable.

## Known Issues

There is no known issues.