https://github.com/xt0rted/github-actions-problem-matcher-typings

TypeScript typings for the Github Actions problem matcher file format
https://github.com/xt0rted/github-actions-problem-matcher-typings

Last synced: 5 months ago
JSON representation

TypeScript typings for the Github Actions problem matcher file format

• Host: GitHub
• URL: https://github.com/xt0rted/github-actions-problem-matcher-typings
• Owner: xt0rted
• License: mit
• Created: 2020-02-16T19:46:46.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-11-17T23:03:19.000Z (8 months ago)
• Last Synced: 2025-11-18T01:05:55.413Z (8 months ago)
• Language: JavaScript
• Size: 392 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GitHub Actions Problem Matcher Typings

[![CI](https://github.com/xt0rted/github-actions-problem-matcher-typings/actions/workflows/ci.yml/badge.svg)](https://github.com/xt0rted/github-actions-problem-matcher-typings/actions/workflows/ci.yml)

[![npm](https://img.shields.io/npm/v/github-actions-problem-matcher-typings)](https://www.npmjs.com/package/github-actions-problem-matcher-typings)

A set of typings for the problem matcher file format based on the docs at [actions/toolkit](https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md).

You can use these to help with testing your regex or if you need to load the file and work with it inside of your action.

## Usage

```ts

import { problemMatcher as problemMatcherJson } from "../.github/problem-matcher.json";

import { ProblemMatcher } from "github-actions-problem-matcher-typings";

const problemMatcher: ProblemMatcher = problemMatcherJson[0];

describe("problemMatcher", () => {

  it("has the correct name", () => {

    expect(problemMatcher.owner).toEqual("your-matcher");

  });

});

```

To load the problem matcher as a module you'll need to update your `tsconfig.json` like so:

```jsonc

{

  "compilerOptions": {

    "resolveJsonModule": true /* Allows for importing .json files as modules. */

  }

}

```

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE)