sonarqube-sdk
    TypeScript icon, indicating that this package has built-in type declarations

    0.3.0 • Public • Published

    Logo

    SonarQube SDK

    A simple SDK to work with SonarQube Web APIs

    An easy way to work with SonarQube Web APIs. With inbuilt types, it is easier to work with the response and request parameters without having to look into the documentation.

    Disclaimer: The library is not associated with SonarQube. Its an unofficial SDK.

    Requirements

    • Node 12 or above

    Usage

    1. Install the package
    npm install sonarqube-sdk
    1. Initialize the client
    import { Client } from 'sonarqube-sdk';
    import { SonarQubeSDKAuthConfig } from 'sonarqube-sdk/interfaces';
    
    // Auth is optional
    const options: SonarQubeSDKAuthConfig = {
      url: '',
      auth: { username: '', password: '' },
    };
    const client = new Client(options);
    
    // Get metrics
    const response = await client.measures.component({ component: '', metricKeys: ['bugs', 'code_smells'] });

    Roadmap

    See the open issues for a list of proposed features (and known issues).

    License

    Distributed under the MIT License. See LICENSE for more information.

    Show your support

    Please ⭐️ this repository if this project helped you!

    Install

    npm i sonarqube-sdk

    DownloadsWeekly Downloads

    18

    Version

    0.3.0

    License

    MIT

    Unpacked Size

    19.6 kB

    Total Files

    30

    Last publish

    Collaborators

    • adi.sreyaj