Move core modules to @textlint namespace

[azu]

ℹ️ Migration information

For textlint user

If you have seen following deprecated warning, please update lateste textlint, textlint-tester, or textlint-scripts.

warning textlint-scripts > textlint-tester > textlint > textlint-plugin-text@1.1.4: See https://github.com/textlint/textlint/issues/455
warning textlint-scripts > textlint-tester > textlint > txt-ast-traverse@1.2.1: See https://github.com/textlint/textlint/issues/455
warning textlint-scripts > textlint-tester > textlint > textlint-formatter@1.8.0: See https://github.com/textlint/textlint/issues/455
warning textlint-scripts > textlint-tester > textlint > textlint-plugin-markdown@2.0.5: See https://github.com/textlint/textlint/issues/455
warning textlint-scripts > textlint-tester > textlint > textlint-plugin-text > txt-to-ast@1.1.0: See https://github.com/textlint/textlint/issues/455
warning textlint-scripts > textlint-tester > textlint > textlint-plugin-markdown > markdown-to-ast@4.0.0: See https://github.com/textlint/textlint/issues/455
warning textlint-scripts > textlint-tester > textlint > @textlint/kernel > txt-ast-traverse@1.2.1: See https://github.com/textlint/textlint/issues/455

Update latest version

npm install textlint@latest
npm install textlint-scripts@latest

For node modules user

If you use someone of Migration pacakges, please move to scoped version.

For example, If you use markdown-to-ast, you migrate from markdown-to-ast to @textlint/markdown-to-ast.

npm uninstall markdown-to-ast
npm install @textlint/markdown-to-ast

And, you should change require("markdown-to-ast") to require("@textlint/markdown-to-ast").

---

npm recommened to use scoped.

If you are prevented from publishing a package with a name too similar to an existing package, the easiest way to find a unique name is to use your scope. You can scope packages to your npm account by putting @ + your npm user name in front of the name. For example, my npm user name is ceejbot, so my scope is @ceejbot.
http://blog.npmjs.org/post/168978377570/new-package-moniker-rules

We already have @textlint scope.

Pros

• Make explicit

For example, markdown-to-ast is confused name.

Cons

• Name chaning!

But, almost pacakges are only used in textlint.

• textlint/packages/

Migration pacakges

PR	Before	After
#473	txt-to-ast	@textlint/text-to-ast
#460	markdown-to-ast	@textlint/markdown-to-ast
#483	textlint-ast-test	@textlint/ast-tester
#484	txt-ast-traverse	@textlint/ast-traverse
#482	textlint-fixer-formatter	@textlint/fixer-formatter
#474	textlint-formatter	@textlint/linter-formatter
#485	textlint-plugin-markdown	@textlint/textlint-plugin-markdown
#486	textlint-plugin-text	@textlint/textlint-plugin-text

Migration Packages List

• txt-to-ast -> @textlint/text-to-ast refactor(text-to-ast): Move txt-to-ast to @textlint/text-to-ast  #473
• markdown-to-ast -> @textlint/markdown-to-ast refactor(markdown-to-ast): move markdown-to-ast to @textlint scope #460
• textlint-ast-test -> @textlint/ast-tester refactor(textlint-ast-test): move to @textlint/ast-tester #483
  • Add er is good
  • Align with @textlint/ast-node-types
• txt-ast-traverse -> @textlint/ast-traverse refactor(txt-ast-traverse): move to @textlint/ast-traverse #484
  • Align with @textlint/ast-node-types
• textlint-fixer-formatter -> @textlint/fixer-formatter refactor(textlint-fixer-formatter): move to @textlint/fixer-formatter #482
• textlint-formatter -> @textlint/linter-formatter refactor(textlint-formatter): move to @textlint/linter-formatter #474
• textlint-plugin-markdown -> @textlint/textlint-plugin-markdown refactor(plugin-markdown): move to @textlint #485
• textlint-plugin-text -> @textlint/textlint-plugin-text refactor(plugin-text): move to @textlint #486
  • textlint-plugin prefix is needed
  • Package name convention

No migration packages

These packages are used by external user.

• textlint
  • textlint it-self!
• gulp-textlint
  • textlint user use it
• textlint-tester
  • textlint rule creator use it

---

How to migrate?

Migrate to @textlint.
Maybe, transfer-github-owner help this.

Example: #473 #460

1. Move <name> to @textlint/<name> directory 710a09e
2. change usage of <name> to @textlint/<name> 5a12178

• And update yarn.lock by yarn bootstrap

3. Update core package table ec78494

• 💔 textlint-rule-no-dead-link found it as dead link

4. Add "publishConfig" 929b575

• "publishConfig": { "access": "public" } config is needed when you publish Scoped packages at first time
• Alt. npm publish --access public is anthor option
• But, publishConfig is more reasonable.

5. npm publish it as @textlint/<name> from local

• ❤️ This fix dead link of "Update core package table"
• It create https://www.npmjs.com/package/@textlint/markdown-to-ast on npm.

6. Create PR

Finally, deprecate old pacakge:

npm deprecate <old-pacakge> "See https://github.com/textlint/textlint/issues/455"

[0x6b]

@azu, I have a question; do we migrate textlint-* to @textlint/textlint-*, or to @textlint/*? e.g. @textlint/textlint-formatter or @textlint/formatter?

Since textlint- prefix is for name space, use it under scoped environment looks redundant for me.

[azu]

@0x6b Good question!

I've updated migration name.

[0x6b]

@azu, thank you for the clarification. It's good move.

txt-to-ast -> @textlint/txt-to-ast or @textlint/text-to-ast

+1 for @textlint/text-to-ast. Mixing "text" with "txt" in a package name is confusing and error–prone?

[azu]

I decided that rename txt-to-ast to @textlint/text-to-ast

[0x6b]

@azu, thank you.

I'm on my way to migrate textlint-formatter, and found that until you publish it as new name to the npm registry:

• no-dead-link rule fails because migrated package has new URL e.g. https://www.npmjs.com/package/@textlint/formatter
• yarn.lock becomes stale because I have to edit package.json manually as I can't update it by yarn install @textlint/formatter

So, while migrating, I think I need two pull requests. Am I missing anything?

1. Move a module to @textlint directory, update dependents, pass the tests
2. Open a pull request and ask you publish the module as new name
3. After publish, update dependents, yarn.lock, and related documents, pass the tests
4. Open another pull request and ask you deprecate old package

[azu]

no-dead-link rule fails because migrated package has new URL e.g. https://www.npmjs.com/package/@textlint/formatter

Yes! I've tried that move markdown-to-ast to @textlint/linter-formatter #460
#460's step 5(npm publish from local) is needed to pass CI.
In other words, step 5 create placeholder(temporary) page https://www.npmjs.com/package/@textlint/markdown-to-ast

It is better that complete migration task in a single PR :)

I've added @0x6b to npm @textlint member.
So, You can publish new package to @textlint scope.
In other words, you can do step5.

FYI: textlint-formatter will be @textlint/linter-formatter.

[azu]

@Leko I want to invite you to npm @textlint member.
Your npm account is lekoleko?

[0x6b]

@azu, thank you for adding me to the npm organization!
As for new name for textlint-formatter, I have to rework on local branch...anyway thank you for pointing out.

[0x6b]

@azu, while refactoring textlint-plugin-markdown to @textlint/textlint-plugin-markdown, textlint-engine-test was failed with following error:

textlint/packages/textlint/test/engine/textlint-engine-test.js

Line 84 in a144570

const engine = new TextLintEngine({ plugins: ["markdown"] });

  1) textlint-engine-test
       #loadPlugin
         when Plugin has not rules
           should not throw Error:
     ReferenceError: Failed to load textlint's plugin module: "markdown" is not found.

[azu]

@0x6b

textlint/packages/textlint/test/engine/textlint-engine-test.ts

Line 84 in 442c297

const engine = new TextLintEngine({ plugins: ["markdown"] });

Probably, you need to change plugin name.
This plugin name is shortcut of pacakge name(@textlint/textlint-plugin-markdown)

• markdown -> textlint-plugin-markdown
• @textlint/markdown -> textlint/textlint-plugin-markdown

- const engine = new TextLintEngine({ plugins: ["markdown"] });
+ const engine = new TextLintEngine({ plugins: ["@textlint/markdown"] });

[0x6b]

@azu, you are right! (as always)
textlint-module-resolver already take account this path. Impressed. Thank you.

textlint/packages/textlint/src/engine/textlint-module-resolver.ts

Line 26 in a144570

// if @scope/<name> -> @scope/<prefix><name>

[0x6b]

$ for package in txt-to-ast markdown-to-ast textlint-ast-test txt-ast-traverse textlint-fixer-formatter textlint-formatter textlint-plugin-markdown textlint-plugin-text; do echo -n "$package: "; npm info --json $package | jq .deprecated; done
txt-to-ast: "See https://github.com/textlint/textlint/issues/455"
markdown-to-ast: "See https://github.com/textlint/textlint/issues/455"
textlint-ast-test: "See https://github.com/textlint/textlint/issues/455"
txt-ast-traverse: "See https://github.com/textlint/textlint/issues/455"
textlint-fixer-formatter: "See https://github.com/textlint/textlint/issues/455"
textlint-formatter: "See https://github.com/textlint/textlint/issues/455"
textlint-plugin-markdown: "See https://github.com/textlint/textlint/issues/455"
textlint-plugin-text: "See https://github.com/textlint/textlint/issues/455"

Now we can go to another set of refactoring such as TypeScript-ify or Jest-ing (#451).

[0x6b]

Found that npm view <package> deprecated is simpler than npm info --json <package> | jq .deprecated.

$ for package in txt-to-ast markdown-to-ast textlint-ast-test txt-ast-traverse textlint-fixer-formatter textlint-formatter textlint-plugin-markdown textlint-plugin-text; do echo -n "$package: "; npm view $package deprecated; done
txt-to-ast: See https://github.com/textlint/textlint/issues/455
markdown-to-ast: See https://github.com/textlint/textlint/issues/455
textlint-ast-test: See https://github.com/textlint/textlint/issues/455
txt-ast-traverse: See https://github.com/textlint/textlint/issues/455
textlint-fixer-formatter: See https://github.com/textlint/textlint/issues/455
textlint-formatter: See https://github.com/textlint/textlint/issues/455
textlint-plugin-markdown: See https://github.com/textlint/textlint/issues/455
textlint-plugin-text: See https://github.com/textlint/textlint/issues/455