github-actions-problem-matcher-typings
v1.1.0
Published
TypeScript typings for the Github Actions problem matcher file format
Downloads
126
Readme
GitHub Actions Problem Matcher Typings
A set of typings for the problem matcher file format based on the docs at actions/toolkit. 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
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:
{
"compilerOptions": {
"resolveJsonModule": true /* Allows for importing .json files as modules. */
}
}
License
The scripts and documentation in this project are released under the MIT License