@textlint/fixer-formatter 15.6.1 → 15.7.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/README.md CHANGED
@@ -10,6 +10,16 @@ textlint output formatter for fixer
10
10
 
11
11
  - [ ] TBD
12
12
 
13
+ ## Writing a formatter
14
+
15
+ A fixer formatter receives `TextlintFixResult[]` and returns a single `string`. The returned string is written **as-is** to stdout or `--output-file` — the CLI does not append a trailing newline. Each formatter is responsible for its own trailing newline.
16
+
17
+ By convention, every built-in fixer formatter (`stylish`, `compats`, `diff`, `json`) ends its non-empty output with `\n`, so that stdout produces a clean terminal break and `--output-file` produces a well-formed text file.
18
+
19
+ The one exception is **`fixed-result`**, which returns the fixed source as-is. Its trailing newline depends on the original input — the formatter preserves byte exactness so that piping `--fix --format fixed-result` to a file produces output identical to the source when no fix was needed.
20
+
21
+ See [textlint/textlint#2043](https://github.com/textlint/textlint/issues/2043) for the original discussion.
22
+
13
23
  ## Tests
14
24
 
15
25
  npm test
@@ -28,7 +28,7 @@ function default_1(results) {
28
28
  });
29
29
  });
30
30
  if (total > 0) {
31
- output += `\n\nFixed ${total} problem${total !== 1 ? "s" : ""}`;
31
+ output += `\n\nFixed ${total} problem${total !== 1 ? "s" : ""}\n`;
32
32
  }
33
33
  return output;
34
34
  }
@@ -1 +1 @@
1
- {"version":3,"file":"compats.js","sourceRoot":"","sources":["../../../src/formatters/compats.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC;;AAUb,4BAyBC;AAjCD,SAAS,cAAc,CAAC,OAA4E;IAChG,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QAC1C,OAAO,OAAO,CAAC;IACnB,CAAC;SAAM,CAAC;QACJ,OAAO,SAAS,CAAC;IACrB,CAAC;AACL,CAAC;AAED,mBAAyB,OAA4B;IACjD,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACvB,MAAM,QAAQ,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACzC,KAAK,IAAI,QAAQ,CAAC,MAAM,CAAC;QAEzB,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACzB,MAAM,IAAI,SAAS,CAAC;YACpB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,IAAI,CAAC;YACjC,MAAM,IAAI,QAAQ,OAAO,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,SAAS,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,IAAI,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACZ,MAAM,IAAI,aAAa,KAAK,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACpE,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC"}
1
+ {"version":3,"file":"compats.js","sourceRoot":"","sources":["../../../src/formatters/compats.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC;;AAUb,4BAyBC;AAjCD,SAAS,cAAc,CAAC,OAA4E;IAChG,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QAC1C,OAAO,OAAO,CAAC;IACnB,CAAC;SAAM,CAAC;QACJ,OAAO,SAAS,CAAC;IACrB,CAAC;AACL,CAAC;AAED,mBAAyB,OAA4B;IACjD,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACvB,MAAM,QAAQ,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACzC,KAAK,IAAI,QAAQ,CAAC,MAAM,CAAC;QAEzB,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACzB,MAAM,IAAI,SAAS,CAAC;YACpB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,IAAI,CAAC;YACjC,MAAM,IAAI,QAAQ,OAAO,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,SAAS,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,IAAI,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACZ,MAAM,IAAI,aAAa,KAAK,WAAW,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IACtE,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC"}
@@ -3,6 +3,6 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.default = default_1;
5
5
  function default_1(results) {
6
- return JSON.stringify(results);
6
+ return `${JSON.stringify(results)}\n`;
7
7
  }
8
8
  //# sourceMappingURL=json.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"json.js","sourceRoot":"","sources":["../../../src/formatters/json.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC;;AAEb,4BAEC;AAFD,mBAAyB,OAA4B;IACjD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC"}
1
+ {"version":3,"file":"json.js","sourceRoot":"","sources":["../../../src/formatters/json.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,YAAY,CAAC;;AAEb,4BAEC;AAFD,mBAAyB,OAA4B;IACjD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;AAC1C,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@textlint/fixer-formatter",
3
- "version": "15.6.1",
3
+ "version": "15.7.1",
4
4
  "description": "textlint output formatter for fixer",
5
5
  "keywords": [
6
6
  "AST",
@@ -39,9 +39,9 @@
39
39
  "test:watch": "vitest watch"
40
40
  },
41
41
  "dependencies": {
42
- "@textlint/module-interop": "15.6.1",
43
- "@textlint/resolver": "15.6.1",
44
- "@textlint/types": "15.6.1",
42
+ "@textlint/module-interop": "15.7.1",
43
+ "@textlint/resolver": "15.7.1",
44
+ "@textlint/types": "15.7.1",
45
45
  "chalk": "^4.1.2",
46
46
  "debug": "^4.4.3",
47
47
  "diff": "^8.0.4",
@@ -51,7 +51,7 @@
51
51
  },
52
52
  "devDependencies": {
53
53
  "@types/debug": "^4.1.13",
54
- "@types/node": "^24.12.3",
54
+ "@types/node": "^24.12.4",
55
55
  "rimraf": "^6.1.3",
56
56
  "typescript": "~5.8.3",
57
57
  "vitest": "^3.2.4"
@@ -59,5 +59,5 @@
59
59
  "publishConfig": {
60
60
  "access": "public"
61
61
  },
62
- "gitHead": "b791eee730a39a074487f98ddcf01f5f2a055bda"
62
+ "gitHead": "91ffc5947325f0a9d0500b889550a1b4d232f5f1"
63
63
  }
@@ -30,7 +30,7 @@ export default function (results: TextlintFixResult[]) {
30
30
  });
31
31
 
32
32
  if (total > 0) {
33
- output += `\n\nFixed ${total} problem${total !== 1 ? "s" : ""}`;
33
+ output += `\n\nFixed ${total} problem${total !== 1 ? "s" : ""}\n`;
34
34
  }
35
35
 
36
36
  return output;
@@ -2,5 +2,5 @@
2
2
  "use strict";
3
3
  import type { TextlintFixResult } from "@textlint/types";
4
4
  export default function (results: TextlintFixResult[]) {
5
- return JSON.stringify(results);
5
+ return `${JSON.stringify(results)}\n`;
6
6
  }