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

Translation foundation system structure #6

Merged
merged 10 commits into from
Feb 1, 2019

Conversation

potato4d
Copy link
Member

@potato4d potato4d commented Feb 1, 2019

This project is a part of #2

Changes:

  • Install TextLint
  • Install TextLint JTF-style preset
  • Format documents w/ TextLint auto-formatter and manual work
  • Add lint:text to all-check and ci-check target

@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

CircleCI does not seem to be valid yet.
I will turn it on.

@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

I confirmed that CI will fail. After correction, remove WIP.

@potato4d potato4d changed the title WIP: Translation foundation system structure Translation foundation system structure Feb 1, 2019
@smikitky
Copy link
Member

smikitky commented Feb 1, 2019

Maybe we can ignore/exclude untranslated materials using something like glob or .XXXignore? Looks like many errors detected by textlint are ones that should be handled in the upstream repo.

@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

Looks like many errors detected by textlint are ones that should be handled in the upstream repo.

I agree about many cases.

For example, the following should be processed with upstream.

https://github.com/reactjs/ja.reactjs.org/pull/6/files#diff-b01ab259175317c1784e1ece8d505291R183

On the other hand, There is also a problem dedicated to Japanese documents.

https://github.com/reactjs/ja.reactjs.org/pull/6/files#diff-c41f5967bd8994ce9a1935f0ef2488d5R283

But, as far as I know, TextLint is not have ignore file or filter system.
Alternative: Introducing TextLint incrementally using lint-staged

@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

memo: 一旦 JTF-Style から不必要なものを省いたが、徐々にカスタムルールを設定していく必要がある(ルールを書くのには多少時間がかかるので、ひとまずあとで行う)

@potato4d potato4d mentioned this pull request Feb 1, 2019
90 tasks
@smikitky
Copy link
Member

smikitky commented Feb 1, 2019

Probably it's good to submit a separate PR to the upstream repo that fixes those mistakes in the original source files. Eventually the fix will be merged here and the problem will be gone (at least for a while).

@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

@smikitky
ちょっと混乱してきたので日本語で申し訳ないのですが、 upstream はオリジナル文書という認識ですかね?

upstream(en) / fork(ja) の場合、 JTF-Style はあくまでも日本語の取扱についての規則なので、 < を < にするみたいな個別事項は Pull Request を送ってもよさそうな反面、全角・半角の取扱などは ja の都合を en に押し付けるのは微妙かなぁと思っています。

なので個人的にはこれはこれで入れてしまって、その上で < を < にといった作業は個別で Pull Request を reactjs.org に送るのが丸いかな。という印象です。

ja 翻訳のスピード感都合で少し視点が歪んでるかもしれませんが、どうでしょう?

@smikitky
Copy link
Member

smikitky commented Feb 1, 2019

はい、upstream はフォーク元のリポジトリ(今回は reactjs/reactjs.org)です。

改めて眺めてみると、確かに未翻訳の原文の改変だけ見ても、「これは確かに原文自体が完全にミス」というのと「これは textlint の都合であって本来どうでもいい」というのと「むしろ textlint のミスであって原文が正しい」というのが混在していますね…。blog/2014-02-05-community-roundup-15.md のとかは原文が正しいような気がします。

当面 blog をチェックから外すのも難しい感じですか?

@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

@smikitky
glob 記法が使えるので blog を限定的に外すみたいなことは可能ですね。そうしましょうかー。

@potato4d potato4d force-pushed the feature/translate-glossary branch from 5539adc to fa8dbd7 Compare February 1, 2019 04:49
@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

@smikitky
Just completed these.

  • rollback content/blog content same as master
  • Ignore lint target to content/blog

I'm waiting for your review!

@potato4d potato4d requested a review from smikitky February 1, 2019 04:50
Copy link
Member

@smikitky smikitky left a comment

Choose a reason for hiding this comment

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

当面 blog だけではなく community の中身も lint かけずに放置の方がよい気がします。やるとしても数週間は先でしょうし。

content/docs/state-and-lifecycle.md Show resolved Hide resolved
@smikitky
Copy link
Member

smikitky commented Feb 1, 2019

あとは community の中で改変された韓国語や中国語のファイルをロールバックする必要がありそうですね

@smikitky
Copy link
Member

smikitky commented Feb 1, 2019

あと使い方なんですが yarn した後に npm run lint:text するだけでいいんでしょうか、他に設定とか準備とかありますか? (TRANSLATION.md に書かないといけないので)

@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

@smikitky

devdependencies に入っているので npm run lint:text だけで大丈夫です。
今回一緒にやってしまうか悩みましたが、 現行の "lint": "eslint .","lint:eslint": "eslint .", にして、 "lint": "npm-run-all -p lint:*", としたほうが翻訳者には優しいかなと思いました。

npm run lint で全てまとめて(かつ並列で)走ってくれるので

@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

TRANSLATION.md は TRANSLATION.md で書いたほうがよさそう(用語集を追加する時に)だと考えてここでは編集していませんが、この PR でまとめて書いてしまいますか?

package.json Show resolved Hide resolved
@smikitky
Copy link
Member

smikitky commented Feb 1, 2019

TRANSLATION.md は別にこちらで編集しようかなと思います。(ちょっと1時間や2時間ではできないですが)

lint:text を動かして色々エラー入れ込んで確かめましたが、いい感じで動いてますね、よいと思います!

@smikitky
Copy link
Member

smikitky commented Feb 1, 2019

マージはお任せします

@potato4d
Copy link
Member Author

potato4d commented Feb 1, 2019

ありがとうございます!
セルフマージはあんまり健全じゃなさそうなので、基本はマージしてもらう形のほうが気持ちはありがたいかもしれません 🙏

@potato4d potato4d merged commit 99b12e3 into master Feb 1, 2019
@smikitky
Copy link
Member

smikitky commented Feb 1, 2019

次からそうします!

@potato4d potato4d deleted the feature/translate-glossary branch February 2, 2019 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants