Insight

Insight augments the developer workflow by providing real-time project information and analytics within the IDE. This extension is compatible with both VSCode and IntelliJ, offering users a centralized dashboard, project overview, and inline code view to facilitate informed decision-making and proactive issue resolution.

Features

Backstage Integration

This extension brings Backstage information and scorecards directly into the IDE. Users can view the project's health, activity, and other key metrics directly within their projects.

Backstage Panel

The Backstage panel is a custom view that displays the key catalog component information, as well as the project's health and activity scores. The panel can be docked either with the bottom panel or the sidebar. The information within the panel is refreshed periodically to ensure that users have the most up-to-date information available.

Building the Extension

This repository uses GitHub Actions for the main build. To perform a build locally, run the following command in the vscode directory of the project:

pnpm install
pnpm run build

Running Tests

To run tests for the project, run the following command in the vscode directory of the project:

pnpm install
pnpm run build
pnpm run test

Packaging the Extension

To package the extension, first update the version number in package.json following semantic versioning guidelines. This is the version of the extension that will be packaged. Then run the following command in the root directory of the project:

pnpm run package

Uploading the Extension

Upload the resulting .vsix file to the Visual Studio Marketplace.

Click the ... next to Insight in the list and select Update. Upload the insight-.vsix file.