@textlint/fixer-formatter 12.2.3 → 12.3.1
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.
- package/lib/src/formatters/compats.d.ts +1 -0
- package/lib/src/formatters/compats.d.ts.map +1 -0
- package/lib/src/formatters/diff.d.ts +1 -0
- package/lib/src/formatters/diff.d.ts.map +1 -0
- package/lib/src/formatters/json.d.ts +1 -0
- package/lib/src/formatters/json.d.ts.map +1 -0
- package/lib/src/formatters/stylish.d.ts +1 -0
- package/lib/src/formatters/stylish.d.ts.map +1 -0
- package/lib/src/index.d.ts +10 -1
- package/lib/src/index.d.ts.map +1 -0
- package/lib/src/index.js +78 -7
- package/lib/src/index.js.map +1 -1
- package/module/src/formatters/compats.d.ts +1 -0
- package/module/src/formatters/compats.d.ts.map +1 -0
- package/module/src/formatters/diff.d.ts +1 -0
- package/module/src/formatters/diff.d.ts.map +1 -0
- package/module/src/formatters/json.d.ts +1 -0
- package/module/src/formatters/json.d.ts.map +1 -0
- package/module/src/formatters/stylish.d.ts +1 -0
- package/module/src/formatters/stylish.d.ts.map +1 -0
- package/module/src/index.d.ts +10 -1
- package/module/src/index.d.ts.map +1 -0
- package/module/src/index.js +72 -3
- package/module/src/index.js.map +1 -1
- package/package.json +63 -63
- package/src/index.ts +57 -3
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"compats.d.ts","sourceRoot":"","sources":["../../../src/formatters/compats.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AASzD,wBAAgB,MAAM,CAAC,OAAO,EAAE,iBAAiB,EAAE,UAyBlD"}
|
|
@@ -0,0 +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;AAoCzD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE,GAAG,OAqGlE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../../src/formatters/json.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,iBAAiB,EAAE,UAEpD"}
|
|
@@ -0,0 +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;AAiBzD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE,GAAG,OAwFlE"}
|
package/lib/src/index.d.ts
CHANGED
|
@@ -1,10 +1,19 @@
|
|
|
1
1
|
import type { TextlintFixResult } from "@textlint/types";
|
|
2
|
-
export declare
|
|
2
|
+
export declare function dynamicImport(targetPath: string): Promise<any>;
|
|
3
|
+
export type FormatterConfig = {
|
|
3
4
|
color?: boolean;
|
|
4
5
|
formatterName: string;
|
|
5
6
|
};
|
|
7
|
+
export declare function loadFormatter(formatterConfig: FormatterConfig): Promise<{
|
|
8
|
+
format(results: TextlintFixResult[]): string;
|
|
9
|
+
}>;
|
|
10
|
+
/**
|
|
11
|
+
* @deprecated use loadFormatter
|
|
12
|
+
* @param formatterConfig
|
|
13
|
+
*/
|
|
6
14
|
export declare function createFormatter(formatterConfig: FormatterConfig): (results: TextlintFixResult[]) => string;
|
|
7
15
|
export interface FixerFormatterDetail {
|
|
8
16
|
name: string;
|
|
9
17
|
}
|
|
10
18
|
export declare function getFixerFormatterList(): FixerFormatterDetail[];
|
|
19
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAczD,wBAAsB,aAAa,CAAC,UAAU,EAAE,MAAM,gBAGrD;AAID,MAAM,MAAM,eAAe,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE,wBAAsB,aAAa,CAAC,eAAe,EAAE,eAAe;oBA+B5C,iBAAiB,EAAE;GAI1C;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,eAAe,EAAE,eAAe,aA6BlC,iBAAiB,EAAE,YAGhD;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,qBAAqB,IAAI,oBAAoB,EAAE,CAU9D"}
|
package/lib/src/index.js
CHANGED
|
@@ -1,16 +1,87 @@
|
|
|
1
1
|
// LICENSE : MIT
|
|
2
2
|
"use strict";
|
|
3
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
4
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
5
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
6
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
7
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
8
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
9
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
10
|
+
});
|
|
11
|
+
};
|
|
3
12
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
4
13
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
5
14
|
};
|
|
6
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.getFixerFormatterList = exports.createFormatter = void 0;
|
|
16
|
+
exports.getFixerFormatterList = exports.createFormatter = exports.loadFormatter = exports.dynamicImport = void 0;
|
|
8
17
|
const module_interop_1 = require("@textlint/module-interop");
|
|
9
18
|
const fs_1 = __importDefault(require("fs"));
|
|
10
19
|
const path_1 = __importDefault(require("path"));
|
|
11
|
-
const
|
|
12
|
-
|
|
13
|
-
const
|
|
20
|
+
const debug_1 = __importDefault(require("debug"));
|
|
21
|
+
// @ts-expect-error
|
|
22
|
+
const is_file_1 = __importDefault(require("is-file"));
|
|
23
|
+
// @ts-expect-error
|
|
24
|
+
const try_resolve_1 = __importDefault(require("try-resolve"));
|
|
25
|
+
const node_url_1 = require("node:url");
|
|
26
|
+
// import() can not load Window file path
|
|
27
|
+
// convert file path to file URL before import()
|
|
28
|
+
// https://github.com/nodejs/node/issues/31710
|
|
29
|
+
function dynamicImport(targetPath) {
|
|
30
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
31
|
+
const fileUrl = (0, node_url_1.pathToFileURL)(targetPath).href;
|
|
32
|
+
return import(fileUrl);
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
exports.dynamicImport = dynamicImport;
|
|
36
|
+
const debug = (0, debug_1.default)("textlint:textfix-formatter");
|
|
37
|
+
function loadFormatter(formatterConfig) {
|
|
38
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
39
|
+
const formatterName = formatterConfig.formatterName;
|
|
40
|
+
debug(`formatterName: ${formatterName}`);
|
|
41
|
+
let formatter;
|
|
42
|
+
let formatterPath;
|
|
43
|
+
if (fs_1.default.existsSync(formatterName)) {
|
|
44
|
+
formatterPath = formatterName;
|
|
45
|
+
}
|
|
46
|
+
else if (fs_1.default.existsSync(path_1.default.resolve(process.cwd(), formatterName))) {
|
|
47
|
+
formatterPath = path_1.default.resolve(process.cwd(), formatterName);
|
|
48
|
+
}
|
|
49
|
+
else {
|
|
50
|
+
if ((0, is_file_1.default)(`${path_1.default.join(__dirname, "formatters/", formatterName)}.js`)) {
|
|
51
|
+
formatterPath = `${path_1.default.join(__dirname, "formatters/", formatterName)}.js`;
|
|
52
|
+
}
|
|
53
|
+
else if ((0, is_file_1.default)(`${path_1.default.join(__dirname, "formatters/", formatterName)}.ts`)) {
|
|
54
|
+
formatterPath = `${path_1.default.join(__dirname, "formatters/", formatterName)}.ts`;
|
|
55
|
+
}
|
|
56
|
+
else {
|
|
57
|
+
const pkgPath = (0, try_resolve_1.default)(`textlint-formatter-${formatterName}`) || (0, try_resolve_1.default)(formatterName);
|
|
58
|
+
if (pkgPath) {
|
|
59
|
+
formatterPath = pkgPath;
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
try {
|
|
64
|
+
const moduleExports = (yield dynamicImport(formatterPath)).default;
|
|
65
|
+
formatter = (0, module_interop_1.moduleInterop)(moduleExports);
|
|
66
|
+
}
|
|
67
|
+
catch (ex) {
|
|
68
|
+
throw new Error(`Could not find formatter ${formatterName}
|
|
69
|
+
See https://github.com/textlint/textlint/issues/148
|
|
70
|
+
${ex}`);
|
|
71
|
+
}
|
|
72
|
+
debug(`use formatter: ${formatterPath}`);
|
|
73
|
+
return {
|
|
74
|
+
format(results) {
|
|
75
|
+
return formatter(results, formatterConfig);
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
exports.loadFormatter = loadFormatter;
|
|
81
|
+
/**
|
|
82
|
+
* @deprecated use loadFormatter
|
|
83
|
+
* @param formatterConfig
|
|
84
|
+
*/
|
|
14
85
|
function createFormatter(formatterConfig) {
|
|
15
86
|
const formatterName = formatterConfig.formatterName;
|
|
16
87
|
debug(`formatterName: ${formatterName}`);
|
|
@@ -23,14 +94,14 @@ function createFormatter(formatterConfig) {
|
|
|
23
94
|
formatterPath = path_1.default.resolve(process.cwd(), formatterName);
|
|
24
95
|
}
|
|
25
96
|
else {
|
|
26
|
-
if (
|
|
97
|
+
if ((0, is_file_1.default)(`${path_1.default.join(__dirname, "formatters/", formatterName)}.js`)) {
|
|
27
98
|
formatterPath = `${path_1.default.join(__dirname, "formatters/", formatterName)}.js`;
|
|
28
99
|
}
|
|
29
|
-
else if (
|
|
100
|
+
else if ((0, is_file_1.default)(`${path_1.default.join(__dirname, "formatters/", formatterName)}.ts`)) {
|
|
30
101
|
formatterPath = `${path_1.default.join(__dirname, "formatters/", formatterName)}.ts`;
|
|
31
102
|
}
|
|
32
103
|
else {
|
|
33
|
-
const pkgPath =
|
|
104
|
+
const pkgPath = (0, try_resolve_1.default)(`textlint-formatter-${formatterName}`) || (0, try_resolve_1.default)(formatterName);
|
|
34
105
|
if (pkgPath) {
|
|
35
106
|
formatterPath = pkgPath;
|
|
36
107
|
}
|
package/lib/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC;;;;;;;;;;;;;;;AAEb,6DAAyD;AACzD,4CAAoB;AACpB,gDAAwB;AACxB,kDAA2B;AAC3B,mBAAmB;AACnB,sDAA6B;AAC7B,mBAAmB;AACnB,8DAAqC;AACrC,uCAAyC;AAEzC,yCAAyC;AACzC,gDAAgD;AAChD,8CAA8C;AAC9C,SAAsB,aAAa,CAAC,UAAkB;;QAClD,MAAM,OAAO,GAAG,IAAA,wBAAa,EAAC,UAAU,CAAC,CAAC,IAAI,CAAC;QAC/C,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;CAAA;AAHD,sCAGC;AAED,MAAM,KAAK,GAAG,IAAA,eAAM,EAAC,4BAA4B,CAAC,CAAC;AAInD,SAAsB,aAAa,CAAC,eAAgC;;QAChE,MAAM,aAAa,GAAG,eAAe,CAAC,aAAa,CAAC;QACpD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;QACzC,IAAI,SAAqF,CAAC;QAC1F,IAAI,aAAa,CAAC;QAClB,IAAI,YAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;YAC9B,aAAa,GAAG,aAAa,CAAC;SACjC;aAAM,IAAI,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC,EAAE;YAClE,aAAa,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;SAC9D;aAAM;YACH,IAAI,IAAA,iBAAM,EAAC,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;gBACpE,aAAa,GAAG,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC;aAC9E;iBAAM,IAAI,IAAA,iBAAM,EAAC,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;gBAC3E,aAAa,GAAG,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC;aAC9E;iBAAM;gBACH,MAAM,OAAO,GAAG,IAAA,qBAAU,EAAC,sBAAsB,aAAa,EAAE,CAAC,IAAI,IAAA,qBAAU,EAAC,aAAa,CAAC,CAAC;gBAC/F,IAAI,OAAO,EAAE;oBACT,aAAa,GAAG,OAAO,CAAC;iBAC3B;aACJ;SACJ;QACD,IAAI;YACA,MAAM,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;YACnE,SAAS,GAAG,IAAA,8BAAa,EAAC,aAAa,CAAC,CAAC;SAC5C;QAAC,OAAO,EAAE,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,4BAA4B,aAAa;;EAE/D,EAAE,EAAE,CAAC,CAAC;SACH;QACD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;QACzC,OAAO;YACH,MAAM,CAAC,OAA4B;gBAC/B,OAAO,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAC/C,CAAC;SACJ,CAAC;IACN,CAAC;CAAA;AAnCD,sCAmCC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAAC,eAAgC;IAC5D,MAAM,aAAa,GAAG,eAAe,CAAC,aAAa,CAAC;IACpD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;IACzC,IAAI,SAAqF,CAAC;IAC1F,IAAI,aAAa,CAAC;IAClB,IAAI,YAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;QAC9B,aAAa,GAAG,aAAa,CAAC;KACjC;SAAM,IAAI,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC,EAAE;QAClE,aAAa,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;KAC9D;SAAM;QACH,IAAI,IAAA,iBAAM,EAAC,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;YACpE,aAAa,GAAG,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC;SAC9E;aAAM,IAAI,IAAA,iBAAM,EAAC,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;YAC3E,aAAa,GAAG,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC;SAC9E;aAAM;YACH,MAAM,OAAO,GAAG,IAAA,qBAAU,EAAC,sBAAsB,aAAa,EAAE,CAAC,IAAI,IAAA,qBAAU,EAAC,aAAa,CAAC,CAAC;YAC/F,IAAI,OAAO,EAAE;gBACT,aAAa,GAAG,OAAO,CAAC;aAC3B;SACJ;KACJ;IACD,IAAI;QACA,SAAS,GAAG,IAAA,8BAAa,EAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;KACrD;IAAC,OAAO,EAAE,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,4BAA4B,aAAa;;EAE/D,EAAE,EAAE,CAAC,CAAC;KACH;IACD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;IACzC,OAAO,UAAU,OAA4B;QACzC,OAAO,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC/C,CAAC,CAAC;AACN,CAAC;AAhCD,0CAgCC;AAMD,SAAgB,qBAAqB;IACjC,OAAO,YAAE;SACJ,WAAW,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;SAC/C,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE;QACrB,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,OAAO,QAAQ,KAAK,KAAK,IAAI,QAAQ,KAAK,KAAK,CAAC;IACpD,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;QAClB,OAAO,EAAE,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;IAC7D,CAAC,CAAC,CAAC;AACX,CAAC;AAVD,sDAUC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"compats.d.ts","sourceRoot":"","sources":["../../../src/formatters/compats.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AASzD,wBAAgB,MAAM,CAAC,OAAO,EAAE,iBAAiB,EAAE,UAyBlD"}
|
|
@@ -0,0 +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;AAoCzD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE,GAAG,OAqGlE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../../src/formatters/json.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,iBAAiB,EAAE,UAEpD"}
|
|
@@ -0,0 +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;AAiBzD,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE,GAAG,OAwFlE"}
|
package/module/src/index.d.ts
CHANGED
|
@@ -1,10 +1,19 @@
|
|
|
1
1
|
import type { TextlintFixResult } from "@textlint/types";
|
|
2
|
-
export declare
|
|
2
|
+
export declare function dynamicImport(targetPath: string): Promise<any>;
|
|
3
|
+
export type FormatterConfig = {
|
|
3
4
|
color?: boolean;
|
|
4
5
|
formatterName: string;
|
|
5
6
|
};
|
|
7
|
+
export declare function loadFormatter(formatterConfig: FormatterConfig): Promise<{
|
|
8
|
+
format(results: TextlintFixResult[]): string;
|
|
9
|
+
}>;
|
|
10
|
+
/**
|
|
11
|
+
* @deprecated use loadFormatter
|
|
12
|
+
* @param formatterConfig
|
|
13
|
+
*/
|
|
6
14
|
export declare function createFormatter(formatterConfig: FormatterConfig): (results: TextlintFixResult[]) => string;
|
|
7
15
|
export interface FixerFormatterDetail {
|
|
8
16
|
name: string;
|
|
9
17
|
}
|
|
10
18
|
export declare function getFixerFormatterList(): FixerFormatterDetail[];
|
|
19
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAczD,wBAAsB,aAAa,CAAC,UAAU,EAAE,MAAM,gBAGrD;AAID,MAAM,MAAM,eAAe,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE,wBAAsB,aAAa,CAAC,eAAe,EAAE,eAAe;oBA+B5C,iBAAiB,EAAE;GAI1C;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,eAAe,EAAE,eAAe,aA6BlC,iBAAiB,EAAE,YAGhD;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,qBAAqB,IAAI,oBAAoB,EAAE,CAU9D"}
|
package/module/src/index.js
CHANGED
|
@@ -1,11 +1,80 @@
|
|
|
1
1
|
// LICENSE : MIT
|
|
2
2
|
"use strict";
|
|
3
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
4
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
5
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
6
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
7
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
8
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
9
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
10
|
+
});
|
|
11
|
+
};
|
|
3
12
|
import { moduleInterop } from "@textlint/module-interop";
|
|
4
13
|
import fs from "fs";
|
|
5
14
|
import path from "path";
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
15
|
+
import debug0 from "debug";
|
|
16
|
+
// @ts-expect-error
|
|
17
|
+
import isFile from "is-file";
|
|
18
|
+
// @ts-expect-error
|
|
19
|
+
import tryResolve from "try-resolve";
|
|
20
|
+
import { pathToFileURL } from "node:url";
|
|
21
|
+
// import() can not load Window file path
|
|
22
|
+
// convert file path to file URL before import()
|
|
23
|
+
// https://github.com/nodejs/node/issues/31710
|
|
24
|
+
export function dynamicImport(targetPath) {
|
|
25
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
26
|
+
const fileUrl = pathToFileURL(targetPath).href;
|
|
27
|
+
return import(fileUrl);
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
const debug = debug0("textlint:textfix-formatter");
|
|
31
|
+
export function loadFormatter(formatterConfig) {
|
|
32
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
33
|
+
const formatterName = formatterConfig.formatterName;
|
|
34
|
+
debug(`formatterName: ${formatterName}`);
|
|
35
|
+
let formatter;
|
|
36
|
+
let formatterPath;
|
|
37
|
+
if (fs.existsSync(formatterName)) {
|
|
38
|
+
formatterPath = formatterName;
|
|
39
|
+
}
|
|
40
|
+
else if (fs.existsSync(path.resolve(process.cwd(), formatterName))) {
|
|
41
|
+
formatterPath = path.resolve(process.cwd(), formatterName);
|
|
42
|
+
}
|
|
43
|
+
else {
|
|
44
|
+
if (isFile(`${path.join(__dirname, "formatters/", formatterName)}.js`)) {
|
|
45
|
+
formatterPath = `${path.join(__dirname, "formatters/", formatterName)}.js`;
|
|
46
|
+
}
|
|
47
|
+
else if (isFile(`${path.join(__dirname, "formatters/", formatterName)}.ts`)) {
|
|
48
|
+
formatterPath = `${path.join(__dirname, "formatters/", formatterName)}.ts`;
|
|
49
|
+
}
|
|
50
|
+
else {
|
|
51
|
+
const pkgPath = tryResolve(`textlint-formatter-${formatterName}`) || tryResolve(formatterName);
|
|
52
|
+
if (pkgPath) {
|
|
53
|
+
formatterPath = pkgPath;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
try {
|
|
58
|
+
const moduleExports = (yield dynamicImport(formatterPath)).default;
|
|
59
|
+
formatter = moduleInterop(moduleExports);
|
|
60
|
+
}
|
|
61
|
+
catch (ex) {
|
|
62
|
+
throw new Error(`Could not find formatter ${formatterName}
|
|
63
|
+
See https://github.com/textlint/textlint/issues/148
|
|
64
|
+
${ex}`);
|
|
65
|
+
}
|
|
66
|
+
debug(`use formatter: ${formatterPath}`);
|
|
67
|
+
return {
|
|
68
|
+
format(results) {
|
|
69
|
+
return formatter(results, formatterConfig);
|
|
70
|
+
}
|
|
71
|
+
};
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @deprecated use loadFormatter
|
|
76
|
+
* @param formatterConfig
|
|
77
|
+
*/
|
|
9
78
|
export function createFormatter(formatterConfig) {
|
|
10
79
|
const formatterName = formatterConfig.formatterName;
|
|
11
80
|
debug(`formatterName: ${formatterName}`);
|
package/module/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC;;;;;;;;;;AAEb,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,MAAM,MAAM,OAAO,CAAC;AAC3B,mBAAmB;AACnB,OAAO,MAAM,MAAM,SAAS,CAAC;AAC7B,mBAAmB;AACnB,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,yCAAyC;AACzC,gDAAgD;AAChD,8CAA8C;AAC9C,MAAM,UAAgB,aAAa,CAAC,UAAkB;;QAClD,MAAM,OAAO,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC;QAC/C,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;CAAA;AAED,MAAM,KAAK,GAAG,MAAM,CAAC,4BAA4B,CAAC,CAAC;AAInD,MAAM,UAAgB,aAAa,CAAC,eAAgC;;QAChE,MAAM,aAAa,GAAG,eAAe,CAAC,aAAa,CAAC;QACpD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;QACzC,IAAI,SAAqF,CAAC;QAC1F,IAAI,aAAa,CAAC;QAClB,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;YAC9B,aAAa,GAAG,aAAa,CAAC;SACjC;aAAM,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC,EAAE;YAClE,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;SAC9D;aAAM;YACH,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;gBACpE,aAAa,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC;aAC9E;iBAAM,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;gBAC3E,aAAa,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC;aAC9E;iBAAM;gBACH,MAAM,OAAO,GAAG,UAAU,CAAC,sBAAsB,aAAa,EAAE,CAAC,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC;gBAC/F,IAAI,OAAO,EAAE;oBACT,aAAa,GAAG,OAAO,CAAC;iBAC3B;aACJ;SACJ;QACD,IAAI;YACA,MAAM,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;YACnE,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;SAC5C;QAAC,OAAO,EAAE,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,4BAA4B,aAAa;;EAE/D,EAAE,EAAE,CAAC,CAAC;SACH;QACD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;QACzC,OAAO;YACH,MAAM,CAAC,OAA4B;gBAC/B,OAAO,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YAC/C,CAAC;SACJ,CAAC;IACN,CAAC;CAAA;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,eAAgC;IAC5D,MAAM,aAAa,GAAG,eAAe,CAAC,aAAa,CAAC;IACpD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;IACzC,IAAI,SAAqF,CAAC;IAC1F,IAAI,aAAa,CAAC;IAClB,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;QAC9B,aAAa,GAAG,aAAa,CAAC;KACjC;SAAM,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC,EAAE;QAClE,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;KAC9D;SAAM;QACH,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;YACpE,aAAa,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC;SAC9E;aAAM,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;YAC3E,aAAa,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC;SAC9E;aAAM;YACH,MAAM,OAAO,GAAG,UAAU,CAAC,sBAAsB,aAAa,EAAE,CAAC,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC;YAC/F,IAAI,OAAO,EAAE;gBACT,aAAa,GAAG,OAAO,CAAC;aAC3B;SACJ;KACJ;IACD,IAAI;QACA,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;KACrD;IAAC,OAAO,EAAE,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,4BAA4B,aAAa;;EAE/D,EAAE,EAAE,CAAC,CAAC;KACH;IACD,KAAK,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;IACzC,OAAO,UAAU,OAA4B;QACzC,OAAO,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC/C,CAAC,CAAC;AACN,CAAC;AAMD,MAAM,UAAU,qBAAqB;IACjC,OAAO,EAAE;SACJ,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;SAC/C,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,OAAO,QAAQ,KAAK,KAAK,IAAI,QAAQ,KAAK,KAAK,CAAC;IACpD,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;QAClB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;IAC7D,CAAC,CAAC,CAAC;AACX,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,65 +1,65 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
2
|
+
"name": "@textlint/fixer-formatter",
|
|
3
|
+
"version": "12.3.1",
|
|
4
|
+
"description": "textlint output formatter for fixer",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"AST",
|
|
7
|
+
"lint",
|
|
8
|
+
"linting",
|
|
9
|
+
"markdown",
|
|
10
|
+
"plugable",
|
|
11
|
+
"text",
|
|
12
|
+
"textlint"
|
|
13
|
+
],
|
|
14
|
+
"homepage": "https://github.com/textlint/textlint#readme",
|
|
15
|
+
"bugs": {
|
|
16
|
+
"url": "https://github.com/textlint/textlint/issues"
|
|
17
|
+
},
|
|
18
|
+
"repository": {
|
|
19
|
+
"type": "git",
|
|
20
|
+
"url": "git+https://github.com/textlint/textlint.git"
|
|
21
|
+
},
|
|
22
|
+
"license": "MIT",
|
|
23
|
+
"author": "azu",
|
|
24
|
+
"main": "lib/src/index.js",
|
|
25
|
+
"types": "lib/src/index.d.ts",
|
|
26
|
+
"files": [
|
|
27
|
+
"bin/",
|
|
28
|
+
"lib/",
|
|
29
|
+
"module/",
|
|
30
|
+
"src/",
|
|
31
|
+
"!*.tsbuildinfo"
|
|
32
|
+
],
|
|
33
|
+
"scripts": {
|
|
34
|
+
"build": "tsc -b && tsc -b tsconfig.module.json",
|
|
35
|
+
"clean": "rimraf lib/ module/",
|
|
36
|
+
"prepack": "npm run build",
|
|
37
|
+
"test": "mocha \"test/**/*-test.{js,ts}\""
|
|
38
|
+
},
|
|
39
|
+
"dependencies": {
|
|
40
|
+
"@textlint/module-interop": "^12.3.0",
|
|
41
|
+
"@textlint/types": "^12.3.0",
|
|
42
|
+
"chalk": "^4.1.2",
|
|
43
|
+
"debug": "^4.3.4",
|
|
44
|
+
"diff": "^4.0.2",
|
|
45
|
+
"is-file": "^1.0.0",
|
|
46
|
+
"string-width": "^4.2.3",
|
|
47
|
+
"strip-ansi": "^6.0.1",
|
|
48
|
+
"text-table": "^0.2.0",
|
|
49
|
+
"try-resolve": "^1.0.1"
|
|
50
|
+
},
|
|
51
|
+
"devDependencies": {
|
|
52
|
+
"@types/mocha": "^9.1.1",
|
|
53
|
+
"@types/node": "^18.11.17",
|
|
54
|
+
"cross-env": "^7.0.3",
|
|
55
|
+
"mocha": "^10.2.0",
|
|
56
|
+
"rimraf": "^3.0.2",
|
|
57
|
+
"ts-node": "^10.9.1",
|
|
58
|
+
"ts-node-test-register": "^10.0.0",
|
|
59
|
+
"typescript": "~4.9.4"
|
|
60
|
+
},
|
|
61
|
+
"publishConfig": {
|
|
62
|
+
"access": "public"
|
|
63
|
+
},
|
|
64
|
+
"gitHead": "c4ac8c4a307f40aec96a088394e43b61f930d642"
|
|
65
65
|
}
|
package/src/index.ts
CHANGED
|
@@ -4,12 +4,66 @@ import type { TextlintFixResult } from "@textlint/types";
|
|
|
4
4
|
import { moduleInterop } from "@textlint/module-interop";
|
|
5
5
|
import fs from "fs";
|
|
6
6
|
import path from "path";
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
import debug0 from "debug";
|
|
8
|
+
// @ts-expect-error
|
|
9
|
+
import isFile from "is-file";
|
|
10
|
+
// @ts-expect-error
|
|
11
|
+
import tryResolve from "try-resolve";
|
|
12
|
+
import { pathToFileURL } from "node:url";
|
|
13
|
+
|
|
14
|
+
// import() can not load Window file path
|
|
15
|
+
// convert file path to file URL before import()
|
|
16
|
+
// https://github.com/nodejs/node/issues/31710
|
|
17
|
+
export async function dynamicImport(targetPath: string) {
|
|
18
|
+
const fileUrl = pathToFileURL(targetPath).href;
|
|
19
|
+
return import(fileUrl);
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
const debug = debug0("textlint:textfix-formatter");
|
|
10
23
|
|
|
11
24
|
export type FormatterConfig = { color?: boolean; formatterName: string };
|
|
12
25
|
|
|
26
|
+
export async function loadFormatter(formatterConfig: FormatterConfig) {
|
|
27
|
+
const formatterName = formatterConfig.formatterName;
|
|
28
|
+
debug(`formatterName: ${formatterName}`);
|
|
29
|
+
let formatter: (results: TextlintFixResult[], formatterConfig: FormatterConfig) => string;
|
|
30
|
+
let formatterPath;
|
|
31
|
+
if (fs.existsSync(formatterName)) {
|
|
32
|
+
formatterPath = formatterName;
|
|
33
|
+
} else if (fs.existsSync(path.resolve(process.cwd(), formatterName))) {
|
|
34
|
+
formatterPath = path.resolve(process.cwd(), formatterName);
|
|
35
|
+
} else {
|
|
36
|
+
if (isFile(`${path.join(__dirname, "formatters/", formatterName)}.js`)) {
|
|
37
|
+
formatterPath = `${path.join(__dirname, "formatters/", formatterName)}.js`;
|
|
38
|
+
} else if (isFile(`${path.join(__dirname, "formatters/", formatterName)}.ts`)) {
|
|
39
|
+
formatterPath = `${path.join(__dirname, "formatters/", formatterName)}.ts`;
|
|
40
|
+
} else {
|
|
41
|
+
const pkgPath = tryResolve(`textlint-formatter-${formatterName}`) || tryResolve(formatterName);
|
|
42
|
+
if (pkgPath) {
|
|
43
|
+
formatterPath = pkgPath;
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
try {
|
|
48
|
+
const moduleExports = (await dynamicImport(formatterPath)).default;
|
|
49
|
+
formatter = moduleInterop(moduleExports);
|
|
50
|
+
} catch (ex) {
|
|
51
|
+
throw new Error(`Could not find formatter ${formatterName}
|
|
52
|
+
See https://github.com/textlint/textlint/issues/148
|
|
53
|
+
${ex}`);
|
|
54
|
+
}
|
|
55
|
+
debug(`use formatter: ${formatterPath}`);
|
|
56
|
+
return {
|
|
57
|
+
format(results: TextlintFixResult[]) {
|
|
58
|
+
return formatter(results, formatterConfig);
|
|
59
|
+
}
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* @deprecated use loadFormatter
|
|
65
|
+
* @param formatterConfig
|
|
66
|
+
*/
|
|
13
67
|
export function createFormatter(formatterConfig: FormatterConfig) {
|
|
14
68
|
const formatterName = formatterConfig.formatterName;
|
|
15
69
|
debug(`formatterName: ${formatterName}`);
|