@textlint/fixer-formatter 15.7.1 → 16.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,6 @@
1
1
  import type { TextlintFixResult } from "@textlint/types";
2
- export default function (results: TextlintFixResult[], options?: {
2
+ export default function (results: TextlintFixResult[], options: {
3
3
  color?: boolean;
4
+ getSource: (filePath: string) => string | undefined;
4
5
  }): string;
5
6
  //# sourceMappingURL=diff.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../../src/formatters/diff.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAkDzD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,iBAAiB,EAAE,EAAE,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAO,UAqGvF"}
1
+ {"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../../src/formatters/diff.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAyCzD,MAAM,CAAC,OAAO,WACV,OAAO,EAAE,iBAAiB,EAAE,EAC5B,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAA;CAAE,UAyGpF"}
@@ -1,55 +1,9 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || (function () {
19
- var ownKeys = function(o) {
20
- ownKeys = Object.getOwnPropertyNames || function (o) {
21
- var ar = [];
22
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
- return ar;
24
- };
25
- return ownKeys(o);
26
- };
27
- return function (mod) {
28
- if (mod && mod.__esModule) return mod;
29
- var result = {};
30
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
- __setModuleDefault(result, mod);
32
- return result;
33
- };
34
- })();
35
- var __importDefault = (this && this.__importDefault) || function (mod) {
36
- return (mod && mod.__esModule) ? mod : { "default": mod };
37
- };
38
2
  Object.defineProperty(exports, "__esModule", { value: true });
39
3
  exports.default = default_1;
40
- const fs = __importStar(require("node:fs"));
41
4
  const diff_1 = require("diff");
42
- const chalk_1 = __importDefault(require("chalk"));
43
- const strip_ansi_1 = __importDefault(require("strip-ansi"));
44
- const isFile = (filePath) => {
45
- try {
46
- const stats = fs.statSync(filePath);
47
- return stats.isFile();
48
- }
49
- catch (error) {
50
- return false;
51
- }
52
- };
5
+ const node_util_1 = require("node:util");
6
+ const node_util_2 = require("node:util");
53
7
  /**
54
8
  * Given a word and a count, append an s if count is not one.
55
9
  * @param {string} word A word in its singular form.
@@ -77,7 +31,7 @@ function addMarkEachLine(mark, text) {
77
31
  });
78
32
  return `${markedLines.join("\n")}\n`;
79
33
  }
80
- function default_1(results, options = {}) {
34
+ function default_1(results, options) {
81
35
  // default: true
82
36
  const useColor = options.color !== undefined ? options.color : true;
83
37
  let output = "\n";
@@ -95,18 +49,19 @@ function default_1(results, options = {}) {
95
49
  if (messages.length === 0) {
96
50
  return;
97
51
  }
98
- if (!isFile(filePath)) {
52
+ // The result does not have the content before fixing
53
+ const originalContent = options.getSource(filePath);
54
+ if (originalContent === undefined) {
99
55
  return;
100
56
  }
101
- output += `${chalk_1.default.underline(result.filePath)}\n`;
102
- const originalContent = fs.readFileSync(filePath, "utf-8");
57
+ output += `${(0, node_util_1.styleText)("underline", result.filePath)}\n`;
103
58
  const diff = (0, diff_1.diffLines)(originalContent, result.output);
104
59
  diff.forEach(function (part, index) {
105
60
  var _a;
106
61
  const prevLine = diff[index - 1];
107
62
  const nextLine = diff[index + 1];
108
63
  if (!isModified(part) && ((_a = part.count) !== null && _a !== void 0 ? _a : 0) > 1) {
109
- const greyColor = "grey";
64
+ const greyColor = "gray";
110
65
  /*
111
66
  <MODIFIED>
112
67
  first line
@@ -114,12 +69,12 @@ function default_1(results, options = {}) {
114
69
  */
115
70
  if (isModified(prevLine)) {
116
71
  const lines = part.value.split("\n");
117
- output += `${chalk_1.default[greyColor](lines[0])}\n`;
72
+ output += `${(0, node_util_1.styleText)(greyColor, lines[0])}\n`;
118
73
  }
119
- output += chalk_1.default[greyColor]("...");
74
+ output += (0, node_util_1.styleText)(greyColor, "...");
120
75
  if (isModified(nextLine)) {
121
76
  const lines = part.value.split("\n");
122
- output += `${chalk_1.default[greyColor](lines[lines.length - 1])}\n`;
77
+ output += `${(0, node_util_1.styleText)(greyColor, lines[lines.length - 1])}\n`;
123
78
  }
124
79
  /*
125
80
  ...
@@ -129,7 +84,7 @@ function default_1(results, options = {}) {
129
84
  return;
130
85
  }
131
86
  // green for additions, red for deletions
132
- // grey for common parts
87
+ // gray for common parts
133
88
  let lineColor;
134
89
  let diffMark = "";
135
90
  if (part.added) {
@@ -141,15 +96,15 @@ function default_1(results, options = {}) {
141
96
  diffMark = "- ";
142
97
  }
143
98
  else {
144
- lineColor = "grey";
99
+ lineColor = "gray";
145
100
  diffMark = "";
146
101
  }
147
- output += chalk_1.default[lineColor](addMarkEachLine(diffMark, part.value));
102
+ output += (0, node_util_1.styleText)(lineColor, addMarkEachLine(diffMark, part.value));
148
103
  });
149
104
  output += "\n\n";
150
105
  });
151
106
  if (totalFixed > 0) {
152
- output += chalk_1.default[greenColor].bold([
107
+ output += (0, node_util_1.styleText)([greenColor, "bold"], [
153
108
  // http://www.fileformat.info/info/unicode/char/2714/index.htm
154
109
  "✔ Fixed ",
155
110
  totalFixed,
@@ -158,7 +113,7 @@ function default_1(results, options = {}) {
158
113
  ].join(""));
159
114
  }
160
115
  if (errors > 0) {
161
- output += chalk_1.default[summaryColor].bold([
116
+ output += (0, node_util_1.styleText)([summaryColor, "bold"], [
162
117
  // http://www.fileformat.info/info/unicode/char/2716/index.htm
163
118
  "✖ Remaining ",
164
119
  errors,
@@ -168,7 +123,7 @@ function default_1(results, options = {}) {
168
123
  }
169
124
  const finalOutput = totalFixed > 0 ? output : "";
170
125
  if (!useColor) {
171
- return (0, strip_ansi_1.default)(finalOutput);
126
+ return (0, node_util_2.stripVTControlCharacters)(finalOutput);
172
127
  }
173
128
  return finalOutput;
174
129
  }
@@ -1 +1 @@
1
- {"version":3,"file":"diff.js","sourceRoot":"","sources":["../../../src/formatters/diff.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmDb,4BAqGC;AAtJD,4CAA8B;AAC9B,+BAAiC;AACjC,kDAA0B;AAC1B,4DAAmC;AAQnC,MAAM,MAAM,GAAG,CAAC,QAAgB,EAAE,EAAE;IAChC,IAAI,CAAC;QACD,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACpC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AACF;;;;;GAKG;AACH,SAAS,SAAS,CAAC,IAAY,EAAE,KAAa;IAC1C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC;AAC3C,CAAC;AAED,SAAS,UAAU,CAAC,IAAc;IAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACzF,CAAC;AAED,SAAS,eAAe,CAAC,IAAY,EAAE,IAAY;IAC/C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,WAAW,GAAG,KAAK;SACpB,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACzC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;QAClB,OAAO,IAAI,GAAG,IAAI,CAAC;IACvB,CAAC,CAAC,CAAC;IACP,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACzC,CAAC;AAED,mBAAyB,OAA4B,EAAE,UAA+B,EAAE;IACpF,gBAAgB;IAChB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACpE,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,MAAM,YAAY,GAAG,QAAQ,CAAC;IAC9B,MAAM,UAAU,GAAG,OAAO,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAC,UAAU,MAAM;QAC5B,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACzC,oBAAoB;QACpB,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACnD,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC;QACnC,UAAU,IAAI,QAAQ,CAAC,MAAM,CAAC;QAC9B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO;QACX,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpB,OAAO;QACX,CAAC;QACD,MAAM,IAAI,GAAG,eAAK,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAElD,MAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAEvD,IAAI,CAAC,OAAO,CAAC,UAAU,IAAc,EAAE,KAAa;;YAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAa,CAAC;YAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAa,CAAC;YAC7C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,IAAI,CAAC,KAAK,mCAAI,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7C,MAAM,SAAS,GAAG,MAAM,CAAC;gBACzB;;;;mBAIG;gBACH,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrC,MAAM,IAAI,GAAG,eAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAChD,CAAC;gBACD,MAAM,IAAI,eAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC;gBAClC,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrC,MAAM,IAAI,GAAG,eAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC/D,CAAC;gBACD;;;;mBAIG;gBACH,OAAO;YACX,CAAC;YACD,yCAAyC;YACzC,wBAAwB;YACxB,IAAI,SAAmC,CAAC;YACxC,IAAI,QAAQ,GAAG,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,SAAS,GAAG,OAAO,CAAC;gBACpB,QAAQ,GAAG,IAAI,CAAC;YACpB,CAAC;iBAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACtB,SAAS,GAAG,KAAK,CAAC;gBAClB,QAAQ,GAAG,IAAI,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACJ,SAAS,GAAG,MAAM,CAAC;gBACnB,QAAQ,GAAG,EAAE,CAAC;YAClB,CAAC;YACD,MAAM,IAAI,eAAK,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,MAAM,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,eAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAC5B;YACI,8DAA8D;YAC9D,UAAU;YACV,UAAU;YACV,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;YACjC,IAAI;SACP,CAAC,IAAI,CAAC,EAAE,CAAC,CACb,CAAC;IACN,CAAC;IAED,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACb,MAAM,IAAI,eAAK,CAAC,YAAY,CAAC,CAAC,IAAI,CAC9B;YACI,8DAA8D;YAC9D,cAAc;YACd,MAAM;YACN,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;YAC7B,IAAI;SACP,CAAC,IAAI,CAAC,EAAE,CAAC,CACb,CAAC;IACN,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,OAAO,IAAA,oBAAS,EAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,WAAW,CAAC;AACvB,CAAC"}
1
+ {"version":3,"file":"diff.js","sourceRoot":"","sources":["../../../src/formatters/diff.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AA0Cb,4BA2GC;AAnJD,+BAAiC;AACjC,yCAAsC;AACtC,yCAAkE;AAQlE;;;;;GAKG;AACH,SAAS,SAAS,CAAC,IAAY,EAAE,KAAa;IAC1C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC;AAC3C,CAAC;AAED,SAAS,UAAU,CAAC,IAAc;IAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACzF,CAAC;AAED,SAAS,eAAe,CAAC,IAAY,EAAE,IAAY;IAC/C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,WAAW,GAAG,KAAK;SACpB,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACzC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;QAClB,OAAO,IAAI,GAAG,IAAI,CAAC;IACvB,CAAC,CAAC,CAAC;IACP,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACzC,CAAC;AAED,mBACI,OAA4B,EAC5B,OAAiF;IAEjF,gBAAgB;IAChB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACpE,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,MAAM,YAAY,GAAG,QAAQ,CAAC;IAC9B,MAAM,UAAU,GAAG,OAAO,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAC,UAAU,MAAM;QAC5B,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACzC,oBAAoB;QACpB,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACnD,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC;QACnC,UAAU,IAAI,QAAQ,CAAC,MAAM,CAAC;QAC9B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO;QACX,CAAC;QACD,qDAAqD;QACrD,MAAM,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO;QACX,CAAC;QACD,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAEzD,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAEvD,IAAI,CAAC,OAAO,CAAC,UAAU,IAAc,EAAE,KAAa;;YAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAa,CAAC;YAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAa,CAAC;YAC7C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,IAAI,CAAC,KAAK,mCAAI,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7C,MAAM,SAAS,GAAG,MAAM,CAAC;gBACzB;;;;mBAIG;gBACH,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrC,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBACpD,CAAC;gBACD,MAAM,IAAI,IAAA,qBAAS,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBACtC,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrC,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;gBACnE,CAAC;gBACD;;;;mBAIG;gBACH,OAAO;YACX,CAAC;YACD,yCAAyC;YACzC,wBAAwB;YACxB,IAAI,SAAmC,CAAC;YACxC,IAAI,QAAQ,GAAG,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,SAAS,GAAG,OAAO,CAAC;gBACpB,QAAQ,GAAG,IAAI,CAAC;YACpB,CAAC;iBAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACtB,SAAS,GAAG,KAAK,CAAC;gBAClB,QAAQ,GAAG,IAAI,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACJ,SAAS,GAAG,MAAM,CAAC;gBACnB,QAAQ,GAAG,EAAE,CAAC;YAClB,CAAC;YACD,MAAM,IAAI,IAAA,qBAAS,EAAC,SAAS,EAAE,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,MAAM,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,IAAA,qBAAS,EACf,CAAC,UAAU,EAAE,MAAM,CAAC,EACpB;YACI,8DAA8D;YAC9D,UAAU;YACV,UAAU;YACV,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;YACjC,IAAI;SACP,CAAC,IAAI,CAAC,EAAE,CAAC,CACb,CAAC;IACN,CAAC;IAED,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACb,MAAM,IAAI,IAAA,qBAAS,EACf,CAAC,YAAY,EAAE,MAAM,CAAC,EACtB;YACI,8DAA8D;YAC9D,cAAc;YACd,MAAM;YACN,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;YAC7B,IAAI;SACP,CAAC,IAAI,CAAC,EAAE,CAAC,CACb,CAAC;IACN,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,OAAO,IAAA,oCAAS,EAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,WAAW,CAAC;AACvB,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"stylish.d.ts","sourceRoot":"","sources":["../../../src/formatters/stylish.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAkBzD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,UA2GlF"}
1
+ {"version":3,"file":"stylish.d.ts","sourceRoot":"","sources":["../../../src/formatters/stylish.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAezD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,UAkGlF"}
@@ -1,14 +1,8 @@
1
1
  "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
2
  Object.defineProperty(exports, "__esModule", { value: true });
6
3
  exports.default = default_1;
7
- const chalk_1 = __importDefault(require("chalk"));
8
- // @ts-expect-error no types
9
- const text_table_1 = __importDefault(require("text-table"));
10
- const string_width_1 = __importDefault(require("string-width"));
11
- const strip_ansi_1 = __importDefault(require("strip-ansi"));
4
+ const node_util_1 = require("node:util");
5
+ const align_columns_js_1 = require("../helper/align-columns.js");
12
6
  /**
13
7
  * Given a word and a count, append an s if count is not one.
14
8
  * @param {string} word A word in its singular form.
@@ -51,38 +45,30 @@ function default_1(results, options) {
51
45
  if (messages.length === 0) {
52
46
  return;
53
47
  }
54
- output += `${chalk_1.default.underline(result.filePath)}\n`;
55
- output += `${(0, text_table_1.default)(messages.map(function (message) {
48
+ output += `${(0, node_util_1.styleText)("underline", result.filePath)}\n`;
49
+ output += `${(0, align_columns_js_1.alignColumns)(messages.map(function (message) {
56
50
  // fixable
57
51
  totalFixed++;
58
- const messageType = chalk_1.default[greenColor].bold("\u2714 ");
52
+ const messageType = (0, node_util_1.styleText)([greenColor, "bold"], "\u2714 ");
59
53
  return [
60
54
  "",
61
55
  message.line || 0,
62
56
  message.column || 0,
63
57
  messageType,
64
58
  message.message.replace(/\.$/, ""),
65
- chalk_1.default.gray(message.ruleId || "")
59
+ (0, node_util_1.styleText)("gray", message.ruleId || "")
66
60
  ];
67
- }), {
68
- align: ["", "r", "l"],
69
- stringLength: (str) => {
70
- const lines = (0, strip_ansi_1.default)(str).split("\n");
71
- return Math.max.apply(null, lines.map(function (line) {
72
- return (0, string_width_1.default)(line);
73
- }));
74
- }
75
- })
61
+ }), ["", "r", "l"])
76
62
  .split("\n")
77
63
  .map(function (el) {
78
64
  return el.replace(/(\d+)\s+(\d+)/, function (_m, p1, p2) {
79
- return chalk_1.default.gray(`${p1}:${p2}`);
65
+ return (0, node_util_1.styleText)("gray", `${p1}:${p2}`);
80
66
  });
81
67
  })
82
68
  .join("\n")}\n\n`;
83
69
  });
84
70
  if (totalFixed > 0) {
85
- output += chalk_1.default[greenColor].bold([
71
+ output += (0, node_util_1.styleText)([greenColor, "bold"], [
86
72
  // http://www.fileformat.info/info/unicode/char/2714/index.htm
87
73
  "\u2714 Fixed ",
88
74
  totalFixed,
@@ -97,7 +83,7 @@ function default_1(results, options) {
97
83
  `${warnings} ${pluralize("warning", warnings)}`,
98
84
  `${infos} ${pluralize("info", infos)}`
99
85
  ];
100
- output += chalk_1.default[summaryColor].bold([
86
+ output += (0, node_util_1.styleText)([summaryColor, "bold"], [
101
87
  // http://www.fileformat.info/info/unicode/char/2716/index.htm
102
88
  "\u2716 Remaining ",
103
89
  summaryParts.join(", "),
@@ -106,7 +92,7 @@ function default_1(results, options) {
106
92
  }
107
93
  const finalOutput = totalFixed > 0 ? output : "";
108
94
  if (!useColor) {
109
- return (0, strip_ansi_1.default)(finalOutput);
95
+ return (0, node_util_1.stripVTControlCharacters)(finalOutput);
110
96
  }
111
97
  return finalOutput;
112
98
  }
@@ -1 +1 @@
1
- {"version":3,"file":"stylish.js","sourceRoot":"","sources":["../../../src/formatters/stylish.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;AAmBb,4BA2GC;AA3HD,kDAA0B;AAC1B,4BAA4B;AAC5B,4DAA+B;AAC/B,gEAAyC;AACzC,4DAAmC;AAEnC;;;;;GAKG;AACH,SAAS,SAAS,CAAC,IAAY,EAAE,KAAa;IAC1C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC;AAC3C,CAAC;AAED,mBAAyB,OAA4B,EAAE,OAA4B;IAC/E,gBAAgB;IAChB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACpE,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,YAAY,GAAG,QAAQ,CAAC;IAC9B,MAAM,UAAU,GAAG,OAAO,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAC,UAAU,MAAM;QAC5B,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YACxD,OAAO;QACX,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACzC,oBAAoB;QACpB,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QAEnD,uCAAuC;QACvC,iBAAiB,CAAC,OAAO,CAAC,UAAU,OAAO;YACvC,MAAM,KAAK,GAAI,OAA+B,CAAC,KAAK,CAAC;YACrD,IAAI,KAAK,IAAI,OAAO,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;gBAClC,MAAM,EAAE,CAAC;YACb,CAAC;iBAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;gBAChC,QAAQ,EAAE,CAAC;YACf,CAAC;iBAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;gBAChC,KAAK,EAAE,CAAC;YACZ,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO;QACX,CAAC;QACD,MAAM,IAAI,GAAG,eAAK,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAElD,MAAM,IAAI,GAAG,IAAA,oBAAK,EACd,QAAQ,CAAC,GAAG,CAAC,UAAU,OAAO;YAC1B,UAAU;YACV,UAAU,EAAE,CAAC;YACb,MAAM,WAAW,GAAG,eAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAEtD,OAAO;gBACH,EAAE;gBACF,OAAO,CAAC,IAAI,IAAI,CAAC;gBACjB,OAAO,CAAC,MAAM,IAAI,CAAC;gBACnB,WAAW;gBACX,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;gBAClC,eAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;aACnC,CAAC;QACN,CAAC,CAAC,EACF;YACI,KAAK,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC;YACrB,YAAY,EAAE,CAAC,GAAW,EAAE,EAAE;gBAC1B,MAAM,KAAK,GAAG,IAAA,oBAAS,EAAC,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACzC,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CACjB,IAAI,EACJ,KAAK,CAAC,GAAG,CAAC,UAAU,IAAY;oBAC5B,OAAO,IAAA,sBAAa,EAAC,IAAI,CAAC,CAAC;gBAC/B,CAAC,CAAC,CACL,CAAC;YACN,CAAC;SACJ,CACJ;aACI,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,UAAU,EAAU;YACrB,OAAO,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,EAAE;gBACnD,OAAO,eAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,eAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAC5B;YACI,8DAA8D;YAC9D,eAAe;YACf,UAAU;YACV,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;YACjC,IAAI;SACP,CAAC,IAAI,CAAC,EAAE,CAAC,CACb,CAAC;IACN,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IACjD,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,YAAY,GAAG;YACjB,GAAG,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YACzC,GAAG,QAAQ,IAAI,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE;YAC/C,GAAG,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;SACzC,CAAC;QACF,MAAM,IAAI,eAAK,CAAC,YAAY,CAAC,CAAC,IAAI,CAC9B;YACI,8DAA8D;YAC9D,mBAAmB;YACnB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACvB,IAAI;SACP,CAAC,IAAI,CAAC,EAAE,CAAC,CACb,CAAC;IACN,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,OAAO,IAAA,oBAAS,EAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,WAAW,CAAC;AACvB,CAAC"}
1
+ {"version":3,"file":"stylish.js","sourceRoot":"","sources":["../../../src/formatters/stylish.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAgBb,4BAkGC;AA/GD,yCAA6E;AAC7E,iEAA0D;AAE1D;;;;;GAKG;AACH,SAAS,SAAS,CAAC,IAAY,EAAE,KAAa;IAC1C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC;AAC3C,CAAC;AAED,mBAAyB,OAA4B,EAAE,OAA4B;IAC/E,gBAAgB;IAChB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACpE,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,YAAY,GAAG,QAAQ,CAAC;IAC9B,MAAM,UAAU,GAAG,OAAO,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAC,UAAU,MAAM;QAC5B,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YACxD,OAAO;QACX,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACzC,oBAAoB;QACpB,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QAEnD,uCAAuC;QACvC,iBAAiB,CAAC,OAAO,CAAC,UAAU,OAAO;YACvC,MAAM,KAAK,GAAI,OAA+B,CAAC,KAAK,CAAC;YACrD,IAAI,KAAK,IAAI,OAAO,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;gBAClC,MAAM,EAAE,CAAC;YACb,CAAC;iBAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;gBAChC,QAAQ,EAAE,CAAC;YACf,CAAC;iBAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;gBAChC,KAAK,EAAE,CAAC;YACZ,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO;QACX,CAAC;QACD,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAEzD,MAAM,IAAI,GAAG,IAAA,+BAAY,EACrB,QAAQ,CAAC,GAAG,CAAC,UAAU,OAAO;YAC1B,UAAU;YACV,UAAU,EAAE,CAAC;YACb,MAAM,WAAW,GAAG,IAAA,qBAAS,EAAC,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;YAE/D,OAAO;gBACH,EAAE;gBACF,OAAO,CAAC,IAAI,IAAI,CAAC;gBACjB,OAAO,CAAC,MAAM,IAAI,CAAC;gBACnB,WAAW;gBACX,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;gBAClC,IAAA,qBAAS,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;aAC1C,CAAC;QACN,CAAC,CAAC,EACF,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CACjB;aACI,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,UAAU,EAAU;YACrB,OAAO,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,EAAE;gBACnD,OAAO,IAAA,qBAAS,EAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,IAAA,qBAAS,EACf,CAAC,UAAU,EAAE,MAAM,CAAC,EACpB;YACI,8DAA8D;YAC9D,eAAe;YACf,UAAU;YACV,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;YACjC,IAAI;SACP,CAAC,IAAI,CAAC,EAAE,CAAC,CACb,CAAC;IACN,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IACjD,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,YAAY,GAAG;YACjB,GAAG,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YACzC,GAAG,QAAQ,IAAI,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE;YAC/C,GAAG,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;SACzC,CAAC;QACF,MAAM,IAAI,IAAA,qBAAS,EACf,CAAC,YAAY,EAAE,MAAM,CAAC,EACtB;YACI,8DAA8D;YAC9D,mBAAmB;YACnB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACvB,IAAI;SACP,CAAC,IAAI,CAAC,EAAE,CAAC,CACb,CAAC;IACN,CAAC;IAED,MAAM,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,OAAO,IAAA,oCAAS,EAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,WAAW,CAAC;AACvB,CAAC"}
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Align the columns of the rows with spaces, and join the columns with two spaces.
3
+ * The trailing whitespaces of each row are removed with `trimEnd`.
4
+ * A cell can have escape sequences and fullwidth characters.
5
+ *
6
+ * It is compatible with `text-table` package with the `stringLength` option that uses `stringWidth`.
7
+ * https://www.npmjs.com/package/text-table
8
+ *
9
+ * @param rows rows of the cells
10
+ * @param align "r" aligns the column to the right. Otherwise, the column is aligned to the left
11
+ */
12
+ export declare const alignColumns: (rows: (string | number)[][], align?: string[]) => string;
13
+ //# sourceMappingURL=align-columns.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"align-columns.d.ts","sourceRoot":"","sources":["../../../src/helper/align-columns.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,EAAE,QAAO,MAAM,EAAO,KAAG,MAmBhF,CAAC"}
@@ -0,0 +1,45 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.alignColumns = void 0;
4
+ const node_util_1 = require("node:util");
5
+ const string_width_js_1 = require("./string-width.js");
6
+ /**
7
+ * The width of the longest line of the text
8
+ */
9
+ const maxLineWidth = (text) => {
10
+ return Math.max(...(0, node_util_1.stripVTControlCharacters)(text).split("\n").map(string_width_js_1.stringWidth));
11
+ };
12
+ /**
13
+ * Align the columns of the rows with spaces, and join the columns with two spaces.
14
+ * The trailing whitespaces of each row are removed with `trimEnd`.
15
+ * A cell can have escape sequences and fullwidth characters.
16
+ *
17
+ * It is compatible with `text-table` package with the `stringLength` option that uses `stringWidth`.
18
+ * https://www.npmjs.com/package/text-table
19
+ *
20
+ * @param rows rows of the cells
21
+ * @param align "r" aligns the column to the right. Otherwise, the column is aligned to the left
22
+ */
23
+ const alignColumns = (rows, align = []) => {
24
+ const textRows = rows.map((row) => row.map((cell) => String(cell)));
25
+ const columnWidths = [];
26
+ for (const row of textRows) {
27
+ row.forEach((cell, index) => {
28
+ var _a;
29
+ columnWidths[index] = Math.max((_a = columnWidths[index]) !== null && _a !== void 0 ? _a : 0, maxLineWidth(cell));
30
+ });
31
+ }
32
+ return textRows
33
+ .map((row) => {
34
+ return row
35
+ .map((cell, index) => {
36
+ const space = " ".repeat(Math.max(columnWidths[index] - maxLineWidth(cell), 0));
37
+ return align[index] === "r" ? space + cell : cell + space;
38
+ })
39
+ .join(" ")
40
+ .trimEnd();
41
+ })
42
+ .join("\n");
43
+ };
44
+ exports.alignColumns = alignColumns;
45
+ //# sourceMappingURL=align-columns.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"align-columns.js","sourceRoot":"","sources":["../../../src/helper/align-columns.ts"],"names":[],"mappings":";;;AAAA,yCAAqD;AACrD,uDAAgD;AAEhD;;GAEG;AACH,MAAM,YAAY,GAAG,CAAC,IAAY,EAAU,EAAE;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAA,oCAAwB,EAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,6BAAW,CAAC,CAAC,CAAC;AACpF,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,YAAY,GAAG,CAAC,IAA2B,EAAE,QAAkB,EAAE,EAAU,EAAE;IACtF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpE,MAAM,YAAY,GAAa,EAAE,CAAC;IAClC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QACzB,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;;YACxB,YAAY,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAA,YAAY,CAAC,KAAK,CAAC,mCAAI,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,QAAQ;SACV,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACT,OAAO,GAAG;aACL,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACjB,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAChF,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC;QAC9D,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC;aACV,OAAO,EAAE,CAAC;IACnB,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC,CAAC;AAnBW,QAAA,YAAY,gBAmBvB"}
@@ -0,0 +1,21 @@
1
+ /**
2
+ * A text that has an emoji matches this pattern. It is a cheap check before creating the emoji pattern.
3
+ * Each emoji has one of them:
4
+ *
5
+ * - U+203C..U+2B55, U+3030, U+303D, U+3297, U+3299: the emoji of the Basic Multilingual Plane, and U+20E3 of a keycap
6
+ * - U+FE0F: the variation selector of an emoji that is a text character by default, such as "\u00A9\uFE0F"
7
+ * - U+D83C..U+D83E: the high surrogate of U+1F000..U+1FFFF
8
+ */
9
+ export declare const MAY_HAVE_EMOJI_PATTERN: RegExp;
10
+ /**
11
+ * Get the number of the columns that the string uses in a terminal.
12
+ * It is based on https://github.com/sindresorhus/string-width v4
13
+ *
14
+ * Node.js has the same function internally, but it is not a public API yet.
15
+ * Replace this file with the function of Node.js when it is available in the supported versions of Node.js.
16
+ *
17
+ * - An escape sequence, a control character and a combining character use no column
18
+ * - A fullwidth character and an emoji use two columns
19
+ */
20
+ export declare const stringWidth: (text: string) => number;
21
+ //# sourceMappingURL=string-width.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"string-width.d.ts","sourceRoot":"","sources":["../../../src/helper/string-width.ts"],"names":[],"mappings":"AAiBA;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,QAAgE,CAAC;AAuCpG;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,KAAG,MAsB1C,CAAC"}
@@ -0,0 +1,97 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.stringWidth = exports.MAY_HAVE_EMOJI_PATTERN = void 0;
4
+ const node_util_1 = require("node:util");
5
+ /**
6
+ * `\p{RGI_Emoji}` is a large set of strings, and V8 takes about 15-20ms to parse the pattern.
7
+ * So the pattern is created when a text that may have an emoji comes first. Most outputs never create it.
8
+ *
9
+ * Do not write it as a regular expression literal, even in a function:
10
+ * V8 parses a literal when it parses the file, so only loading this file takes the time.
11
+ */
12
+ const getEmojiPattern = (() => {
13
+ // Only this function refers to the created pattern
14
+ let emojiPattern;
15
+ return () => {
16
+ emojiPattern !== null && emojiPattern !== void 0 ? emojiPattern : (emojiPattern = new RegExp("\\p{RGI_Emoji}", "gv"));
17
+ return emojiPattern;
18
+ };
19
+ })();
20
+ /**
21
+ * A text that has an emoji matches this pattern. It is a cheap check before creating the emoji pattern.
22
+ * Each emoji has one of them:
23
+ *
24
+ * - U+203C..U+2B55, U+3030, U+303D, U+3297, U+3299: the emoji of the Basic Multilingual Plane, and U+20E3 of a keycap
25
+ * - U+FE0F: the variation selector of an emoji that is a text character by default, such as "\u00A9\uFE0F"
26
+ * - U+D83C..U+D83E: the high surrogate of U+1F000..U+1FFFF
27
+ */
28
+ exports.MAY_HAVE_EMOJI_PATTERN = /[\u203c-\u2b55\u3030\u303d\u3297\u3299\ud83c-\ud83e]|\ufe0f/;
29
+ /**
30
+ * Code points are derived from https://www.unicode.org/Public/UNIDATA/EastAsianWidth.txt
31
+ */
32
+ const isFullwidthCodePoint = (codePoint) => {
33
+ return (codePoint >= 0x1100 &&
34
+ (codePoint <= 0x115f || // Hangul Jamo
35
+ codePoint === 0x2329 || // LEFT-POINTING ANGLE BRACKET
36
+ codePoint === 0x232a || // RIGHT-POINTING ANGLE BRACKET
37
+ // CJK Radicals Supplement .. Enclosed CJK Letters and Months
38
+ (0x2e80 <= codePoint && codePoint <= 0x3247 && codePoint !== 0x303f) ||
39
+ // Enclosed CJK Letters and Months .. CJK Unified Ideographs Extension A
40
+ (0x3250 <= codePoint && codePoint <= 0x4dbf) ||
41
+ // CJK Unified Ideographs .. Yi Radicals
42
+ (0x4e00 <= codePoint && codePoint <= 0xa4c6) ||
43
+ // Hangul Jamo Extended-A
44
+ (0xa960 <= codePoint && codePoint <= 0xa97c) ||
45
+ // Hangul Syllables
46
+ (0xac00 <= codePoint && codePoint <= 0xd7a3) ||
47
+ // CJK Compatibility Ideographs
48
+ (0xf900 <= codePoint && codePoint <= 0xfaff) ||
49
+ // Vertical Forms
50
+ (0xfe10 <= codePoint && codePoint <= 0xfe19) ||
51
+ // CJK Compatibility Forms .. Small Form Variants
52
+ (0xfe30 <= codePoint && codePoint <= 0xfe6b) ||
53
+ // Halfwidth and Fullwidth Forms
54
+ (0xff01 <= codePoint && codePoint <= 0xff60) ||
55
+ (0xffe0 <= codePoint && codePoint <= 0xffe6) ||
56
+ // Kana Supplement
57
+ (0x1b000 <= codePoint && codePoint <= 0x1b001) ||
58
+ // Enclosed Ideographic Supplement
59
+ (0x1f200 <= codePoint && codePoint <= 0x1f251) ||
60
+ // CJK Unified Ideographs Extension B .. Tertiary Ideographic Plane
61
+ (0x20000 <= codePoint && codePoint <= 0x3fffd)));
62
+ };
63
+ /**
64
+ * Get the number of the columns that the string uses in a terminal.
65
+ * It is based on https://github.com/sindresorhus/string-width v4
66
+ *
67
+ * Node.js has the same function internally, but it is not a public API yet.
68
+ * Replace this file with the function of Node.js when it is available in the supported versions of Node.js.
69
+ *
70
+ * - An escape sequence, a control character and a combining character use no column
71
+ * - A fullwidth character and an emoji use two columns
72
+ */
73
+ const stringWidth = (text) => {
74
+ if (text.length === 0) {
75
+ return 0;
76
+ }
77
+ const strippedText = (0, node_util_1.stripVTControlCharacters)(text);
78
+ const plainText = exports.MAY_HAVE_EMOJI_PATTERN.test(strippedText)
79
+ ? strippedText.replace(getEmojiPattern(), " ")
80
+ : strippedText;
81
+ let width = 0;
82
+ for (const character of plainText) {
83
+ const codePoint = character.codePointAt(0);
84
+ // Ignore control characters
85
+ if (codePoint <= 0x1f || (codePoint >= 0x7f && codePoint <= 0x9f)) {
86
+ continue;
87
+ }
88
+ // Ignore combining characters
89
+ if (codePoint >= 0x300 && codePoint <= 0x36f) {
90
+ continue;
91
+ }
92
+ width += isFullwidthCodePoint(codePoint) ? 2 : 1;
93
+ }
94
+ return width;
95
+ };
96
+ exports.stringWidth = stringWidth;
97
+ //# sourceMappingURL=string-width.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"string-width.js","sourceRoot":"","sources":["../../../src/helper/string-width.ts"],"names":[],"mappings":";;;AAAA,yCAAqD;AAErD;;;;;;GAMG;AACH,MAAM,eAAe,GAAG,CAAC,GAAG,EAAE;IAC1B,mDAAmD;IACnD,IAAI,YAAgC,CAAC;IACrC,OAAO,GAAW,EAAE;QAChB,YAAY,aAAZ,YAAY,cAAZ,YAAY,IAAZ,YAAY,GAAK,IAAI,MAAM,CAAC,gBAAgB,EAAE,IAAI,CAAC,EAAC;QACpD,OAAO,YAAY,CAAC;IACxB,CAAC,CAAC;AACN,CAAC,CAAC,EAAE,CAAC;AACL;;;;;;;GAOG;AACU,QAAA,sBAAsB,GAAG,6DAA6D,CAAC;AAEpG;;GAEG;AACH,MAAM,oBAAoB,GAAG,CAAC,SAAiB,EAAW,EAAE;IACxD,OAAO,CACH,SAAS,IAAI,MAAM;QACnB,CAAC,SAAS,IAAI,MAAM,IAAI,cAAc;YAClC,SAAS,KAAK,MAAM,IAAI,8BAA8B;YACtD,SAAS,KAAK,MAAM,IAAI,+BAA+B;YACvD,6DAA6D;YAC7D,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,IAAI,SAAS,KAAK,MAAM,CAAC;YACpE,wEAAwE;YACxE,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC;YAC5C,wCAAwC;YACxC,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC;YAC5C,yBAAyB;YACzB,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC;YAC5C,mBAAmB;YACnB,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC;YAC5C,+BAA+B;YAC/B,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC;YAC5C,iBAAiB;YACjB,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC;YAC5C,iDAAiD;YACjD,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC;YAC5C,gCAAgC;YAChC,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC;YAC5C,CAAC,MAAM,IAAI,SAAS,IAAI,SAAS,IAAI,MAAM,CAAC;YAC5C,kBAAkB;YAClB,CAAC,OAAO,IAAI,SAAS,IAAI,SAAS,IAAI,OAAO,CAAC;YAC9C,kCAAkC;YAClC,CAAC,OAAO,IAAI,SAAS,IAAI,SAAS,IAAI,OAAO,CAAC;YAC9C,mEAAmE;YACnE,CAAC,OAAO,IAAI,SAAS,IAAI,SAAS,IAAI,OAAO,CAAC,CAAC,CACtD,CAAC;AACN,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACI,MAAM,WAAW,GAAG,CAAC,IAAY,EAAU,EAAE;IAChD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,CAAC;IACb,CAAC;IACD,MAAM,YAAY,GAAG,IAAA,oCAAwB,EAAC,IAAI,CAAC,CAAC;IACpD,MAAM,SAAS,GAAG,8BAAsB,CAAC,IAAI,CAAC,YAAY,CAAC;QACvD,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,IAAI,CAAC;QAC/C,CAAC,CAAC,YAAY,CAAC;IACnB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,SAAS,IAAI,SAAS,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC,CAAE,CAAC;QAC5C,4BAA4B;QAC5B,IAAI,SAAS,IAAI,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,CAAC,EAAE,CAAC;YAChE,SAAS;QACb,CAAC;QACD,8BAA8B;QAC9B,IAAI,SAAS,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;YAC3C,SAAS;QACb,CAAC;QACD,KAAK,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAtBW,QAAA,WAAW,eAsBtB"}
@@ -1,9 +1,27 @@
1
1
  import type { TextlintFixResult } from "@textlint/types";
2
+ /**
3
+ * Get the content of the source before fixing by `filePath` of the result.
4
+ * It returns `undefined` if the caller does not have the content.
5
+ */
6
+ export type FormatterGetSource = (filePath: string) => string | undefined;
2
7
  export type FormatterConfig = {
3
8
  color?: boolean;
4
9
  formatterName: string;
10
+ /**
11
+ * Get the content of the source before fixing by `filePath` of the result.
12
+ * For example, "diff" formatter uses it.
13
+ * If it is not given or returns `undefined`, the formatter gets the content of the file of `filePath`.
14
+ */
15
+ getSource?: FormatterGetSource;
5
16
  };
6
- export declare function loadFormatter(formatterConfig: FormatterConfig): Promise<{
17
+ /**
18
+ * The options that the formatter receives.
19
+ * `loadFormatter()` always passes `getSource`.
20
+ */
21
+ export type FormatterOptions = FormatterConfig & {
22
+ getSource: FormatterGetSource;
23
+ };
24
+ export declare function loadFormatter(config: FormatterConfig): Promise<{
7
25
  format(results: TextlintFixResult[]): string;
8
26
  }>;
9
27
  export interface FixerFormatterDetail {
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AA4BzD,MAAM,MAAM,eAAe,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE,wBAAsB,aAAa,CAAC,eAAe,EAAE,eAAe;oBAKxC,iBAAiB,EAAE;GAiD9C;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,qBAAqB,IAAI,oBAAoB,EAAE,CAM9D"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAqCzD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;AAC1E,MAAM,MAAM,eAAe,GAAG;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC;CAClC,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG;IAC7C,SAAS,EAAE,kBAAkB,CAAC;CACjC,CAAC;AAqBF,wBAAsB,aAAa,CAAC,MAAM,EAAE,eAAe;oBAO/B,iBAAiB,EAAE;GAiD9C;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,qBAAqB,IAAI,oBAAoB,EAAE,CAM9D"}
package/lib/src/index.js CHANGED
@@ -11,32 +11,61 @@ const node_fs_1 = __importDefault(require("node:fs"));
11
11
  const node_path_1 = __importDefault(require("node:path"));
12
12
  const debug_1 = __importDefault(require("debug"));
13
13
  const resolver_1 = require("@textlint/resolver");
14
- // formatters
15
- const compats_js_1 = __importDefault(require("./formatters/compats.js"));
16
- const diff_js_1 = __importDefault(require("./formatters/diff.js"));
17
- const fixed_result_js_1 = __importDefault(require("./formatters/fixed-result.js"));
18
- const json_js_1 = __importDefault(require("./formatters/json.js"));
19
- const stylish_js_1 = __importDefault(require("./formatters/stylish.js"));
14
+ /**
15
+ * Each formatter is loaded when it is used.
16
+ * For example, `diff` formatter loads `diff`, but `stylish` formatter does not.
17
+ */
20
18
  const builtinFormatterList = {
21
- compats: compats_js_1.default,
22
- diff: diff_js_1.default,
23
- "fixed-result": fixed_result_js_1.default,
24
- json: json_js_1.default,
25
- stylish: stylish_js_1.default
19
+ compats: () => import("./formatters/compats.js"),
20
+ diff: () => import("./formatters/diff.js"),
21
+ "fixed-result": () => import("./formatters/fixed-result.js"),
22
+ json: () => import("./formatters/json.js"),
23
+ stylish: () => import("./formatters/stylish.js")
24
+ };
25
+ /**
26
+ * Load the formatter function of a built-in formatter.
27
+ * A formatter file is a CommonJS module, so `import()` returns `{ default: module.exports }` in Node.js.
28
+ * `moduleInterop` gets the default export from `module.exports`.
29
+ */
30
+ const loadBuiltinFormatter = async (name) => {
31
+ const mod = await builtinFormatterList[name]();
32
+ return (0, module_interop_1.moduleInterop)(mod.default);
26
33
  };
27
34
  const isFormatterFunction = (formatter) => {
28
35
  return typeof formatter === "function";
29
36
  };
30
37
  const builtinFormatterNames = Object.keys(builtinFormatterList);
31
38
  const debug = (0, debug_1.default)("textlint:textfix-formatter");
32
- async function loadFormatter(formatterConfig) {
39
+ /**
40
+ * Create `getSource` for the formatter.
41
+ * It returns the content from `getSource` of the caller, and reads the file of `filePath` if the caller does not have the content.
42
+ * It returns `undefined` if the file can not be read.
43
+ * A formatter gets the content only from this function, and does not read the file by itself.
44
+ */
45
+ const createGetSource = (getSource) => {
46
+ return (filePath) => {
47
+ const source = getSource === null || getSource === void 0 ? void 0 : getSource(filePath);
48
+ if (source !== undefined) {
49
+ return source;
50
+ }
51
+ try {
52
+ return node_fs_1.default.readFileSync(filePath, "utf-8");
53
+ }
54
+ catch (_a) {
55
+ return undefined;
56
+ }
57
+ };
58
+ };
59
+ async function loadFormatter(config) {
33
60
  var _a;
61
+ const formatterConfig = { ...config, getSource: createGetSource(config.getSource) };
34
62
  const formatterName = formatterConfig.formatterName;
35
63
  debug(`formatterName: ${formatterName}`);
36
64
  if (builtinFormatterNames.includes(formatterName)) {
65
+ const builtinFormatter = await loadBuiltinFormatter(formatterName);
37
66
  return {
38
67
  format(results) {
39
- return builtinFormatterList[formatterName](results, formatterConfig);
68
+ return builtinFormatter(results, formatterConfig);
40
69
  }
41
70
  };
42
71
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC;;;;;AA+Bb,sCAsDC;AAMD,sDAMC;AA/FD,6DAAyD;AACzD,sDAAyB;AACzB,0DAA6B;AAC7B,kDAA2B;AAC3B,iDAA+D;AAC/D,aAAa;AACb,yEAAuD;AACvD,mEAAiD;AACjD,mFAAgE;AAChE,mEAAiD;AACjD,yEAAuD;AAEvD,MAAM,oBAAoB,GAAG;IACzB,OAAO,EAAE,oBAAgB;IACzB,IAAI,EAAE,iBAAa;IACnB,cAAc,EAAE,yBAAoB;IACpC,IAAI,EAAE,iBAAa;IACnB,OAAO,EAAE,oBAAgB;CACnB,CAAC;AAEX,MAAM,mBAAmB,GAAG,CAAC,SAAkB,EAAkC,EAAE;IAC/E,OAAO,OAAO,SAAS,KAAK,UAAU,CAAC;AAC3C,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;AAChE,MAAM,KAAK,GAAG,IAAA,eAAM,EAAC,4BAA4B,CAAC,CAAC;AAI5C,KAAK,UAAU,aAAa,CAAC,eAAgC;;IAChE,MAAM,aAAa,GAAG,eAAe,CAAC,aAAa,CAAC;IACpD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;IACzC,IAAI,qBAAqB,CAAC,QAAQ,CAAC,aAAqC,CAAC,EAAE,CAAC;QACxE,OAAO;YACH,MAAM,CAAC,OAA4B;gBAC/B,OAAO,oBAAoB,CAAC,aAAqC,CAAC,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YACjG,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,SAA4B,CAAC;IACjC,IAAI,aAAa,CAAC;IAClB,IAAI,iBAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/B,aAAa,GAAG,aAAa,CAAC;IAClC,CAAC;SAAM,IAAI,iBAAE,CAAC,UAAU,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC;QACnE,aAAa,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;IAC/D,CAAC;SAAM,CAAC;QACJ,MAAM,OAAO,GACT,IAAA,qBAAU,EAAC,sBAAsB,aAAa,EAAE,EAAE;YAC9C,YAAY,EAAE,iBAAiB;SAClC,CAAC;YACF,IAAA,qBAAU,EAAC,aAAa,EAAE;gBACtB,YAAY,EAAE,iBAAiB;aAClC,CAAC,CAAC;QACP,IAAI,OAAO,EAAE,CAAC;YACV,aAAa,GAAG,OAAO,CAAC;QAC5B,CAAC;IACL,CAAC;IACD,IAAI,CAAC,aAAa,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,aAAa,EAAE,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,MAAA,IAAA,8BAAa,EACrB,CACI,MAAM,IAAA,wBAAa,EAAC,aAAa,EAAE;YAC/B,YAAY,EAAE,iBAAiB;SAClC,CAAC,CACL,CAAC,OAAO,CACZ,0CAAE,OAAO,CAAC;QACX,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,yCAAyC,aAAa,YAAY,OAAO,GAAG,EAAE,CAAC,CAAC;QACpG,CAAC;QACD,SAAS,GAAG,GAAG,CAAC;IACpB,CAAC;IAAC,OAAO,EAAE,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,4BAA4B,aAAa;;EAE/D,EAAE,EAAE,CAAC,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;IACzC,OAAO;QACH,MAAM,CAAC,OAA4B;YAC/B,OAAO,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAC/C,CAAC;KACJ,CAAC;AACN,CAAC;AAMD,SAAgB,qBAAqB;IACjC,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACtC,OAAO;YACH,IAAI;SACP,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC;;;;;AAgFb,sCAwDC;AAMD,sDAMC;AAlJD,6DAAyD;AACzD,sDAAyB;AACzB,0DAA6B;AAC7B,kDAA2B;AAC3B,iDAA+D;AAI/D;;;GAGG;AACH,MAAM,oBAAoB,GAAG;IACzB,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,yBAAyB,CAAC;IAChD,IAAI,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAC1C,cAAc,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,8BAA8B,CAAC;IAC5D,IAAI,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAC1C,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,yBAAyB,CAAC;CAC1C,CAAC;AACX;;;;GAIG;AACH,MAAM,oBAAoB,GAAG,KAAK,EAAE,IAA0B,EAA6B,EAAE;IACzF,MAAM,GAAG,GAAyB,MAAM,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;IACrE,OAAO,IAAA,8BAAa,EAAC,GAAG,CAAC,OAAO,CAAqB,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,SAAkB,EAAkC,EAAE;IAC/E,OAAO,OAAO,SAAS,KAAK,UAAU,CAAC;AAC3C,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;AAChE,MAAM,KAAK,GAAG,IAAA,eAAM,EAAC,4BAA4B,CAAC,CAAC;AAwBnD;;;;;GAKG;AACH,MAAM,eAAe,GAAG,CAAC,SAA8B,EAAsB,EAAE;IAC3E,OAAO,CAAC,QAAQ,EAAE,EAAE;QAChB,MAAM,MAAM,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,QAAQ,CAAC,CAAC;QACrC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,IAAI,CAAC;YACD,OAAO,iBAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9C,CAAC;QAAC,WAAM,CAAC;YACL,OAAO,SAAS,CAAC;QACrB,CAAC;IACL,CAAC,CAAC;AACN,CAAC,CAAC;AAEK,KAAK,UAAU,aAAa,CAAC,MAAuB;;IACvD,MAAM,eAAe,GAAqB,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;IACtG,MAAM,aAAa,GAAG,eAAe,CAAC,aAAa,CAAC;IACpD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;IACzC,IAAI,qBAAqB,CAAC,QAAQ,CAAC,aAAqC,CAAC,EAAE,CAAC;QACxE,MAAM,gBAAgB,GAAG,MAAM,oBAAoB,CAAC,aAAqC,CAAC,CAAC;QAC3F,OAAO;YACH,MAAM,CAAC,OAA4B;gBAC/B,OAAO,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YACtD,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,SAA4B,CAAC;IACjC,IAAI,aAAa,CAAC;IAClB,IAAI,iBAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/B,aAAa,GAAG,aAAa,CAAC;IAClC,CAAC;SAAM,IAAI,iBAAE,CAAC,UAAU,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC;QACnE,aAAa,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;IAC/D,CAAC;SAAM,CAAC;QACJ,MAAM,OAAO,GACT,IAAA,qBAAU,EAAC,sBAAsB,aAAa,EAAE,EAAE;YAC9C,YAAY,EAAE,iBAAiB;SAClC,CAAC;YACF,IAAA,qBAAU,EAAC,aAAa,EAAE;gBACtB,YAAY,EAAE,iBAAiB;aAClC,CAAC,CAAC;QACP,IAAI,OAAO,EAAE,CAAC;YACV,aAAa,GAAG,OAAO,CAAC;QAC5B,CAAC;IACL,CAAC;IACD,IAAI,CAAC,aAAa,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,aAAa,EAAE,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,MAAA,IAAA,8BAAa,EACrB,CACI,MAAM,IAAA,wBAAa,EAAC,aAAa,EAAE;YAC/B,YAAY,EAAE,iBAAiB;SAClC,CAAC,CACL,CAAC,OAAO,CACZ,0CAAE,OAAO,CAAC;QACX,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,yCAAyC,aAAa,YAAY,OAAO,GAAG,EAAE,CAAC,CAAC;QACpG,CAAC;QACD,SAAS,GAAG,GAAG,CAAC;IACpB,CAAC;IAAC,OAAO,EAAE,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,4BAA4B,aAAa;;EAE/D,EAAE,EAAE,CAAC,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;IACzC,OAAO;QACH,MAAM,CAAC,OAA4B;YAC/B,OAAO,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAC/C,CAAC;KACJ,CAAC;AACN,CAAC;AAMD,SAAgB,qBAAqB;IACjC,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACtC,OAAO;YACH,IAAI;SACP,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@textlint/fixer-formatter",
3
- "version": "15.7.1",
3
+ "version": "16.0.0",
4
4
  "description": "textlint output formatter for fixer",
5
5
  "keywords": [
6
6
  "AST",
@@ -39,25 +39,24 @@
39
39
  "test:watch": "vitest watch"
40
40
  },
41
41
  "dependencies": {
42
- "@textlint/module-interop": "15.7.1",
43
- "@textlint/resolver": "15.7.1",
44
- "@textlint/types": "15.7.1",
45
- "chalk": "^4.1.2",
42
+ "@textlint/module-interop": "16.0.0",
43
+ "@textlint/resolver": "16.0.0",
44
+ "@textlint/types": "16.0.0",
46
45
  "debug": "^4.4.3",
47
- "diff": "^8.0.4",
48
- "string-width": "^4.2.3",
49
- "strip-ansi": "^6.0.1",
50
- "text-table": "^0.2.0"
46
+ "diff": "^8.0.4"
51
47
  },
52
48
  "devDependencies": {
53
49
  "@types/debug": "^4.1.13",
54
- "@types/node": "^24.12.4",
55
- "rimraf": "^6.1.3",
50
+ "@types/node": "^24.19.2",
51
+ "rimraf": "^6.1.4",
56
52
  "typescript": "~5.8.3",
57
- "vitest": "^3.2.4"
53
+ "vitest": "^3.2.7"
58
54
  },
59
55
  "publishConfig": {
60
56
  "access": "public"
61
57
  },
62
- "gitHead": "91ffc5947325f0a9d0500b889550a1b4d232f5f1"
58
+ "engines": {
59
+ "node": ">=22.12.0"
60
+ },
61
+ "gitHead": "c23854983d375b07c10d33f19e7cabc3390d383b"
63
62
  }
@@ -1,9 +1,8 @@
1
1
  "use strict";
2
2
  import type { TextlintFixResult } from "@textlint/types";
3
- import * as fs from "node:fs";
4
3
  import { diffLines } from "diff";
5
- import chalk from "chalk";
6
- import stripAnsi from "strip-ansi";
4
+ import { styleText } from "node:util";
5
+ import { stripVTControlCharacters as stripAnsi } from "node:util";
7
6
 
8
7
  type DiffPart = {
9
8
  value: string;
@@ -11,14 +10,6 @@ type DiffPart = {
11
10
  added?: boolean;
12
11
  removed?: boolean;
13
12
  };
14
- const isFile = (filePath: string) => {
15
- try {
16
- const stats = fs.statSync(filePath);
17
- return stats.isFile();
18
- } catch (error) {
19
- return false;
20
- }
21
- };
22
13
  /**
23
14
  * Given a word and a count, append an s if count is not one.
24
15
  * @param {string} word A word in its singular form.
@@ -49,7 +40,10 @@ function addMarkEachLine(mark: string, text: string) {
49
40
  return `${markedLines.join("\n")}\n`;
50
41
  }
51
42
 
52
- export default function (results: TextlintFixResult[], options: { color?: boolean } = {}) {
43
+ export default function (
44
+ results: TextlintFixResult[],
45
+ options: { color?: boolean; getSource: (filePath: string) => string | undefined }
46
+ ) {
53
47
  // default: true
54
48
  const useColor = options.color !== undefined ? options.color : true;
55
49
  let output = "\n";
@@ -68,19 +62,20 @@ export default function (results: TextlintFixResult[], options: { color?: boolea
68
62
  if (messages.length === 0) {
69
63
  return;
70
64
  }
71
- if (!isFile(filePath)) {
65
+ // The result does not have the content before fixing
66
+ const originalContent = options.getSource(filePath);
67
+ if (originalContent === undefined) {
72
68
  return;
73
69
  }
74
- output += `${chalk.underline(result.filePath)}\n`;
70
+ output += `${styleText("underline", result.filePath)}\n`;
75
71
 
76
- const originalContent = fs.readFileSync(filePath, "utf-8");
77
72
  const diff = diffLines(originalContent, result.output);
78
73
 
79
74
  diff.forEach(function (part: DiffPart, index: number) {
80
75
  const prevLine = diff[index - 1] as DiffPart;
81
76
  const nextLine = diff[index + 1] as DiffPart;
82
77
  if (!isModified(part) && (part.count ?? 0) > 1) {
83
- const greyColor = "grey";
78
+ const greyColor = "gray";
84
79
  /*
85
80
  <MODIFIED>
86
81
  first line
@@ -88,12 +83,12 @@ export default function (results: TextlintFixResult[], options: { color?: boolea
88
83
  */
89
84
  if (isModified(prevLine)) {
90
85
  const lines = part.value.split("\n");
91
- output += `${chalk[greyColor](lines[0])}\n`;
86
+ output += `${styleText(greyColor, lines[0])}\n`;
92
87
  }
93
- output += chalk[greyColor]("...");
88
+ output += styleText(greyColor, "...");
94
89
  if (isModified(nextLine)) {
95
90
  const lines = part.value.split("\n");
96
- output += `${chalk[greyColor](lines[lines.length - 1])}\n`;
91
+ output += `${styleText(greyColor, lines[lines.length - 1])}\n`;
97
92
  }
98
93
  /*
99
94
  ...
@@ -103,8 +98,8 @@ export default function (results: TextlintFixResult[], options: { color?: boolea
103
98
  return;
104
99
  }
105
100
  // green for additions, red for deletions
106
- // grey for common parts
107
- let lineColor: "green" | "red" | "grey";
101
+ // gray for common parts
102
+ let lineColor: "green" | "red" | "gray";
108
103
  let diffMark = "";
109
104
  if (part.added) {
110
105
  lineColor = "green";
@@ -113,16 +108,17 @@ export default function (results: TextlintFixResult[], options: { color?: boolea
113
108
  lineColor = "red";
114
109
  diffMark = "- ";
115
110
  } else {
116
- lineColor = "grey";
111
+ lineColor = "gray";
117
112
  diffMark = "";
118
113
  }
119
- output += chalk[lineColor](addMarkEachLine(diffMark, part.value));
114
+ output += styleText(lineColor, addMarkEachLine(diffMark, part.value));
120
115
  });
121
116
  output += "\n\n";
122
117
  });
123
118
 
124
119
  if (totalFixed > 0) {
125
- output += chalk[greenColor].bold(
120
+ output += styleText(
121
+ [greenColor, "bold"],
126
122
  [
127
123
  // http://www.fileformat.info/info/unicode/char/2714/index.htm
128
124
  "✔ Fixed ",
@@ -134,7 +130,8 @@ export default function (results: TextlintFixResult[], options: { color?: boolea
134
130
  }
135
131
 
136
132
  if (errors > 0) {
137
- output += chalk[summaryColor].bold(
133
+ output += styleText(
134
+ [summaryColor, "bold"],
138
135
  [
139
136
  // http://www.fileformat.info/info/unicode/char/2716/index.htm
140
137
  "✖ Remaining ",
@@ -1,11 +1,8 @@
1
1
  "use strict";
2
2
  import type { TextlintFixResult } from "@textlint/types";
3
3
 
4
- import chalk from "chalk";
5
- // @ts-expect-error no types
6
- import table from "text-table";
7
- import widthOfString from "string-width";
8
- import stripAnsi from "strip-ansi";
4
+ import { styleText, stripVTControlCharacters as stripAnsi } from "node:util";
5
+ import { alignColumns } from "../helper/align-columns.js";
9
6
 
10
7
  /**
11
8
  * Given a word and a count, append an s if count is not one.
@@ -51,13 +48,13 @@ export default function (results: TextlintFixResult[], options: { color?: boolea
51
48
  if (messages.length === 0) {
52
49
  return;
53
50
  }
54
- output += `${chalk.underline(result.filePath)}\n`;
51
+ output += `${styleText("underline", result.filePath)}\n`;
55
52
 
56
- output += `${table(
53
+ output += `${alignColumns(
57
54
  messages.map(function (message) {
58
55
  // fixable
59
56
  totalFixed++;
60
- const messageType = chalk[greenColor].bold("\u2714 ");
57
+ const messageType = styleText([greenColor, "bold"], "\u2714 ");
61
58
 
62
59
  return [
63
60
  "",
@@ -65,33 +62,23 @@ export default function (results: TextlintFixResult[], options: { color?: boolea
65
62
  message.column || 0,
66
63
  messageType,
67
64
  message.message.replace(/\.$/, ""),
68
- chalk.gray(message.ruleId || "")
65
+ styleText("gray", message.ruleId || "")
69
66
  ];
70
67
  }),
71
- {
72
- align: ["", "r", "l"],
73
- stringLength: (str: string) => {
74
- const lines = stripAnsi(str).split("\n");
75
- return Math.max.apply(
76
- null,
77
- lines.map(function (line: string) {
78
- return widthOfString(line);
79
- })
80
- );
81
- }
82
- }
68
+ ["", "r", "l"]
83
69
  )
84
70
  .split("\n")
85
71
  .map(function (el: string) {
86
72
  return el.replace(/(\d+)\s+(\d+)/, function (_m, p1, p2) {
87
- return chalk.gray(`${p1}:${p2}`);
73
+ return styleText("gray", `${p1}:${p2}`);
88
74
  });
89
75
  })
90
76
  .join("\n")}\n\n`;
91
77
  });
92
78
 
93
79
  if (totalFixed > 0) {
94
- output += chalk[greenColor].bold(
80
+ output += styleText(
81
+ [greenColor, "bold"],
95
82
  [
96
83
  // http://www.fileformat.info/info/unicode/char/2714/index.htm
97
84
  "\u2714 Fixed ",
@@ -109,7 +96,8 @@ export default function (results: TextlintFixResult[], options: { color?: boolea
109
96
  `${warnings} ${pluralize("warning", warnings)}`,
110
97
  `${infos} ${pluralize("info", infos)}`
111
98
  ];
112
- output += chalk[summaryColor].bold(
99
+ output += styleText(
100
+ [summaryColor, "bold"],
113
101
  [
114
102
  // http://www.fileformat.info/info/unicode/char/2716/index.htm
115
103
  "\u2716 Remaining ",
@@ -0,0 +1,41 @@
1
+ import { stripVTControlCharacters } from "node:util";
2
+ import { stringWidth } from "./string-width.js";
3
+
4
+ /**
5
+ * The width of the longest line of the text
6
+ */
7
+ const maxLineWidth = (text: string): number => {
8
+ return Math.max(...stripVTControlCharacters(text).split("\n").map(stringWidth));
9
+ };
10
+
11
+ /**
12
+ * Align the columns of the rows with spaces, and join the columns with two spaces.
13
+ * The trailing whitespaces of each row are removed with `trimEnd`.
14
+ * A cell can have escape sequences and fullwidth characters.
15
+ *
16
+ * It is compatible with `text-table` package with the `stringLength` option that uses `stringWidth`.
17
+ * https://www.npmjs.com/package/text-table
18
+ *
19
+ * @param rows rows of the cells
20
+ * @param align "r" aligns the column to the right. Otherwise, the column is aligned to the left
21
+ */
22
+ export const alignColumns = (rows: (string | number)[][], align: string[] = []): string => {
23
+ const textRows = rows.map((row) => row.map((cell) => String(cell)));
24
+ const columnWidths: number[] = [];
25
+ for (const row of textRows) {
26
+ row.forEach((cell, index) => {
27
+ columnWidths[index] = Math.max(columnWidths[index] ?? 0, maxLineWidth(cell));
28
+ });
29
+ }
30
+ return textRows
31
+ .map((row) => {
32
+ return row
33
+ .map((cell, index) => {
34
+ const space = " ".repeat(Math.max(columnWidths[index] - maxLineWidth(cell), 0));
35
+ return align[index] === "r" ? space + cell : cell + space;
36
+ })
37
+ .join(" ")
38
+ .trimEnd();
39
+ })
40
+ .join("\n");
41
+ };
@@ -0,0 +1,97 @@
1
+ import { stripVTControlCharacters } from "node:util";
2
+
3
+ /**
4
+ * `\p{RGI_Emoji}` is a large set of strings, and V8 takes about 15-20ms to parse the pattern.
5
+ * So the pattern is created when a text that may have an emoji comes first. Most outputs never create it.
6
+ *
7
+ * Do not write it as a regular expression literal, even in a function:
8
+ * V8 parses a literal when it parses the file, so only loading this file takes the time.
9
+ */
10
+ const getEmojiPattern = (() => {
11
+ // Only this function refers to the created pattern
12
+ let emojiPattern: RegExp | undefined;
13
+ return (): RegExp => {
14
+ emojiPattern ??= new RegExp("\\p{RGI_Emoji}", "gv");
15
+ return emojiPattern;
16
+ };
17
+ })();
18
+ /**
19
+ * A text that has an emoji matches this pattern. It is a cheap check before creating the emoji pattern.
20
+ * Each emoji has one of them:
21
+ *
22
+ * - U+203C..U+2B55, U+3030, U+303D, U+3297, U+3299: the emoji of the Basic Multilingual Plane, and U+20E3 of a keycap
23
+ * - U+FE0F: the variation selector of an emoji that is a text character by default, such as "\u00A9\uFE0F"
24
+ * - U+D83C..U+D83E: the high surrogate of U+1F000..U+1FFFF
25
+ */
26
+ export const MAY_HAVE_EMOJI_PATTERN = /[\u203c-\u2b55\u3030\u303d\u3297\u3299\ud83c-\ud83e]|\ufe0f/;
27
+
28
+ /**
29
+ * Code points are derived from https://www.unicode.org/Public/UNIDATA/EastAsianWidth.txt
30
+ */
31
+ const isFullwidthCodePoint = (codePoint: number): boolean => {
32
+ return (
33
+ codePoint >= 0x1100 &&
34
+ (codePoint <= 0x115f || // Hangul Jamo
35
+ codePoint === 0x2329 || // LEFT-POINTING ANGLE BRACKET
36
+ codePoint === 0x232a || // RIGHT-POINTING ANGLE BRACKET
37
+ // CJK Radicals Supplement .. Enclosed CJK Letters and Months
38
+ (0x2e80 <= codePoint && codePoint <= 0x3247 && codePoint !== 0x303f) ||
39
+ // Enclosed CJK Letters and Months .. CJK Unified Ideographs Extension A
40
+ (0x3250 <= codePoint && codePoint <= 0x4dbf) ||
41
+ // CJK Unified Ideographs .. Yi Radicals
42
+ (0x4e00 <= codePoint && codePoint <= 0xa4c6) ||
43
+ // Hangul Jamo Extended-A
44
+ (0xa960 <= codePoint && codePoint <= 0xa97c) ||
45
+ // Hangul Syllables
46
+ (0xac00 <= codePoint && codePoint <= 0xd7a3) ||
47
+ // CJK Compatibility Ideographs
48
+ (0xf900 <= codePoint && codePoint <= 0xfaff) ||
49
+ // Vertical Forms
50
+ (0xfe10 <= codePoint && codePoint <= 0xfe19) ||
51
+ // CJK Compatibility Forms .. Small Form Variants
52
+ (0xfe30 <= codePoint && codePoint <= 0xfe6b) ||
53
+ // Halfwidth and Fullwidth Forms
54
+ (0xff01 <= codePoint && codePoint <= 0xff60) ||
55
+ (0xffe0 <= codePoint && codePoint <= 0xffe6) ||
56
+ // Kana Supplement
57
+ (0x1b000 <= codePoint && codePoint <= 0x1b001) ||
58
+ // Enclosed Ideographic Supplement
59
+ (0x1f200 <= codePoint && codePoint <= 0x1f251) ||
60
+ // CJK Unified Ideographs Extension B .. Tertiary Ideographic Plane
61
+ (0x20000 <= codePoint && codePoint <= 0x3fffd))
62
+ );
63
+ };
64
+
65
+ /**
66
+ * Get the number of the columns that the string uses in a terminal.
67
+ * It is based on https://github.com/sindresorhus/string-width v4
68
+ *
69
+ * Node.js has the same function internally, but it is not a public API yet.
70
+ * Replace this file with the function of Node.js when it is available in the supported versions of Node.js.
71
+ *
72
+ * - An escape sequence, a control character and a combining character use no column
73
+ * - A fullwidth character and an emoji use two columns
74
+ */
75
+ export const stringWidth = (text: string): number => {
76
+ if (text.length === 0) {
77
+ return 0;
78
+ }
79
+ const strippedText = stripVTControlCharacters(text);
80
+ const plainText = MAY_HAVE_EMOJI_PATTERN.test(strippedText)
81
+ ? strippedText.replace(getEmojiPattern(), " ")
82
+ : strippedText;
83
+ let width = 0;
84
+ for (const character of plainText) {
85
+ const codePoint = character.codePointAt(0)!;
86
+ // Ignore control characters
87
+ if (codePoint <= 0x1f || (codePoint >= 0x7f && codePoint <= 0x9f)) {
88
+ continue;
89
+ }
90
+ // Ignore combining characters
91
+ if (codePoint >= 0x300 && codePoint <= 0x36f) {
92
+ continue;
93
+ }
94
+ width += isFullwidthCodePoint(codePoint) ? 2 : 1;
95
+ }
96
+ return width;
97
+ };
package/src/index.ts CHANGED
@@ -7,20 +7,29 @@ import path from "node:path";
7
7
  import debug0 from "debug";
8
8
  import { tryResolve, dynamicImport } from "@textlint/resolver";
9
9
  // formatters
10
- import compatsFormatter from "./formatters/compats.js";
11
- import diffFormatter from "./formatters/diff.js";
12
- import fixedResultFormatter from "./formatters/fixed-result.js";
13
- import jsonFormatter from "./formatters/json.js";
14
- import stylishFormatter from "./formatters/stylish.js";
15
10
 
11
+ type BuiltinFormatter = (results: TextlintFixResult[], options: FormatterOptions) => string;
12
+ /**
13
+ * Each formatter is loaded when it is used.
14
+ * For example, `diff` formatter loads `diff`, but `stylish` formatter does not.
15
+ */
16
16
  const builtinFormatterList = {
17
- compats: compatsFormatter,
18
- diff: diffFormatter,
19
- "fixed-result": fixedResultFormatter,
20
- json: jsonFormatter,
21
- stylish: stylishFormatter
17
+ compats: () => import("./formatters/compats.js"),
18
+ diff: () => import("./formatters/diff.js"),
19
+ "fixed-result": () => import("./formatters/fixed-result.js"),
20
+ json: () => import("./formatters/json.js"),
21
+ stylish: () => import("./formatters/stylish.js")
22
22
  } as const;
23
- type FormatterFunction = (results: TextlintFixResult[], formatterConfig: FormatterConfig) => string;
23
+ /**
24
+ * Load the formatter function of a built-in formatter.
25
+ * A formatter file is a CommonJS module, so `import()` returns `{ default: module.exports }` in Node.js.
26
+ * `moduleInterop` gets the default export from `module.exports`.
27
+ */
28
+ const loadBuiltinFormatter = async (name: BuiltInFormatterName): Promise<BuiltinFormatter> => {
29
+ const mod: { default: unknown } = await builtinFormatterList[name]();
30
+ return moduleInterop(mod.default) as BuiltinFormatter;
31
+ };
32
+ type FormatterFunction = (results: TextlintFixResult[], formatterConfig: FormatterOptions) => string;
24
33
  const isFormatterFunction = (formatter: unknown): formatter is FormatterFunction => {
25
34
  return typeof formatter === "function";
26
35
  };
@@ -28,15 +37,57 @@ type BuiltInFormatterName = keyof typeof builtinFormatterList;
28
37
  const builtinFormatterNames = Object.keys(builtinFormatterList);
29
38
  const debug = debug0("textlint:textfix-formatter");
30
39
 
31
- export type FormatterConfig = { color?: boolean; formatterName: string };
40
+ /**
41
+ * Get the content of the source before fixing by `filePath` of the result.
42
+ * It returns `undefined` if the caller does not have the content.
43
+ */
44
+ export type FormatterGetSource = (filePath: string) => string | undefined;
45
+ export type FormatterConfig = {
46
+ color?: boolean;
47
+ formatterName: string;
48
+ /**
49
+ * Get the content of the source before fixing by `filePath` of the result.
50
+ * For example, "diff" formatter uses it.
51
+ * If it is not given or returns `undefined`, the formatter gets the content of the file of `filePath`.
52
+ */
53
+ getSource?: FormatterGetSource;
54
+ };
55
+ /**
56
+ * The options that the formatter receives.
57
+ * `loadFormatter()` always passes `getSource`.
58
+ */
59
+ export type FormatterOptions = FormatterConfig & {
60
+ getSource: FormatterGetSource;
61
+ };
62
+ /**
63
+ * Create `getSource` for the formatter.
64
+ * It returns the content from `getSource` of the caller, and reads the file of `filePath` if the caller does not have the content.
65
+ * It returns `undefined` if the file can not be read.
66
+ * A formatter gets the content only from this function, and does not read the file by itself.
67
+ */
68
+ const createGetSource = (getSource?: FormatterGetSource): FormatterGetSource => {
69
+ return (filePath) => {
70
+ const source = getSource?.(filePath);
71
+ if (source !== undefined) {
72
+ return source;
73
+ }
74
+ try {
75
+ return fs.readFileSync(filePath, "utf-8");
76
+ } catch {
77
+ return undefined;
78
+ }
79
+ };
80
+ };
32
81
 
33
- export async function loadFormatter(formatterConfig: FormatterConfig) {
82
+ export async function loadFormatter(config: FormatterConfig) {
83
+ const formatterConfig: FormatterOptions = { ...config, getSource: createGetSource(config.getSource) };
34
84
  const formatterName = formatterConfig.formatterName;
35
85
  debug(`formatterName: ${formatterName}`);
36
86
  if (builtinFormatterNames.includes(formatterName as BuiltInFormatterName)) {
87
+ const builtinFormatter = await loadBuiltinFormatter(formatterName as BuiltInFormatterName);
37
88
  return {
38
89
  format(results: TextlintFixResult[]) {
39
- return builtinFormatterList[formatterName as BuiltInFormatterName](results, formatterConfig);
90
+ return builtinFormatter(results, formatterConfig);
40
91
  }
41
92
  };
42
93
  }