Skip to content

techfever-soft/labinsight-vscode-extension

Repository files navigation

Version Installs License

LabInsight is a powerful static code analysis tool that provides deep insights into your codebase.

Whether you're working with JavaScript, TypeScript, or Python, LabInsight helps you identify potential code issues, enforce best practices, and maintain a high level of code quality.

📚 Description

Labinsight is a Visual Studio Code extension designed to streamline the creation and management of Labinsight configuration files (.labinsight). With a simple interface, developers can quickly generate standardized configuration files tailored to their project's needs.

🚀 Features

  • Create Labinsight Files: Easily create new .labinsight files with a predefined structure directly from the VSCode interface.
  • Integrated View: Access and manage your Labinsight files through a dedicated "Rules" view in the Activity Bar.
  • View Reports: Visualize and explore generated reports (JSON, HTML) in the "Reports" view, with expandable sections and detailed information.

🔧 Installation

  1. Install via VSCode Marketplace:

    • Open VSCode.
    • Go to the Extensions view by clicking on the Extensions icon in the Activity Bar or pressing Ctrl+Shift+X.
    • Search for "Labinsight".
    • Click Install.
  2. Install from VSIX:

    • Download the .vsix file for Labinsight.
    • Open VSCode.
    • Go to the Extensions view.
    • Click on the three-dot menu (...) in the top-right corner.
    • Select "Install from VSIX..." and choose the downloaded file.

🛠️ Usage

  1. Open the Labinsight Viewer:

    • Click on the Labinsight icon in the Activity Bar to open the "Rules" view.
  2. Create a New Labinsight File:

    • In the "Rules" view, click on the "Create New Labinsight File" button in the toolbar.
    • The extension will automatically create a .labinsight file in the root of your currently active workspace.
    • If a .labinsight file already exists, you will be prompted to overwrite it.
  3. Manage Labinsight Files:

    • The "Rules" view displays all existing .labinsight files within your workspace.
    • Click on a file to open and edit its contents.

📝 Commands

Labinsight provides the following command to enhance your productivity:

Command ID Description
labinsightViewer.createLabinsightFile Creates a new .labinsight file with a predefined structure.
labinsightViewer.analyze Runs the analysis on the current workspace and generates a report.
labinsightViewer.viewRules Displays the "Rules" view in the Labinsight panel.
labinsightViewer.viewReports Displays the "Reports" view in the Labinsight panel.
labinsightViewer.refreshReports Refreshes the reports view to display updated data.
labinsightViewer.viewReportDetails Opens a detailed view of a specific report in a webview.

⚙️ Configuration

Currently, Labinsight does not offer additional configuration options. Future updates may include customizable templates for .labinsight files and advanced management features.

Happy Coding ! 🚀

About

The VSCode extension for analysis and .labInsight rules

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published