Skip to main content

getMatcherList

codebolt.codeutils.getMatcherList(): Promise<GetMatcherListTreeResponse><GetMatcherListTreeResponse>
Retrieves the complete list of available problem matchers for various programming languages and tools.

Returns:

 Promise<GetMatcherListTreeResponse><GetMatcherListTreeResponse>
A promise that resolves with the list of all available matchers with their patterns and configurations.

Description​

The getMatcherList function returns a comprehensive list of all available problem matchers. These matchers are used to parse and identify issues from various development tools, linters, compilers, and formatters across different programming languages.

Usage​

const matcherListResult = await codebolt.codeutils.getMatcherList();

Example​

const matcherListResult = await codebolt.codeutils.getMatcherList();
console.log(matcherListResult);

Response Format​

{
  payload: [
    {
      owner: 'string',      // Name/identifier of the matcher
      pattern: {            // Pattern configuration object
        // Matcher-specific pattern definitions
      }
    }
  ],
  type: 'getMatcherListTreeResponse'
}