- {children}
-
46 | {meta.related.map((link: string) => (
47 |
10 | 11 | You can add this action for the new project, as well as for already existing one. 12 | 13 | ## Setup 14 | 15 | 1. Firstly, make sure that you've installed [Jest](https://github.com/facebook/jest#readme). Also, if you're using TypeScript tests, be sure to install and configure [ts-jest](https://github.com/kulshekhar/ts-jest#readme). 16 | 2. Secondly, make sure that you can run the Jest without additional arguments. To test it, try to run this code in your shell: 17 | 18 | ```bash 19 | npx jest 20 | ``` 21 | 22 | Or via yarn: 23 | 24 | ```bash 25 | yarn jest 26 | ``` 27 | 28 | Or via pnpm (pnpx): 29 | 30 | ```bash 31 | pnpx jest 32 | ``` 33 | 34 | Or via bun (bunx): 35 | 36 | ```bash 37 | bunx jest 38 | ``` 39 | 40 | 41 | 42 | If this command is not working for you, see [how to setup custom testing script](https://github.com/ArtiomTr/jest-coverage-report-action#customizing-test-script). 43 | 44 | 3. After that, create new file in your repository, under `.github/workflows` folder. Name this file `coverage-report.yml` (or any another name, just don't forget that extension must be `.yml`). 45 | 46 | 4. Paste the default configuration: 47 | 48 | ```yaml 49 | name: Coverage report 50 | on: 51 | pull_request: 52 | branches: 53 | - master 54 | jobs: 55 | coverage: 56 | runs-on: ubuntu-latest 57 | steps: 58 | - uses: actions/checkout@v2 59 | - uses: artiomtr/jest-coverage-report-action@v1.3 60 | with: 61 | github-token: ${{ secrets.GITHUB_TOKEN }} 62 | # threshold: 80 # optional parameter 63 | ``` 64 | 65 | As you can see, one option is commented out - `threshold`. After removing the hash character at the beginning of a line, the action will fail if the total line coverage in percent is less than the specified one. If you don't want this behavior, you can simply delete this line. 66 | 67 |
68 | 69 | That's it! Now, try to create a pull request and wait until the report will be generated! 70 | -------------------------------------------------------------------------------- /docs/src/theme.ts: -------------------------------------------------------------------------------- 1 | import { extendTheme } from '@chakra-ui/react'; 2 | 3 | export const theme = extendTheme({ 4 | colors: { 5 | brand: { 6 | '500': '#b34464', 7 | '600': '#99425B', 8 | }, 9 | }, 10 | }); 11 | -------------------------------------------------------------------------------- /docs/styles/globals.css: -------------------------------------------------------------------------------- 1 | html, 2 | body { 3 | scroll-behavior: smooth; 4 | } 5 | 6 | ::selection { 7 | color: #000; 8 | background: #b3446356; 9 | } 10 | -------------------------------------------------------------------------------- /docs/tools/.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "root": false, 3 | "env": { 4 | "node": true 5 | }, 6 | "rules": { 7 | "@typescript-eslint/no-var-requires": "off" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /docs/tools/loaders/md-loader.js: -------------------------------------------------------------------------------- 1 | const fm = require('gray-matter'); 2 | 3 | // Removes YAML from markdown file beggining 4 | // Adds layouts for markdown 5 | // (Shamelessly stolen from formik) 6 | // @see https://github.com/formium/formik/blob/master/docs/src/lib/docs/md-loader.js 7 | module.exports = async function (src) { 8 | const callback = this.async(); 9 | const { content, data } = fm(src); 10 | const layout = data.layout || 'Docs'; 11 | const code = 12 | `import { Layout${layout} } from 'layouts/Layout${layout}'; 13 | export const meta = ${JSON.stringify(data)}; 14 | export default ({ children, ...props }) => ( 15 |
\`...\` / ${base}
`;
11 | }
12 |
13 | return filename;
14 | };
15 |
--------------------------------------------------------------------------------
/src/format/formatCoverage.ts:
--------------------------------------------------------------------------------
1 | import { parseDetails } from './details/parseDetails';
2 | import { parseSummary } from './summary/parseSummary';
3 | import { getFormattedCoverage } from './getFormattedCoverage';
4 | import { JsonReport } from '../typings/JsonReport';
5 |
6 | export const formatCoverage = (
7 | headReport: JsonReport | undefined,
8 | baseReport: JsonReport | undefined,
9 | threshold: number | undefined,
10 | hideDetails: boolean | undefined
11 | ): string => {
12 | if (headReport) {
13 | return getFormattedCoverage(
14 | parseSummary(headReport),
15 | baseReport ? parseSummary(baseReport) : undefined,
16 | parseDetails(headReport),
17 | baseReport ? parseDetails(baseReport) : undefined,
18 | threshold,
19 | hideDetails
20 | );
21 | }
22 |
23 | return '';
24 | };
25 |
--------------------------------------------------------------------------------
/src/format/formatErrors.ts:
--------------------------------------------------------------------------------
1 | import { formatThresholdResults } from './formatThresholdResults';
2 | import { ActionError } from '../typings/ActionError';
3 | import { FailReason } from '../typings/Report';
4 | import { ThresholdResult } from '../typings/ThresholdResult';
5 | import { getConsoleLink } from '../utils/getConsoleLink';
6 | import { i18n } from '../utils/i18n';
7 |
8 | const getNumberWidth = (index: number) => Math.floor(Math.log10(index));
9 |
10 | const formatErrorsInner = (
11 | errors: ArrayReport generated by 🧪jest coverage report action from {{ sha }}
8 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import { run } from './run'; 2 | 3 | run(); 4 | -------------------------------------------------------------------------------- /src/report/__mocks__/generateCommitReport.ts: -------------------------------------------------------------------------------- 1 | export const generateCommitReport = jest.fn(); 2 | -------------------------------------------------------------------------------- /src/report/__mocks__/generatePRReport.ts: -------------------------------------------------------------------------------- 1 | export const generatePRReport = jest.fn(); 2 | -------------------------------------------------------------------------------- /src/report/fetchPreviousReport.ts: -------------------------------------------------------------------------------- 1 | import { getOctokit } from '@actions/github'; 2 | 3 | import { getReportTag } from '../constants/getReportTag'; 4 | import { Options } from '../typings/Options'; 5 | 6 | export async function fetchPreviousReport( 7 | octokit: ReturnType${summary}
11 |12 | 13 | ${body} 14 | 15 |
{{ percentage }}% {{ delta }}
'
18 | : '{{ percentage }}%',
19 | {
20 | percentage: decimalToString(headPercentage),
21 | baseCoverage:
22 | i18n('baseCoverage') + decimalToString(basePercentage),
23 | delta: isDeltaValid ? formatPercentageDelta(delta) : '',
24 | }
25 | );
26 | };
27 |
--------------------------------------------------------------------------------
/src/utils/formatPercentageDelta.ts:
--------------------------------------------------------------------------------
1 | import { decimalToString } from './decimalToString';
2 | import { i18n } from './i18n';
3 |
4 | export const formatPercentageDelta = (delta: number): string =>
5 | i18n(
6 | delta > 0
7 | ? `(+{{ delta }}% :arrow_up_small:)`
8 | : `({{ delta }}% :small_red_triangle_down:)`,
9 | {
10 | delta: decimalToString(delta),
11 | }
12 | );
13 |
--------------------------------------------------------------------------------
/src/utils/getConsoleLink.ts:
--------------------------------------------------------------------------------
1 | import { context } from '@actions/github';
2 |
3 | export const getConsoleLink = () => {
4 | const repositoryUrl =
5 | context.payload.repository?.html_url ??
6 | `https://github.com/${context.repo.owner}/${context.repo.repo}`;
7 |
8 | return `${repositoryUrl}/actions/runs/${context.runId}`;
9 | };
10 |
--------------------------------------------------------------------------------
/src/utils/getCoverageForDirectory.ts:
--------------------------------------------------------------------------------
1 | import micromatch from 'micromatch';
2 |
3 | import { accumulateCoverageDetails } from './accumulateCoverageDetails';
4 | import { DetailedFileCoverage, FileCoverageMap } from './getFileCoverageMap';
5 |
6 | export const getCoverageForDirectory = (
7 | directory: string,
8 | details: FileCoverageMap
9 | ): DetailedFileCoverage => {
10 | const children = micromatch(Object.keys(details), `${directory}/**`);
11 |
12 | return accumulateCoverageDetails(children.map((child) => details[child]));
13 | };
14 |
--------------------------------------------------------------------------------
/src/utils/getFileCoverageMap.ts:
--------------------------------------------------------------------------------
1 | import {
2 | coveredBranchesCounter,
3 | coveredLinesCounter,
4 | standardCoveredCounter,
5 | standardTotalCounter,
6 | totalBranchesCounter,
7 | totalLinesCounter,
8 | } from '../format/counters';
9 | import { JsonReport } from '../typings/JsonReport';
10 |
11 | export type DetailedFileCoverage = {
12 | totalStatements: number;
13 | coveredStatements: number;
14 | totalFunctions: number;
15 | coveredFunctions: number;
16 | totalBranches: number;
17 | coveredBranches: number;
18 | totalLines: number;
19 | coveredLines: number;
20 | };
21 |
22 | export type FileCoverageMap = Record${text}:grey_question:
`;
3 |
--------------------------------------------------------------------------------
/tests/.eslintrc:
--------------------------------------------------------------------------------
1 | {
2 | "root": false,
3 | "rules": {
4 | "@typescript-eslint/no-explicit-any": "off"
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/tests/annotations/__snapshots__/createFailedTestsAnnotations.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`createFailedTestsAnnotations should create failed tests annotations 1`] = `
4 | Array [
5 | Object {
6 | "annotation_level": "failure",
7 | "end_line": 4,
8 | "message": "",
9 | "path": "tests/format/details/getNewFilesCoverage.test.ts",
10 | "start_line": 4,
11 | "title": "getNewFilesCoverage > should return new file coverage",
12 | },
13 | Object {
14 | "annotation_level": "failure",
15 | "end_line": 29,
16 | "message": "",
17 | "path": "tests/format/details/getNewFilesCoverage.test.ts",
18 | "start_line": 29,
19 | "title": "getNewFilesCoverage > should return empty object, when base details not specified",
20 | },
21 | Object {
22 | "annotation_level": "failure",
23 | "end_line": 23,
24 | "message": "",
25 | "path": "tests/format/summary/getTestRunSummary.test.ts",
26 | "start_line": 23,
27 | "title": "getTestRunSummary > should return failure summary",
28 | },
29 | ]
30 | `;
31 |
--------------------------------------------------------------------------------
/tests/annotations/createCoverageAnnotations.test.ts:
--------------------------------------------------------------------------------
1 | import { relative } from 'path';
2 |
3 | import { createCoverageAnnotations } from '../../src/annotations/createCoverageAnnotations';
4 | import { JsonReport } from '../../src/typings/JsonReport';
5 | import jsonReport from '../mock-data/jsonReport.json';
6 | import jsonReport2 from '../mock-data/jsonReport2.json';
7 | import jsonReport3 from '../mock-data/jsonReport3.json';
8 |
9 | jest.mock('path');
10 |
11 | describe('createCoverageAnnotations', () => {
12 | it('should match snapshot', () => {
13 | (relative as jest.MockSt.:grey_question:
| Category | Percentage | Covered / Total |
5 | | :-: | :- | :- | :-: |
6 | | 🟢 | Statements | 81.82% | 27/33 |
7 | | 🟢 | Branches | 100% | 8/8 |
8 | | 🟢 | Functions | 63.64% | 7/11 |
9 | | 🟢 | Lines | 80.65% | 25/31 |
10 | > :warning: Details were not displayed: the report size has exceeded the limit."
11 | `;
12 |
13 | exports[`formatCoverage should format standard coverage 1`] = `
14 | "| St.:grey_question:
| Category | Percentage | Covered / Total |
15 | | :-: | :- | :- | :-: |
16 | | 🟢 | Statements | 81.82% | 27/33 |
17 | | 🟢 | Branches | 100% | 8/8 |
18 | | 🟢 | Functions | 63.64% | 7/11 |
19 | | 🟢 | Lines | 80.65% | 25/31 |
20 |
21 | "
22 | `;
23 |
24 | exports[`formatCoverage should format standard coverage 2`] = `
25 | "| St.:grey_question:
| Category | Percentage | Covered / Total |
26 | | :-: | :- | :- | :-: |
27 | | 🟢 | Statements | 81.82% | 27/33 |
28 | | 🟢 | Branches | 100% | 8/8 |
29 | | 🟢 | Functions | 63.64% | 7/11 |
30 | | 🟢 | Lines | 80.65% | 25/31 |
31 |
32 | "
33 | `;
34 |
35 | exports[`formatCoverage should format standard coverage 3`] = `
36 | "| St.:grey_question:
| Category | Percentage | Covered / Total |
37 | | :-: | :- | :- | :-: |
38 | | 🟢 | Statements | 81.82% | 27/33 |
39 | | 🟢 | Branches | 100% | 8/8 |
40 | | 🟡 | Functions | 63.64% | 7/11 |
41 | | 🟢 | Lines | 80.65% | 25/31 |
42 |
43 | "
44 | `;
45 |
--------------------------------------------------------------------------------
/tests/format/__snapshots__/formatRunReport.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`formatRunReport should generate summary as markdown (failure tests) 1`] = `
4 | "## Tests Failed
5 |
6 | 2 Tests Passed, 1 Test Failed
7 |8 | 9 | \`\`\` 10 | fail 1 11 | \`\`\` 12 | --- 13 | \`\`\` 14 | fail 2 15 | \`\`\` 16 | 17 |
St.:grey_question:
| Category | Percentage | Covered / Total |
5 | | :-: | :- | :- | :-: |
6 | | 🟢 | Statements | 81.82% | 27/33 |
7 | | 🟢 | Branches | 100% | 8/8 |
8 | | 🟡 | Functions | 63.64% | 7/11 |
9 | | 🟢 | Lines | 80.65% | 25/31 |
10 |
11 | "
12 | `;
13 |
--------------------------------------------------------------------------------
/tests/format/annotations/getFailedAnnotationsSummary.test.ts:
--------------------------------------------------------------------------------
1 | import { getFailedAnnotationsSummary } from '../../../src/format/annotations/getFailedAnnotationsSummary';
2 | import { JsonReport } from '../../../src/typings/JsonReport';
3 |
4 | describe('getFailedAnnotationsSummary', () => {
5 | it("should return succeeded report's summary", () => {
6 | expect(
7 | getFailedAnnotationsSummary(({
8 | numPassedTests: 10,
9 | numPassedTestSuites: 3,
10 | success: true,
11 | } as unknown) as JsonReport)
12 | ).toBe('10 tests passing in 3 suites.');
13 |
14 | expect(
15 | getFailedAnnotationsSummary(({
16 | numPassedTests: 10,
17 | numPassedTestSuites: 1,
18 | success: true,
19 | } as unknown) as JsonReport)
20 | ).toBe('10 tests passing in 1 suite.');
21 | });
22 |
23 | it("should return failed report's summary", () => {
24 | expect(
25 | getFailedAnnotationsSummary(({
26 | numFailedTests: 10,
27 | numTotalTests: 32,
28 | numFailedTestSuites: 3,
29 | numTotalTestSuites: 10,
30 | success: false,
31 | } as unknown) as JsonReport)
32 | ).toBe('Failed tests: 10/32. Failed suites: 3/10.');
33 | });
34 | });
35 |
--------------------------------------------------------------------------------
/tests/format/details/__snapshots__/formatCoverageDetails.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`formatCoverageDetails should match snapshots 1`] = `
4 | "
5 | Show new covered files 🐣
6 |7 | 8 | |
St.:grey_question:
| File | Statements | Branches | Functions | Lines |
9 | | :-: | :- | :- | :- | :- | :- |
10 | | 🔴 | newFile.ts | 50% | 50% | 50% | 50% |
11 |
12 | Show files with reduced coverage 🔻
16 |17 | 18 | |
St.:grey_question:
| File | Statements | Branches | Functions | Lines |
19 | | :-: | :- | :- | :- | :- | :- |
20 | | 🟡 | decreased.ts | 70% (-10% 🔻)
| 50% (-10% 🔻)
| 50% (-10% 🔻)
| 80% (-10% 🔻)
|
21 |
22 | 50% (-10% 🔻)
",
8 | "100%",
9 | "50% (-10% 🔻)
",
10 | "50% (-10% 🔻)
",
11 | ]
12 | `;
13 |
14 | exports[`getFileCoverageDetailRow should return formatted detail row (increased coverage) 1`] = `
15 | Array [
16 | "🔴",
17 | "hello.ts",
18 | "50% (+10% 🔼)
",
19 | "100%",
20 | "50% (+10% 🔼)
",
21 | "50% (+10% 🔼)
",
22 | ]
23 | `;
24 |
25 | exports[`getFileCoverageDetailRow should return formatted detail row (no base details) 1`] = `
26 | Array [
27 | "🔴",
28 | "hello.ts",
29 | "50%",
30 | "100%",
31 | "50%",
32 | "50%",
33 | ]
34 | `;
35 |
--------------------------------------------------------------------------------
/tests/format/details/findCommonPath.test.ts:
--------------------------------------------------------------------------------
1 | import { findCommonPath } from '../../../src/format/details/findCommonPath';
2 |
3 | describe('findCommonPath', () => {
4 | it('should find common filepath', () => {
5 | expect(
6 | findCommonPath([
7 | 'src/details/a.ts',
8 | 'src/details/b.ts',
9 | 'src/format/hello.ts',
10 | ])
11 | ).toBe('src/');
12 |
13 | expect(
14 | findCommonPath([
15 | 'src/details/hello/world/a.ts',
16 | 'src/details/hello/world/b.ts',
17 | 'src/format/hello.ts',
18 | ])
19 | ).toBe('src/');
20 |
21 | expect(
22 | findCommonPath([
23 | 'src/details/hello/world/a.ts',
24 | 'src/details/hello/world/b.ts',
25 | 'src/details/hello/world/hello.ts',
26 | ])
27 | ).toBe('src/details/hello/world/');
28 | });
29 |
30 | it('should return empty string', () => {
31 | expect(findCommonPath([])).toBe('');
32 | expect(
33 | findCommonPath([
34 | 'src/details/hello/world/a.ts',
35 | 'src/details/hello/world/b.ts',
36 | 'src/details/hello/world/hello.ts',
37 | 'hello',
38 | ])
39 | ).toBe('');
40 | });
41 |
42 | it('should return common folder (not part of filename)', () => {
43 | expect(
44 | findCommonPath([
45 | 'src/details/hello/world/hello.ts',
46 | 'src/details/hello/world/helloTest.ts',
47 | 'src/details/hello/world/helloasd',
48 | ])
49 | ).toBe('src/details/hello/world/');
50 |
51 | expect(
52 | findCommonPath([
53 | 'src/details/hello/world/hello.ts',
54 | 'src/details/helloasd.ts',
55 | 'src/details/hello.ts',
56 | ])
57 | ).toBe('src/details/');
58 | });
59 | });
60 |
--------------------------------------------------------------------------------
/tests/format/details/formatCoverageDetails.test.ts:
--------------------------------------------------------------------------------
1 | import { formatCoverageDetails } from '../../../src/format/details/formatCoverageDetails';
2 |
3 | describe('formatCoverageDetails', () => {
4 | it('should match snapshots', () => {
5 | expect(
6 | formatCoverageDetails(
7 | {
8 | 'increased.ts': {
9 | lines: 80,
10 | statements: 70,
11 | branches: 50,
12 | functions: 50,
13 | filename: 'increased.ts',
14 | },
15 | 'decreased.ts': {
16 | lines: 80,
17 | statements: 70,
18 | branches: 50,
19 | functions: 50,
20 | filename: 'decreased.ts',
21 | },
22 | 'newFile.ts': {
23 | lines: 50,
24 | statements: 50,
25 | branches: 50,
26 | functions: 50,
27 | filename: 'newFile.ts',
28 | },
29 | },
30 | {
31 | 'increased.ts': {
32 | lines: 50,
33 | statements: 50,
34 | branches: 30,
35 | functions: 30,
36 | filename: 'increased.ts',
37 | },
38 | 'decreased.ts': {
39 | lines: 90,
40 | statements: 80,
41 | branches: 60,
42 | functions: 60,
43 | filename: 'decreased.ts',
44 | },
45 | },
46 | 70
47 | )
48 | ).toMatchSnapshot();
49 | });
50 | });
51 |
--------------------------------------------------------------------------------
/tests/format/details/getFileCoverageDetailRow.test.ts:
--------------------------------------------------------------------------------
1 | import { getFileCoverageDetailRow } from '../../../src/format/details/getFileCoverageDetailRow';
2 |
3 | describe('getFileCoverageDetailRow', () => {
4 | it('should return formatted detail row (decreased coverage)', () => {
5 | expect(
6 | getFileCoverageDetailRow(
7 | 'hello.ts',
8 | {
9 | filename: 'hello.ts',
10 | lines: 50,
11 | branches: 100,
12 | functions: 50,
13 | statements: 50,
14 | },
15 | {
16 | filename: 'hello.ts',
17 | lines: 60,
18 | branches: 100,
19 | functions: 60,
20 | statements: 60,
21 | },
22 | 70
23 | )
24 | ).toMatchSnapshot();
25 | });
26 |
27 | it('should return formatted detail row (increased coverage)', () => {
28 | expect(
29 | getFileCoverageDetailRow(
30 | 'hello.ts',
31 | {
32 | filename: 'hello.ts',
33 | lines: 50,
34 | branches: 100,
35 | functions: 50,
36 | statements: 50,
37 | },
38 | {
39 | filename: 'hello.ts',
40 | lines: 40,
41 | branches: 100,
42 | functions: 40,
43 | statements: 40,
44 | },
45 | 70
46 | )
47 | ).toMatchSnapshot();
48 | });
49 |
50 | it('should return formatted detail row (no base details)', () => {
51 | expect(
52 | getFileCoverageDetailRow(
53 | 'hello.ts',
54 | {
55 | filename: 'hello.ts',
56 | lines: 50,
57 | branches: 100,
58 | functions: 50,
59 | statements: 50,
60 | },
61 | undefined,
62 | 70
63 | )
64 | ).toMatchSnapshot();
65 | });
66 | });
67 |
--------------------------------------------------------------------------------
/tests/format/details/getNewFilesCoverage.test.ts:
--------------------------------------------------------------------------------
1 | import { getNewFilesCoverage } from '../../../src/format/details/getNewFilesCoverage';
2 |
3 | describe('getNewFilesCoverage', () => {
4 | it('should return new file coverage', () => {
5 | expect(
6 | getNewFilesCoverage(
7 | {
8 | 'hello.ts': {
9 | filename: 'hello.ts',
10 | functions: 50,
11 | branches: 50,
12 | lines: 50,
13 | statements: 50,
14 | },
15 | },
16 | {}
17 | )
18 | ).toStrictEqual({
19 | 'hello.ts': {
20 | filename: 'hello.ts',
21 | functions: 50,
22 | branches: 50,
23 | lines: 50,
24 | statements: 50,
25 | },
26 | });
27 | });
28 |
29 | it('should return empty object, when base details not specified', () => {
30 | expect(
31 | getNewFilesCoverage(
32 | {
33 | 'hello.ts': {
34 | filename: 'hello.ts',
35 | functions: 50,
36 | branches: 50,
37 | lines: 50,
38 | statements: 50,
39 | },
40 | },
41 | undefined
42 | )
43 | ).toStrictEqual({});
44 | });
45 | });
46 |
--------------------------------------------------------------------------------
/tests/format/details/parseDetails.test.ts:
--------------------------------------------------------------------------------
1 | import { parseDetails } from '../../../src/format/details/parseDetails';
2 | import { JsonReport } from '../../../src/typings/JsonReport';
3 | import report from '../../mock-data/jsonReport.json';
4 | import report2 from '../../mock-data/jsonReport2.json';
5 |
6 | describe('parseDetails', () => {
7 | it('should match snapshots', () => {
8 | expect(parseDetails(report)).toMatchSnapshot();
9 | expect(
10 | parseDetails((report2 as unknown) as JsonReport)
11 | ).toMatchSnapshot();
12 | });
13 | });
14 |
--------------------------------------------------------------------------------
/tests/format/details/shrinkLongPath.test.ts:
--------------------------------------------------------------------------------
1 | import { shrinkLongPath } from '../../../src/format/details/shrinkLongPath';
2 |
3 | describe('shrinkLongPath', () => {
4 | it('should shrink long paths', () => {
5 | expect(shrinkLongPath('hello/world/this/is/a.ts')).toBe(
6 | '`...` / a.ts
'
7 | );
8 | expect(shrinkLongPath('hello/asdfasdfasdfasdfasdfasdfa.ts')).toBe(
9 | '`...` / asdfasdfasdfasdfasdfasdfa.ts
'
10 | );
11 | });
12 |
13 | it('should not touch short paths', () => {
14 | expect(shrinkLongPath('hello/a.ts')).toBe('hello/a.ts');
15 | expect(shrinkLongPath('asdf/d.ts')).toBe('asdf/d.ts');
16 | });
17 |
18 | it('should not trim long paths without directory', () => {
19 | expect(shrinkLongPath('asdfasdfasdfasdfasdfasdfasdfasdfasdfa.ts')).toBe(
20 | 'asdfasdfasdfasdfasdfasdfasdfasdfasdfa.ts'
21 | );
22 | });
23 | });
24 |
--------------------------------------------------------------------------------
/tests/format/formatCoverage.test.ts:
--------------------------------------------------------------------------------
1 | import { formatCoverage } from '../../src/format/formatCoverage';
2 | import jsonReport from '../mock-data/jsonReport.json';
3 |
4 | describe('formatCoverage', () => {
5 | it('should format standard coverage', () => {
6 | expect(
7 | formatCoverage(jsonReport, jsonReport, 0.3, false)
8 | ).toMatchSnapshot();
9 | expect(
10 | formatCoverage(jsonReport, undefined, 0.3, false)
11 | ).toMatchSnapshot();
12 | expect(
13 | formatCoverage(jsonReport, undefined, undefined, false)
14 | ).toMatchSnapshot();
15 | });
16 |
17 | it('should display warning if hiding details', () => {
18 | expect(
19 | formatCoverage(jsonReport, jsonReport, 0.3, true)
20 | ).toMatchSnapshot();
21 | });
22 |
23 | it('should return empty string if no reports specified', () => {
24 | expect(formatCoverage(undefined, undefined, 0.3, false)).toBe('');
25 | });
26 | });
27 |
--------------------------------------------------------------------------------
/tests/format/formatErrors.test.ts:
--------------------------------------------------------------------------------
1 | import * as all from '@actions/github';
2 |
3 | import { formatErrors } from '../../src/format/formatErrors';
4 | import { ActionError } from '../../src/typings/ActionError';
5 | import { FailReason } from '../../src/typings/Report';
6 |
7 | const { mockContext, clearContextMock } = all as any;
8 |
9 | describe('formatErrors', () => {
10 | it('should return empty string, if no errors specified', () => {
11 | expect(formatErrors([], false, [])).toBe('');
12 | });
13 |
14 | it('should format 1 error', () => {
15 | expect(
16 | formatErrors([new ActionError(FailReason.TESTS_FAILED)], false, [])
17 | ).toMatchSnapshot();
18 |
19 | mockContext({
20 | payload: {},
21 | repo: {
22 | owner: 'bot',
23 | repo: 'test-repo',
24 | },
25 | runId: 10,
26 | });
27 |
28 | expect(
29 | formatErrors([new Error('This is unexpected error')], false, [])
30 | ).toMatchSnapshot();
31 |
32 | clearContextMock();
33 | });
34 |
35 | it('should format multiple errors', () => {
36 | expect(
37 | formatErrors(
38 | [
39 | new ActionError(FailReason.TESTS_FAILED),
40 | new Error('hello'),
41 | new ActionError(FailReason.TESTS_FAILED),
42 | new EvalError('aaa'),
43 | ],
44 | false,
45 | []
46 | )
47 | ).toMatchSnapshot();
48 |
49 | expect(
50 | formatErrors(
51 | new Array(40).fill(0).map(() => new Error('error')),
52 | false,
53 | []
54 | )
55 | ).toMatchSnapshot();
56 |
57 | expect(
58 | formatErrors(
59 | new Array(100).fill(0).map(() => new Error('error')),
60 | false,
61 | []
62 | )
63 | ).toMatchSnapshot();
64 | });
65 | });
66 |
--------------------------------------------------------------------------------
/tests/format/formatRunReport.test.ts:
--------------------------------------------------------------------------------
1 | import { formatRunReport } from '../../src/format/formatRunReport';
2 | import { getFailureDetails } from '../../src/format/getFailureDetails';
3 | import { JsonReport } from '../../src/typings/JsonReport';
4 |
5 | describe('formatRunReport', () => {
6 | it('should generate summary as markdown (successful tests)', () => {
7 | expect(
8 | formatRunReport({
9 | success: true,
10 | summary: '2 Tests Passed',
11 | title: 'Tests Passed',
12 | })
13 | ).toMatchSnapshot();
14 | });
15 | it('should generate summary as markdown (failure tests)', () => {
16 | expect(
17 | formatRunReport({
18 | success: false,
19 | summary: '2 Tests Passed, 1 Test Failed',
20 | title: 'Tests Failed',
21 | failures: getFailureDetails({
22 | testResults: [
23 | {
24 | message: 'fail 1',
25 | },
26 | {
27 | message: 'fail 2',
28 | },
29 | ],
30 | } as JsonReport),
31 | })
32 | ).toMatchSnapshot();
33 | });
34 | });
35 |
--------------------------------------------------------------------------------
/tests/format/getFailureDetails.test.ts:
--------------------------------------------------------------------------------
1 | import { getFailureDetails } from '../../src/format/getFailureDetails';
2 | import { JsonReport } from '../../src/typings/JsonReport';
3 |
4 | describe('getFormattedFailures', () => {
5 | it('should return empty string, if no test results (or all passed)', () => {
6 | expect(getFailureDetails(({} as unknown) as JsonReport)).toBe('');
7 |
8 | expect(
9 | getFailureDetails(({
10 | testResults: [],
11 | } as unknown) as JsonReport)
12 | ).toBe('');
13 |
14 | expect(
15 | getFailureDetails(({
16 | testResults: [
17 | {
18 | status: 'passed',
19 | message: '',
20 | },
21 | ],
22 | } as unknown) as JsonReport)
23 | ).toBe('');
24 | });
25 |
26 | it('should format failure details', () => {
27 | expect(
28 | getFailureDetails({
29 | testResults: [
30 | {
31 | status: 'passed',
32 | message: 'asdfasdfasdf',
33 | },
34 | {
35 | status: 'failed',
36 | message: 'This is simple error message',
37 | },
38 | {
39 | status: 'failed',
40 | message: '',
41 | },
42 | {
43 | status: 'failed',
44 | message: 'Another error message',
45 | },
46 | {
47 | status: 'passed',
48 | message: 'Ignored message, because test is passed',
49 | },
50 | ],
51 | } as JsonReport)
52 | ).toBe(
53 | '```\n' +
54 | 'This is simple error message\n' +
55 | '```\n' +
56 | '---\n' +
57 | '```\n' +
58 | 'Another error message\n' +
59 | '```'
60 | );
61 | });
62 | });
63 |
--------------------------------------------------------------------------------
/tests/format/getFormattedCoverage.test.ts:
--------------------------------------------------------------------------------
1 | import { parseDetails } from '../../src/format/details/parseDetails';
2 | import { getFormattedCoverage } from '../../src/format/getFormattedCoverage';
3 | import { parseSummary } from '../../src/format/summary/parseSummary';
4 | import jsonReport from '../mock-data/jsonReport.json';
5 |
6 | describe('getFormattedCoverage', () => {
7 | it('should match snapshots', () => {
8 | expect(
9 | getFormattedCoverage(
10 | parseSummary(jsonReport),
11 | undefined,
12 | parseDetails(jsonReport),
13 | undefined,
14 | undefined,
15 | false
16 | )
17 | ).toMatchSnapshot();
18 | });
19 | });
20 |
--------------------------------------------------------------------------------
/tests/format/getPercents.test.ts:
--------------------------------------------------------------------------------
1 | import { getPercents } from '../../src/format/getPercents';
2 |
3 | describe('getPercents', () => {
4 | it('should return percents', () => {
5 | expect(getPercents(5, 10)).toBe(50);
6 | expect(getPercents(10, 10)).toBe(100);
7 | expect(getPercents(0, 10)).toBe(0);
8 | });
9 |
10 | it('should return 100 when total is 0', () => {
11 | expect(getPercents(0, 0)).toBe(100);
12 | });
13 | });
14 |
--------------------------------------------------------------------------------
/tests/format/summary/__snapshots__/formatCoverageSummary.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`formatCoverageSummary should format summary when head and base coverage specified (with threshold) 1`] = `
4 | "| St.:grey_question:
| Category | Percentage | Covered / Total |
5 | | :-: | :- | :- | :-: |
6 | | 🟡 | Statements | 76.67% (+26.67% 🔼)
| 23/30 |"
7 | `;
8 |
9 | exports[`formatCoverageSummary should format summary when head and base coverage specified (with threshold) 2`] = `
10 | "| St.:grey_question:
| Category | Percentage | Covered / Total |
11 | | :-: | :- | :- | :-: |
12 | | 🔴 | Statements | 76.67% (-20% 🔻)
| 23/30 |"
13 | `;
14 |
15 | exports[`formatCoverageSummary should format summary when head and base coverage specified (with threshold) 3`] = `
16 | "| St.:grey_question:
| Category | Percentage | Covered / Total |
17 | | :-: | :- | :- | :-: |
18 | | 🔴 | Statements | 76.67% | 23/30 |"
19 | `;
20 |
21 | exports[`formatCoverageSummary should format summary when head and base coverage specified (with threshold) 4`] = `
22 | "| St.:grey_question:
| Category | Percentage | Covered / Total |
23 | | :-: | :- | :- | :-: |
24 | | 🟢 | Statements | 96.67% | 29/30 |"
25 | `;
26 |
27 | exports[`formatCoverageSummary should format summary when head and base coverage specified 1`] = `
28 | "| St.:grey_question:
| Category | Percentage | Covered / Total |
29 | | :-: | :- | :- | :-: |
30 | | 🟡 | Statements | 76.67% (+26.67% 🔼)
| 23/30 |"
31 | `;
32 |
33 | exports[`formatCoverageSummary should format summary when head and base coverage specified 2`] = `
34 | "| St.:grey_question:
| Category | Percentage | Covered / Total |
35 | | :-: | :- | :- | :-: |
36 | | 🟡 | Statements | 76.67% (-20% 🔻)
| 23/30 |"
37 | `;
38 |
--------------------------------------------------------------------------------
/tests/format/summary/__snapshots__/parseSummary.test.ts.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`parseSummary should parse summary from mock data 1`] = `
4 | Array [
5 | Object {
6 | "covered": 27,
7 | "percentage": 81.81818181818183,
8 | "title": "Statements",
9 | "total": 33,
10 | },
11 | Object {
12 | "covered": 8,
13 | "percentage": 100,
14 | "title": "Branches",
15 | "total": 8,
16 | },
17 | Object {
18 | "covered": 7,
19 | "percentage": 63.63636363636363,
20 | "title": "Functions",
21 | "total": 11,
22 | },
23 | Object {
24 | "covered": 25,
25 | "percentage": 80.64516129032258,
26 | "title": "Lines",
27 | "total": 31,
28 | },
29 | ]
30 | `;
31 |
--------------------------------------------------------------------------------
/tests/format/summary/getSummary.test.ts:
--------------------------------------------------------------------------------
1 | import { getSummary } from '../../../src/format/summary/getSummary';
2 | import { coverageMap } from '../../mock-data/jsonReport.json';
3 |
4 | describe('getSummary', () => {
5 | it('should calculate summary', () => {
6 | const counter = jest.fn(() => 1);
7 |
8 | expect(
9 | getSummary(coverageMap, counter, counter, 'Title')
10 | ).toStrictEqual({
11 | title: 'Title',
12 | total: 6,
13 | covered: 6,
14 | percentage: 100,
15 | });
16 | });
17 | });
18 |
--------------------------------------------------------------------------------
/tests/format/summary/parseSummary.test.ts:
--------------------------------------------------------------------------------
1 | import { parseSummary } from '../../../src/format/summary/parseSummary';
2 | import report from '../../mock-data/jsonReport.json';
3 |
4 | describe('parseSummary', () => {
5 | it('should parse summary from mock data', () => {
6 | expect(parseSummary(report)).toMatchSnapshot();
7 | });
8 | });
9 |
--------------------------------------------------------------------------------
/tests/report/generateCommitReport.test.ts:
--------------------------------------------------------------------------------
1 | import type { getOctokit } from '@actions/github';
2 | import * as all from '@actions/github';
3 |
4 | import { generateCommitReport } from '../../src/report/generateCommitReport';
5 |
6 | const { mockContext, clearContextMock } = all as any;
7 |
8 | describe('generateCommitReport', () => {
9 | it('should generate commit report', async () => {
10 | const createCommitComment = jest.fn();
11 |
12 | mockContext({
13 | sha: '123456',
14 | });
15 |
16 | await generateCommitReport(
17 | 'Report body',
18 | {
19 | owner: 'bot',
20 | repo: 'test-repository',
21 | },
22 | ({
23 | rest: {
24 | repos: {
25 | createCommitComment,
26 | },
27 | },
28 | } as unknown) as ReturnTypeThis is summary
12 |13 | 14 | This is body 15 | 16 |
10% (-10% 🔻)
'
13 | );
14 | expect(formatPercentage(1.15, 20.15)).toBe(
15 | '1.15% (-19% 🔻)
'
16 | );
17 | expect(formatPercentage(1.15, 20)).toBe(
18 | '1.15% (-18.85% 🔻)
'
19 | );
20 | expect(formatPercentage(1.15, 20.1)).toBe(
21 | '1.15% (-18.95% 🔻)
'
22 | );
23 | });
24 |
25 | it('coverage increased', () => {
26 | expect(formatPercentage(20, 10)).toBe(
27 | '20% (+10% 🔼)
'
28 | );
29 | expect(formatPercentage(20.15, 1.15)).toBe(
30 | '20.15% (+19% 🔼)
'
31 | );
32 | expect(formatPercentage(20, 1.15)).toBe(
33 | '20% (+18.85% 🔼)
'
34 | );
35 | expect(formatPercentage(20.1, 1.15)).toBe(
36 | '20.1% (+18.95% 🔼)
'
37 | );
38 | });
39 | });
40 |
--------------------------------------------------------------------------------
/tests/utils/formatPercentageDelta.test.ts:
--------------------------------------------------------------------------------
1 | import { formatPercentageDelta } from '../../src/utils/formatPercentageDelta';
2 |
3 | describe('formatPercentageDelta', () => {
4 | it('negative delta', () => {
5 | expect(formatPercentageDelta(-1)).toBe('(-1% 🔻)');
6 | expect(formatPercentageDelta(-1.00001)).toBe('(-1% 🔻)');
7 | expect(formatPercentageDelta(-1 / 3)).toBe('(-0.33% 🔻)');
8 | expect(formatPercentageDelta(-52.11)).toBe('(-52.11% 🔻)');
9 | });
10 |
11 | it('positive delta', () => {
12 | expect(formatPercentageDelta(1)).toBe('(+1% 🔼)');
13 | expect(formatPercentageDelta(1.00001)).toBe('(+1% 🔼)');
14 | expect(formatPercentageDelta(1 / 3)).toBe('(+0.33% 🔼)');
15 | expect(formatPercentageDelta(52.11)).toBe('(+52.11% 🔼)');
16 | });
17 | });
18 |
--------------------------------------------------------------------------------
/tests/utils/getConsoleLink.test.ts:
--------------------------------------------------------------------------------
1 | import * as all from '@actions/github';
2 |
3 | import { getConsoleLink } from '../../src/utils/getConsoleLink';
4 |
5 | const { mockContext, clearContextMock } = all as any;
6 |
7 | describe('getConsoleLink', () => {
8 | it('should return link (from payload)', () => {
9 | mockContext({
10 | payload: {
11 | repository: {
12 | html_url: 'https://github.com/test/test-repo',
13 | },
14 | },
15 | runId: 111,
16 | });
17 | expect(getConsoleLink()).toBe(
18 | 'https://github.com/test/test-repo/actions/runs/111'
19 | );
20 | clearContextMock();
21 | });
22 |
23 | it('should return link (built from context)', () => {
24 | mockContext({
25 | payload: {},
26 | repo: {
27 | owner: 'test',
28 | repo: 'test-repo',
29 | },
30 | runId: 111,
31 | });
32 | expect(getConsoleLink()).toBe(
33 | 'https://github.com/test/test-repo/actions/runs/111'
34 | );
35 | clearContextMock();
36 | });
37 | });
38 |
--------------------------------------------------------------------------------
/tests/utils/getStatusOfPercents.test.ts:
--------------------------------------------------------------------------------
1 | import { getStatusOfPercents } from '../../src/utils/getStatusOfPercents';
2 |
3 | describe('getStatusOfPercents', () => {
4 | it('should handle threshold by default', () => {
5 | expect(getStatusOfPercents(10)).toBe('🔴');
6 | expect(getStatusOfPercents(33)).toBe('🔴');
7 | expect(getStatusOfPercents(59.99)).toBe('🔴');
8 | expect(getStatusOfPercents(60)).toBe('🟡');
9 | expect(getStatusOfPercents(73.33333)).toBe('🟡');
10 | expect(getStatusOfPercents(79.99)).toBe('🟡');
11 | expect(getStatusOfPercents(80)).toBe('🟢');
12 | expect(getStatusOfPercents(85.15)).toBe('🟢');
13 | expect(getStatusOfPercents(100)).toBe('🟢');
14 | expect(getStatusOfPercents(120)).toBe('🟢');
15 | });
16 |
17 | it('should handle custom threshold', () => {
18 | expect(getStatusOfPercents(10, 80)).toBe('🔴');
19 | expect(getStatusOfPercents(33, 80)).toBe('🔴');
20 | expect(getStatusOfPercents(79.99, 80)).toBe('🔴');
21 | expect(getStatusOfPercents(80, 80)).toBe('🟡');
22 | expect(getStatusOfPercents(85.334534, 80)).toBe('🟡');
23 | expect(getStatusOfPercents(89.999, 80)).toBe('🟡');
24 | expect(getStatusOfPercents(90, 80)).toBe('🟢');
25 | expect(getStatusOfPercents(93.33, 80)).toBe('🟢');
26 | expect(getStatusOfPercents(100, 80)).toBe('🟢');
27 | expect(getStatusOfPercents(120, 80)).toBe('🟢');
28 | });
29 | });
30 |
--------------------------------------------------------------------------------
/tests/utils/i18n.test.ts:
--------------------------------------------------------------------------------
1 | import { i18n } from '../../src/utils/i18n';
2 |
3 | describe('i18n', () => {
4 | it('should insert arguments & icons', () => {
5 | expect(i18n('{{ a }}', { a: 'hello' })).toBe('hello');
6 | expect(i18n(':x: {{ a }}', { a: 'hello' })).toBe('❌ hello');
7 | expect(i18n(':not_specified_icon:')).toBe(':not_specified_icon:');
8 | });
9 |
10 | it('should read string from strings.json', () => {
11 | expect(i18n('status')).toBe('St.');
12 | expect(i18n('errors.multiple')).toBe('Multiple errors occurred');
13 | });
14 | });
15 |
--------------------------------------------------------------------------------
/tests/utils/insertArgs.test.ts:
--------------------------------------------------------------------------------
1 | import { insertArgs } from '../../src/utils/insertArgs';
2 |
3 | describe('insertArgs', () => {
4 | it('should insert arguments', () => {
5 | expect(insertArgs('{{ arg }}', { arg: 'hello' })).toBe('hello');
6 | expect(insertArgs('Hello, {{ name }}!', { name: 'world' })).toBe(
7 | 'Hello, world!'
8 | );
9 | expect(
10 | insertArgs('First: {{ arg1 }}, second: {{ arg2 }}', {
11 | arg1: 'hello',
12 | arg2: 2,
13 | })
14 | ).toBe('First: hello, second: 2');
15 | });
16 |
17 | it('should skip arguments, which are not provided', () => {
18 | expect(insertArgs('{{ notGivenArgument }}', {})).toBe(
19 | '{{ notGivenArgument }}'
20 | );
21 | expect(
22 | insertArgs('{{ given }}, {{ notGivenArgument }}', { given: 'a' })
23 | ).toBe('a, {{ notGivenArgument }}');
24 | });
25 | });
26 |
--------------------------------------------------------------------------------
/tests/utils/joinPaths.test.ts:
--------------------------------------------------------------------------------
1 | import { join } from 'path';
2 |
3 | import { joinPaths } from '../../src/utils/joinPaths';
4 |
5 | describe('joinPaths', () => {
6 | it('should filter undefined paths', () => {
7 | expect(
8 | joinPaths('hello', undefined, 'a', undefined, undefined, 'b')
9 | ).toBe(join('hello', 'a', 'b'));
10 |
11 | expect(joinPaths('asdf', undefined, 'bcc')).toBe(join('asdf', 'bcc'));
12 | });
13 | });
14 |
--------------------------------------------------------------------------------
/tests/utils/removeDirectory.test.ts:
--------------------------------------------------------------------------------
1 | import { rm, rmdir } from 'fs-extra';
2 | import { mocked } from 'ts-jest/utils';
3 |
4 | import { removeDirectory } from '../../src/utils/removeDirectory';
5 |
6 | const originalProcess = process;
7 |
8 | beforeEach(() => {
9 | mocked(rm).mockClear();
10 | mocked(rmdir).mockClear();
11 | });
12 |
13 | afterEach(() => {
14 | global.process = originalProcess;
15 | });
16 |
17 | describe('removeDirectory', () => {
18 | it('should call rmdir when node version is < 14.14.0', async () => {
19 | global.process = {
20 | ...originalProcess,
21 | version: 'v14.3.9',
22 | };
23 | await removeDirectory('asdf');
24 | expect(rm).not.toBeCalled();
25 | expect(rmdir).toBeCalled();
26 | });
27 |
28 | it('should call rm when node version is >=14.14.0', async () => {
29 | global.process = {
30 | ...originalProcess,
31 | version: 'v14.14.0',
32 | };
33 | await removeDirectory('asdf');
34 | expect(rm).toBeCalled();
35 | expect(rmdir).not.toBeCalled();
36 | });
37 | });
38 |
--------------------------------------------------------------------------------
/tests/utils/runStage.test.ts:
--------------------------------------------------------------------------------
1 | import { createDataCollector } from '../../src/utils/DataCollector';
2 | import { runStage } from '../../src/utils/runStage';
3 |
4 | describe('runStage', () => {
5 | it('should run successfully', async () => {
6 | const dataCollector = createDataCollector();
7 | const [succeed, result] = await runStage(
8 | 'initialize',
9 | dataCollector,
10 | () => {
11 | return Promise.resolve('some result');
12 | }
13 | );
14 |
15 | expect(succeed).toBeTruthy();
16 | expect(result).toBe('some result');
17 | expect(dataCollector.get().messages).toStrictEqual([
18 | 'Begin initialization stage...',
19 | 'Initialization stage ended',
20 | ]);
21 | });
22 |
23 | it('should skip', async () => {
24 | const dataCollector = createDataCollector();
25 | const [succeed, result] = await runStage(
26 | 'initialize',
27 | dataCollector,
28 | (skip) => {
29 | skip();
30 | }
31 | );
32 |
33 | expect(succeed).toBeFalsy();
34 | expect(result).toBe(undefined);
35 | expect(dataCollector.get().messages).toStrictEqual([
36 | 'Begin initialization stage...',
37 | 'Initialization stage skipped',
38 | 'Initialization stage ended',
39 | ]);
40 | });
41 |
42 | it('should fail', async () => {
43 | const dataCollector = createDataCollector();
44 | const [succeed, result] = await runStage(
45 | 'initialize',
46 | dataCollector,
47 | () => {
48 | return Promise.reject('New error');
49 | }
50 | );
51 |
52 | expect(succeed).toBeFalsy();
53 | expect(result).toBe(undefined);
54 | expect(dataCollector.get().messages).toStrictEqual([
55 | 'Begin initialization stage...',
56 | 'Initialization stage failed',
57 | 'Initialization stage ended',
58 | ]);
59 | expect(dataCollector.get().errors).toStrictEqual(['New error']);
60 | });
61 | });
62 |
--------------------------------------------------------------------------------
/tests/utils/withExplanation.test.ts:
--------------------------------------------------------------------------------
1 | import { withExplanation } from '../../src/utils/withExplanation';
2 |
3 | describe('withExplanation', () => {
4 | it('should add explanation', () => {
5 | expect(withExplanation('test', 'This is simple explanation')).toBe(
6 | 'test:grey_question:
'
7 | );
8 | });
9 | });
10 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "ES2019",
4 | "module": "commonjs",
5 | "declaration": false,
6 | "outDir": "./dist",
7 | "strict": true,
8 | "esModuleInterop": true,
9 | "lib": ["ES2019", "DOM" /* dirty hack, otherwise typescript doesn't find URL */],
10 | "rootDir": "src",
11 | "resolveJsonModule": true
12 | },
13 | "include": ["src", "index.d.ts"],
14 | "exclude": ["node_modules", "tests", "example"]
15 | }
16 |
--------------------------------------------------------------------------------