Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(textlint-formatter): move to @textlint/linter-formatter #474

Merged
merged 4 commits into from Jan 17, 2018

Conversation

0x6b
Copy link
Member

@0x6b 0x6b commented Jan 17, 2018

Ref #455.

Note: I did not change CLI name from textlint-formatter to linter-formatter for compatibility. I think textlint-formatter is more intuitive name for users, but if you think linter-formatter is better, please let me know and I will update this pull request as follows:

  1. Add linter-formatter.js to bin/ directory
  2. Add above to package.json#bin as key linter-formatter
  3. (Optional?) Add deprecate message while running textlint-formatter (bin/cmd.js)

Need major version bump as it will break CI build. Thanks.

@azu azu mentioned this pull request Jan 17, 2018
8 tasks
@0x6b 0x6b changed the title refactor(textlint-formatter): move textlint-formatter to @textlint/linter-formatter refactor(textlint-formatter): move to @textlint/linter-formatter Jan 17, 2018
@0x6b 0x6b added the Type: Refactoring A code change that neither fixes a bug nor adds a feature label Jan 17, 2018
@azu
Copy link
Member

azu commented Jan 17, 2018

(Optional?) Add deprecate message while running textlint-formatter (bin/cmd.js)

No. Runtime message break exiting behavior.

Instead of it, You can deprecate old module by executing following command:

npm deprecate textlint-formatter "See https://github.com/textlint/textlint/issues/455"

As as result, show deprecated message in installing time.

npm install textlint-formatter 
# show deprecated message

@azu
Copy link
Member

azu commented Jan 17, 2018

Need major version bump as it will break CI build.

Yes and No.
These are difference name, but the API is same.
So, It does not require major update.

ℹ️ Migration information for user
#455

Copy link
Member

@azu azu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Please do npm depreacate old module before merging.
#474 (comment)

@0x6b
Copy link
Member Author

0x6b commented Jan 17, 2018

@azu, appreciate your comments. I missed update (and detailed!) description at #455. Run npm deprecate then merge the pull request. Thank you very much.

@0x6b
Copy link
Member Author

0x6b commented Jan 17, 2018

For the record:

$ npm deprecate textlint-formatter "See https://github.com/textlint/textlint/issues/455"
$ npm info --json textlint-formatter | jq .deprecated
"See https://github.com/textlint/textlint/issues/455"

@0x6b 0x6b merged commit ea23a73 into textlint:master Jan 17, 2018
@0x6b 0x6b deleted the textlint-formatter-to-@textlint branch January 17, 2018 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Refactoring A code change that neither fixes a bug nor adds a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants