Skip to content

Commit 5fbbfba

Browse files
C0ZENC0ZEN
authored
fix(logs): coloured logs (#465)
* refactor(logs): replace chalk by ansi-styles * test(logs): fix the failing tests due to ansi styles I was not able to disable or mock ansi-styles so instead I found a way to make the tests pass it's not perfect but it's still nice because the logs will keep their trustful colour when running through the tests * refactor(logs): simplify the syntax to colour the logs * chore(rebase): update files due to rebase * refactor(logger): reduce code duplication
1 parent e884599 commit 5fbbfba

15 files changed

+689
-2280
lines changed

‎.eslintrc.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"@typescript-eslint/no-array-constructor": "error",
2929
"@typescript-eslint/no-empty-interface": "error",
3030
"@typescript-eslint/no-explicit-any": "off",
31-
"@typescript-eslint/no-extraneous-class": "error",
31+
"@typescript-eslint/no-extraneous-class": "off",
3232
"@typescript-eslint/no-for-in-array": "error",
3333
"@typescript-eslint/no-inferrable-types": "error",
3434
"@typescript-eslint/no-misused-new": "error",

‎dist/index.js

+410-2,079
Large diffs are not rendered by default.

‎jest.config.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,5 @@ module.exports = {
77
transform: {
88
'^.+\\.ts$': 'ts-jest'
99
},
10-
verbose: true,
11-
setupFilesAfterEnv: [`./jest/test.ts`]
10+
verbose: true
1211
};

‎jest/test.ts

-11
This file was deleted.

‎package-lock.json

+41-58
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"@typescript-eslint/eslint-plugin": "^4.16.1",
4444
"@typescript-eslint/parser": "^4.22.1",
4545
"@vercel/ncc": "^0.27.0",
46-
"chalk": "^4.1.0",
46+
"ansi-styles": "5.2.0",
4747
"eslint": "^7.21.0",
4848
"eslint-plugin-github": "^4.1.2",
4949
"eslint-plugin-jest": "^24.3.6",

‎src/classes/assignees.ts

+24-21
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
import chalk from 'chalk';
21
import deburr from 'lodash.deburr';
32
import {Option} from '../enums/option';
43
import {wordsToList} from '../functions/words-to-list';
54
import {IAssignee} from '../interfaces/assignee';
65
import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
76
import {Issue} from './issue';
87
import {IssueLogger} from './loggers/issue-logger';
8+
import {LoggerService} from '../services/logger.service';
99

1010
type CleanAssignee = string;
1111

@@ -34,7 +34,7 @@ export class Assignees {
3434

3535
if (this._shouldExemptAllAssignees()) {
3636
this._issueLogger.info(
37-
chalk.white('└──'),
37+
LoggerService.white('└──'),
3838
'Skipping this $$type because it has an exempt assignee'
3939
);
4040

@@ -45,7 +45,7 @@ export class Assignees {
4545

4646
if (exemptAssignees.length === 0) {
4747
this._issueLogger.info(
48-
chalk.white('├──'),
48+
LoggerService.white('├──'),
4949
`No assignee option was specified to skip the stale process for this $$type`
5050
);
5151
this._logSkip();
@@ -54,8 +54,8 @@ export class Assignees {
5454
}
5555

5656
this._issueLogger.info(
57-
chalk.white('├──'),
58-
`Found ${chalk.cyan(exemptAssignees.length)} assignee${
57+
LoggerService.white('├──'),
58+
`Found ${LoggerService.cyan(exemptAssignees.length)} assignee${
5959
exemptAssignees.length > 1 ? 's' : ''
6060
} that can exempt stale on this $$type`
6161
);
@@ -67,13 +67,13 @@ export class Assignees {
6767

6868
if (!hasExemptAssignee) {
6969
this._issueLogger.info(
70-
chalk.white('├──'),
70+
LoggerService.white('├──'),
7171
'No assignee on this $$type can exempt the stale process'
7272
);
7373
this._logSkip();
7474
} else {
7575
this._issueLogger.info(
76-
chalk.white('└──'),
76+
LoggerService.white('└──'),
7777
'Skipping this $$type because it has an exempt assignee'
7878
);
7979
}
@@ -90,15 +90,15 @@ export class Assignees {
9090
private _getExemptIssueAssignees(): string[] {
9191
if (this._options.exemptIssueAssignees === '') {
9292
this._issueLogger.info(
93-
chalk.white('├──'),
93+
LoggerService.white('├──'),
9494
`The option ${this._issueLogger.createOptionLink(
9595
Option.ExemptIssueAssignees
9696
)} is disabled. No specific assignee can skip the stale process for this $$type`
9797
);
9898

9999
if (this._options.exemptAssignees === '') {
100100
this._issueLogger.info(
101-
chalk.white('├──'),
101+
LoggerService.white('├──'),
102102
`The option ${this._issueLogger.createOptionLink(
103103
Option.ExemptAssignees
104104
)} is disabled. No specific assignee can skip the stale process for this $$type`
@@ -112,10 +112,10 @@ export class Assignees {
112112
);
113113

114114
this._issueLogger.info(
115-
chalk.white('├──'),
115+
LoggerService.white('├──'),
116116
`The option ${this._issueLogger.createOptionLink(
117117
Option.ExemptAssignees
118-
)} is set. ${chalk.cyan(exemptAssignees.length)} assignee${
118+
)} is set. ${LoggerService.cyan(exemptAssignees.length)} assignee${
119119
exemptAssignees.length === 1 ? '' : 's'
120120
} can skip the stale process for this $$type`
121121
);
@@ -128,10 +128,10 @@ export class Assignees {
128128
);
129129

130130
this._issueLogger.info(
131-
chalk.white('├──'),
131+
LoggerService.white('├──'),
132132
`The option ${this._issueLogger.createOptionLink(
133133
Option.ExemptIssueAssignees
134-
)} is set. ${chalk.cyan(exemptAssignees.length)} assignee${
134+
)} is set. ${LoggerService.cyan(exemptAssignees.length)} assignee${
135135
exemptAssignees.length === 1 ? '' : 's'
136136
} can skip the stale process for this $$type`
137137
);
@@ -142,15 +142,15 @@ export class Assignees {
142142
private _getExemptPullRequestAssignees(): string[] {
143143
if (this._options.exemptPrAssignees === '') {
144144
this._issueLogger.info(
145-
chalk.white('├──'),
145+
LoggerService.white('├──'),
146146
`The option ${this._issueLogger.createOptionLink(
147147
Option.ExemptPrAssignees
148148
)} is disabled. No specific assignee can skip the stale process for this $$type`
149149
);
150150

151151
if (this._options.exemptAssignees === '') {
152152
this._issueLogger.info(
153-
chalk.white('├──'),
153+
LoggerService.white('├──'),
154154
`The option ${this._issueLogger.createOptionLink(
155155
Option.ExemptAssignees
156156
)} is disabled. No specific assignee can skip the stale process for this $$type`
@@ -164,10 +164,10 @@ export class Assignees {
164164
);
165165

166166
this._issueLogger.info(
167-
chalk.white('├──'),
167+
LoggerService.white('├──'),
168168
`The option ${this._issueLogger.createOptionLink(
169169
Option.ExemptAssignees
170-
)} is set. ${chalk.cyan(exemptAssignees.length)} assignee${
170+
)} is set. ${LoggerService.cyan(exemptAssignees.length)} assignee${
171171
exemptAssignees.length === 1 ? '' : 's'
172172
} can skip the stale process for this $$type`
173173
);
@@ -180,10 +180,10 @@ export class Assignees {
180180
);
181181

182182
this._issueLogger.info(
183-
chalk.white('├──'),
183+
LoggerService.white('├──'),
184184
`The option ${this._issueLogger.createOptionLink(
185185
Option.ExemptPrAssignees
186-
)} is set. ${chalk.cyan(exemptAssignees.length)} assignee${
186+
)} is set. ${LoggerService.cyan(exemptAssignees.length)} assignee${
187187
exemptAssignees.length === 1 ? '' : 's'
188188
} can skip the stale process for this $$type`
189189
);
@@ -201,7 +201,7 @@ export class Assignees {
201201

202202
if (isSameAssignee) {
203203
this._issueLogger.info(
204-
chalk.white('├──'),
204+
LoggerService.white('├──'),
205205
`@${issueAssignee.login} is assigned on this $$type and is an exempt assignee`
206206
);
207207
}
@@ -282,6 +282,9 @@ export class Assignees {
282282
}
283283

284284
private _logSkip(): void {
285-
this._issueLogger.info(chalk.white('└──'), 'Skip the assignees checks');
285+
this._issueLogger.info(
286+
LoggerService.white('└──'),
287+
'Skip the assignees checks'
288+
);
286289
}
287290
}

0 commit comments

Comments
 (0)