Merge pull request #474 from 0x6b/textlint-formatter-to-@textlint

refactor(textlint-formatter): move to @textlint/linter-formatter
textlint · Jan 17, 2018 · ea23a73 · ea23a73
2 parents b769c1b + 9f54a5a
commit ea23a73
Show file tree

Hide file tree

Showing 42 changed files with 23 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Visit [https://textlint.github.io/](https://textlint.github.io/) to see textlint
     - `npm install textlint-rule-xxx`.
     - See [collection of textlint rules](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule "Collection of textlint rule · textlint/textlint Wiki")
 - [Markdown](https://github.com/textlint/textlint-plugin-markdown) and [plain text](https://github.com/textlint/textlint-plugin-text) are supported by default. Support is available for [HTML](https://github.com/textlint/textlint-plugin-html) and [other file formats](https://github.com/textlint/textlint#supported-file-formats) via plugins.
-- Supports the use of custom formatters and formatter bundles [formatter(reporter)](./packages/textlint-formatter)
+- Supports the use of custom formatters and formatter bundles [formatter(reporter)](./packages/@textlint/linter-formatter)
 
 ## Quick Tour
 
@@ -315,7 +315,7 @@ e.g. use `pretty-error` formatter:
 $ textlint -f pretty-error file.md
 ```
 
-More details in [textlint-formatter](./packages/textlint-formatter "textlint-formatter").
+More details in [@textlint/linter-formatter](./packages/@textlint/linter-formatter "@textlint/linter-formatter").
 
 ## Use as node module
 
@@ -472,7 +472,7 @@ These modules are parts of textlint.
 | :--------------------------------------- | :--------------------------------------- | :--------------------------------------- |
 | [`textlint`](./packages/textlint)        | [![npm](https://img.shields.io/npm/v/textlint.svg?style=flat-square)](https://www.npmjs.com/package/textlint) | textlint command line tool itself        |
 | [`@textlint/kernel`](./packages/@textlint/kernel) | [![npm](https://img.shields.io/npm/v/@textlint/kernel.svg?style=flat-square)](https://www.npmjs.com/package/@textlint/kernel) | textlint main logic module. It is universal JavaScript. |
-| [`textlint-formatter`](./packages/textlint-formatter) | [![npm](https://img.shields.io/npm/v/textlint-formatter.svg?style=flat-square)](https://www.npmjs.com/package/textlint-formatter) | textlint output formatter                |
+| [`@textlint/linter-formatter`](./packages/@textlint/linter-formatter) | [![npm](https://img.shields.io/npm/v/@textlint/linter-formatter.svg?style=flat-square)](https://www.npmjs.com/package/@textlint/linter-formatter) | textlint output formatter                |
 | [`textlint-fixer-formatter`](./packages/textlint-fixer-formatter) | [![npm](https://img.shields.io/npm/v/textlint-fixer-formatter.svg?style=flat-square)](https://www.npmjs.com/package/textlint-fixer-formatter) | textlint output formatter for fixer      |
 | [`textlint-plugin-markdown`](./packages/textlint-plugin-markdown) | [![npm](https://img.shields.io/npm/v/textlint-plugin-markdown.svg?style=flat-square)](https://www.npmjs.com/package/textlint-plugin-markdown) | markdown support for textlint            |
 | [`textlint-plugin-text`](./packages/textlint-plugin-text) | [![npm](https://img.shields.io/npm/v/textlint-plugin-text.svg?style=flat-square)](https://www.npmjs.com/package/textlint-plugin-text) | plain text support for textlint          |

diff --git a/docs/formatter.md b/docs/formatter.md
@@ -162,9 +162,9 @@ You can read the source code from `filePath` property.
 
 ## Built-in formatter
 
-textlint use `textlint-formatter` module as built-in formatter.
+textlint use `@textlint/linter-formatter` module as built-in formatter.
 
-- [textlint-formatter](../packages/textlint-formatter/README.md "textlint-formatter")
+- [@textlint/linter-formatter](../packages/@textlint/linter-formatter/README.md "@textlint/linter-formatter")
 
 ## Custom Formatter
 

diff --git a/packages/textlint-formatter/.travis.yml → ...es/@textlint/linter-formatter/.travis.yml b/packages/textlint-formatter/.travis.yml → ...es/@textlint/linter-formatter/.travis.yml
diff --git a/packages/textlint-formatter/CHANGELOG.md → ...s/@textlint/linter-formatter/CHANGELOG.md b/packages/textlint-formatter/CHANGELOG.md → ...s/@textlint/linter-formatter/CHANGELOG.md
diff --git a/packages/textlint-formatter/LICENSE → packages/@textlint/linter-formatter/LICENSE b/packages/textlint-formatter/LICENSE → packages/@textlint/linter-formatter/LICENSE
diff --git a/packages/textlint-formatter/README.md → ...ages/@textlint/linter-formatter/README.md b/packages/textlint-formatter/README.md → ...ages/@textlint/linter-formatter/README.md
@@ -1,11 +1,11 @@
-# textlint-formatter
+# @textlint/linter-formatter
 
 [textlint](https://github.com/textlint/textlint "textlint/textlint") output formatter.
 
 ## Installation
 
 ```
-npm install textlint-formatter
+npm install @textlint/linter-formatter
 ```
 
 ## Usage
@@ -15,7 +15,7 @@ See [formatters/](src/formatters).
 Currently, you can use "stylish" (defaults), "checkstyle", "compact", "jslint-xml", "json", "junit", "pretty-error", "table", "tap", and "unix".
 
 ```js
-const createFormatter = require("textlint-formatter").createFormatter;
+const createFormatter = require("@textlint/linter-formatter").createFormatter;
 const formatter = createFormatter({
     formatterName: "stylish"
 });

diff --git a/packages/textlint-formatter/bin/cmd.js → ...ges/@textlint/linter-formatter/bin/cmd.js b/packages/textlint-formatter/bin/cmd.js → ...ges/@textlint/linter-formatter/bin/cmd.js
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 var concat = require("concat-stream");
 var fs = require("fs");
-var run = require("../lib/textlint-formatter/src/cli");
+var run = require("../lib/linter-formatter/src/cli");
 var useStdIn = process.argv.indexOf("--stdin") > -1;
 if (useStdIn) {
     process.stdin.pipe(

diff --git a/packages/textlint-formatter/package.json → ...s/@textlint/linter-formatter/package.json b/packages/textlint-formatter/package.json → ...s/@textlint/linter-formatter/package.json
@@ -1,14 +1,14 @@
 {
-  "name": "textlint-formatter",
+  "name": "@textlint/linter-formatter",
   "description": "textlint output formatter",
   "version": "3.0.2",
-  "homepage": "https://github.com/textlint/textlint/tree/master/packages/textlint-formatter",
+  "homepage": "https://github.com/textlint/textlint/tree/master/packages/@textlint/linter-formatter",
   "repository": {
     "type": "git",
     "url": "https://github.com/textlint/textlint.git"
   },
-  "main": "lib/textlint-formatter/src/index.js",
-  "types": "lib/textlint-formatter/src/index.d.ts",
+  "main": "lib/linter-formatter/src/index.js",
+  "types": "lib/linter-formatter/src/index.d.ts",
   "bin": {
     "textlint-formatter": "bin/cmd.js"
   },
@@ -30,6 +30,9 @@
   "bugs": {
     "url": "https://github.com/textlint/textlint/issues"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
     "@azu/format-text": "^1.0.1",
     "@azu/style-format": "^1.0.0",

diff --git a/packages/textlint-formatter/src/cli.ts → ...ges/@textlint/linter-formatter/src/cli.ts b/packages/textlint-formatter/src/cli.ts → ...ges/@textlint/linter-formatter/src/cli.ts
diff --git a/...nt-formatter/src/formatters/checkstyle.ts → ...er-formatter/src/formatters/checkstyle.ts b/...nt-formatter/src/formatters/checkstyle.ts → ...er-formatter/src/formatters/checkstyle.ts
diff --git a/...tlint-formatter/src/formatters/compact.ts → ...inter-formatter/src/formatters/compact.ts b/...tlint-formatter/src/formatters/compact.ts → ...inter-formatter/src/formatters/compact.ts
diff --git a/...nt-formatter/src/formatters/jslint-xml.ts → ...er-formatter/src/formatters/jslint-xml.ts b/...nt-formatter/src/formatters/jslint-xml.ts → ...er-formatter/src/formatters/jslint-xml.ts
diff --git a/...textlint-formatter/src/formatters/json.ts → ...t/linter-formatter/src/formatters/json.ts b/...textlint-formatter/src/formatters/json.ts → ...t/linter-formatter/src/formatters/json.ts
diff --git a/...extlint-formatter/src/formatters/junit.ts → .../linter-formatter/src/formatters/junit.ts b/...extlint-formatter/src/formatters/junit.ts → .../linter-formatter/src/formatters/junit.ts
diff --git a/...-formatter/src/formatters/pretty-error.ts → ...-formatter/src/formatters/pretty-error.ts b/...-formatter/src/formatters/pretty-error.ts → ...-formatter/src/formatters/pretty-error.ts
diff --git a/...tlint-formatter/src/formatters/stylish.ts → ...inter-formatter/src/formatters/stylish.ts b/...tlint-formatter/src/formatters/stylish.ts → ...inter-formatter/src/formatters/stylish.ts
diff --git a/...extlint-formatter/src/formatters/table.ts → .../linter-formatter/src/formatters/table.ts b/...extlint-formatter/src/formatters/table.ts → .../linter-formatter/src/formatters/table.ts
diff --git a/.../textlint-formatter/src/formatters/tap.ts → ...nt/linter-formatter/src/formatters/tap.ts b/.../textlint-formatter/src/formatters/tap.ts → ...nt/linter-formatter/src/formatters/tap.ts
diff --git a/...textlint-formatter/src/formatters/unix.ts → ...t/linter-formatter/src/formatters/unix.ts b/...textlint-formatter/src/formatters/unix.ts → ...t/linter-formatter/src/formatters/unix.ts
diff --git a/packages/textlint-formatter/src/index.ts → ...s/@textlint/linter-formatter/src/index.ts b/packages/textlint-formatter/src/index.ts → ...s/@textlint/linter-formatter/src/index.ts
@@ -7,7 +7,7 @@ const path = require("path");
 const tryResolve = require("try-resolve");
 const interopRequire = require("interop-require");
 const isFile = require("is-file");
-const debug = require("debug")("textlint:textfix-formatter");
+const debug = require("debug")("textlint:@textlint/linter-formatter");
 
 export type FormatterConfig = { color?: boolean; formatterName: string };
 

diff --git a/...s/textlint-formatter/test/fixtures/bar.md → ...int/linter-formatter/test/fixtures/bar.md b/...s/textlint-formatter/test/fixtures/bar.md → ...int/linter-formatter/test/fixtures/bar.md
diff --git a/...s/textlint-formatter/test/fixtures/ckj.md → ...int/linter-formatter/test/fixtures/ckj.md b/...s/textlint-formatter/test/fixtures/ckj.md → ...int/linter-formatter/test/fixtures/ckj.md
diff --git a/...s/textlint-formatter/test/fixtures/foo.md → ...int/linter-formatter/test/fixtures/foo.md b/...s/textlint-formatter/test/fixtures/foo.md → ...int/linter-formatter/test/fixtures/foo.md
diff --git a/...extlint-formatter/test/fixtures/myfile.js → .../linter-formatter/test/fixtures/myfile.js b/...extlint-formatter/test/fixtures/myfile.js → .../linter-formatter/test/fixtures/myfile.js
diff --git a/...t-formatter/test/formatters/checkstyle.js → ...r-formatter/test/formatters/checkstyle.js b/...t-formatter/test/formatters/checkstyle.js → ...r-formatter/test/formatters/checkstyle.js
diff --git a/...lint-formatter/test/formatters/compact.js → ...nter-formatter/test/formatters/compact.js b/...lint-formatter/test/formatters/compact.js → ...nter-formatter/test/formatters/compact.js
diff --git a/...t-formatter/test/formatters/jslint-xml.js → ...r-formatter/test/formatters/jslint-xml.js b/...t-formatter/test/formatters/jslint-xml.js → ...r-formatter/test/formatters/jslint-xml.js
diff --git a/...extlint-formatter/test/formatters/json.js → .../linter-formatter/test/formatters/json.js b/...extlint-formatter/test/formatters/json.js → .../linter-formatter/test/formatters/json.js
diff --git a/...xtlint-formatter/test/formatters/junit.js → ...linter-formatter/test/formatters/junit.js b/...xtlint-formatter/test/formatters/junit.js → ...linter-formatter/test/formatters/junit.js
diff --git a/...tter/test/formatters/pretty-error-test.js → ...tter/test/formatters/pretty-error-test.js b/...tter/test/formatters/pretty-error-test.js → ...tter/test/formatters/pretty-error-test.js
diff --git a/...lint-formatter/test/formatters/stylish.js → ...nter-formatter/test/formatters/stylish.js b/...lint-formatter/test/formatters/stylish.js → ...nter-formatter/test/formatters/stylish.js
diff --git a/...xtlint-formatter/test/formatters/table.js → ...linter-formatter/test/formatters/table.js b/...xtlint-formatter/test/formatters/table.js → ...linter-formatter/test/formatters/table.js
diff --git a/...textlint-formatter/test/formatters/tap.js → ...t/linter-formatter/test/formatters/tap.js b/...textlint-formatter/test/formatters/tap.js → ...t/linter-formatter/test/formatters/tap.js
diff --git a/...extlint-formatter/test/formatters/unix.js → .../linter-formatter/test/formatters/unix.js b/...extlint-formatter/test/formatters/unix.js → .../linter-formatter/test/formatters/unix.js
diff --git a/packages/textlint-formatter/test/mocha.opts → ...textlint/linter-formatter/test/mocha.opts b/packages/textlint-formatter/test/mocha.opts → ...textlint/linter-formatter/test/mocha.opts
diff --git a/...formatter/test/textlint-formatter-test.ts → ...formatter/test/textlint-formatter-test.ts b/...formatter/test/textlint-formatter-test.ts → ...formatter/test/textlint-formatter-test.ts
@@ -1,11 +1,11 @@
 // LICENSE : MIT
 "use strict";
-import { createFormatter, getFormatterList } from "textlint-formatter";
+import { createFormatter, getFormatterList } from "@textlint/linter-formatter";
 
 import * as path from "path";
 import * as assert from "assert";
 
-describe("textlint-formatter-test", function() {
+describe("@textlint/linter-formatter-test", function() {
     describe("createFormatter", function() {
         it("should return formatter function", function() {
             const formatter = createFormatter({

diff --git a/packages/textlint-formatter/test/ts-setup.js → ...extlint/linter-formatter/test/ts-setup.js b/packages/textlint-formatter/test/ts-setup.js → ...extlint/linter-formatter/test/ts-setup.js
diff --git a/...ges/textlint-formatter/test/tsconfig.json → ...tlint/linter-formatter/test/tsconfig.json b/...ges/textlint-formatter/test/tsconfig.json → ...tlint/linter-formatter/test/tsconfig.json
diff --git a/packages/textlint-formatter/tsconfig.json → .../@textlint/linter-formatter/tsconfig.json b/packages/textlint-formatter/tsconfig.json → .../@textlint/linter-formatter/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.base.json",
+  "extends": "../../../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "./lib/"
   },

diff --git a/packages/textlint/package.json b/packages/textlint/package.json
@@ -67,6 +67,7 @@
     "@textlint/ast-node-types": "^4.0.0",
     "@textlint/feature-flag": "^3.0.3",
     "@textlint/kernel": "^2.0.4",
+    "@textlint/linter-formatter": "^3.0.2",
     "@types/bluebird": "^3.5.18",
     "bluebird": "^3.0.5",
     "debug": "^2.1.0",
@@ -88,7 +89,6 @@
     "read-pkg-up": "^3.0.0",
     "structured-source": "^3.0.2",
     "textlint-fixer-formatter": "^3.0.2",
-    "textlint-formatter": "^3.0.2",
     "textlint-plugin-markdown": "^4.0.5",
     "textlint-plugin-text": "^3.0.5",
     "try-resolve": "^1.0.1",

diff --git a/packages/textlint/src/options.ts b/packages/textlint/src/options.ts
@@ -1,6 +1,6 @@
 // LICENSE : MIT
 "use strict";
-import { getFormatterList, FormatterDetail } from "textlint-formatter";
+import { getFormatterList, FormatterDetail } from "@textlint/linter-formatter";
 import { getFixerFormatterList, FixerFormatterDetail } from "textlint-fixer-formatter";
 
 const optionator = require("optionator");

diff --git a/packages/textlint/src/textlint-engine.ts b/packages/textlint/src/textlint-engine.ts
@@ -1,5 +1,5 @@
 "use strict";
-import { createFormatter } from "textlint-formatter";
+import { createFormatter } from "@textlint/linter-formatter";
 import { AbstractTextLintEngine } from "./engine/textlint-engine-core";
 import { TextLintCore } from "./textlint-core";
 import { TextLintFormatterOption } from "./textlint-interface";