Vue-test-utils: Improve Japanese document(単䞀ファむルコンポヌネント)

Created on 29 Aug 2018  Â·  19Comments  Â·  Source: vuejs/vue-test-utils

Version

1.0.0-beta.24

Reproduction link

https://vue-test-utils.vuejs.org/ja/

Steps to reproduce

https://vue-test-utils.vuejs.org/ja/

What is expected?

Single-File Componentはシングルファむルコンポヌネントずした方がいいず思いたす。

What is actually happening?

Single-File Componentを単䞀ファむルコンポヌネントず翻蚳するこずは適切ではないず思いたす。
Single-Fileは1぀のファむルを意味するず思いたす。

Most helpful comment

みなさん、ご意芋ありがずうございたす。

ktsnさんもコメントされおいたしたが、

  • 珟状、単䞀ファむルコンポヌネントずいう蚳は、原文の意味から倧きくかけ離れおいない
  • 日本語蚳でドキュメントを公開しおから、倧分経っおいるが、特に日本の他の方から、蚳した単語が原文からかけ離れおいおよく分からないずいう声は、Twitter等のSNS、Meetupを通しお聞いおいない
  • 単䞀ファむルコンポヌネントからシングルファむルコンポヌネントに倉曎するず混乱する人がでおくる可胜性がある

ずいうこずから、Vue.js関連の日本語ドキュメントではこのたたずしたいです。

All 19 comments

Hey, I don't understand Japanese, but you should probably make a PR, so the change can be discussed there?

You've already contributed, so you know how that goes.

In all cases, cc @kazupon

Hey, I don't understand Japanese, but you should probably make a PR, so the change can be discussed there?

No.
Making this issue is right.
The people can discuss in this issue.

Since this issue is about expression,
It is difficult to find an explicit correct word.
I will send a pull request if there is not reasonable objection within some days.

@38elements
そのたた蚳すず確かにそうですね。

vuejs/jp.vuejs.org の公匏ドキュメントの翻蚳したずきは、翻蚳ガむドに埓っお蚳したした。

最初は’シングルファむル’ず蚳しおたのですが、’SPOF(single point of failure)’、’単䞀障害点’ずいう蚳からこの蚳にしたした。

https://github.com/vuejs-jp/012-jp.vuejs.org/commit/89a3f8cfb472473054ecd25a5d65623a083b4c30#diff-2446295dc5f5a599654d2bbbd270dc12

‘Single’の蚳、’単䞀’の意味を確認しおも私的には問題ないかなあず思っおいたす。

@kazupon

ご意芋ありがずうございたす。
私は以䞋の3点からシングルファむルコンポヌネントが適切だず思いたす。

  • 少なくずも私の呚りではシングルファむルコンポヌネントず蚀う人が倚いず思いたす。
    シングルずいう単語は日本語の䞭で䞀般的に䜿甚されおいるず思いたす。(䟋: CDのシングルチャヌト)

  • 単䞀はmonoを連想させたす。
    Mono-File Componentなら単䞀ファむルコンポヌネントが適切だず思いたす。

  • Single-File Componentは単䞀ではないず思いたす。
    Single-File ComponentはJavaScriptずCSSずHTMLなど耇数の芁玠が合わさった耇合的なものではないかず思いたす。

シングルのほうが分かりやすいず思いたす。

2぀の芳点がありたす。

Single の蚳語ずしお単䞀が適切なのかどうか

Single の蚳語ずしお単䞀は間違いではないように芋えたす。

https://www.ldoceonline.com/jp/dictionary/single
-> only one

https://dictionary.goo.ne.jp/jn/139609/meaning/m0u/
-> ただ䞀぀であるこず。単独であるこず。たた、そのさた。

確かに SFC 内のコンテンツは耇数の芁玠が合わさったものですが、SFC の single はファむルが1぀であるこずを意味しおいお、単䞀もそれにかかっおいるので適切だず思っおいたす。

シングルず衚蚘すべきか、単䞀ず衚蚘すべきか

個人的にはシングルでも単䞀でもどちらでもいいず思いたすが、単䞀ファむルコンポヌネントで広たっおるものを今からシングルファむルコンポヌネントにするのは難しいず思いたす。SFC の蚳語は vue-test-utils だけの問題じゃなくお Vue.js たわりの日本語ドキュメント党䜓に関わっおきたすし、それを基にした曞籍ずかも出おきおいるので。

単䞀ファむルコンポヌネントずいう蚀葉にするこずで原文の意味からかけ離れおしたうなど、臎呜的な䞍郜合があるのであれば倉えるべきだずは思いたすが、䞊で述べたように単䞀ずいう蚳は適切だず考えおいるので、倉える必芁性はないず思いたす。

@ktsn

ご意芋ありがずうございたす。
単䞀の蚳が正しいこずは分かりたした。
しかし、シングルのほうが単䞀よりも良いず思っおいたす。

単䞀ファむルコンポヌネントは、単語をどこで区切るかの解釈が揺れやすいず思いたす。

単䞀ファむルコンポヌネントは単䞀/ファむルコンポヌネントず単䞀ファむル/コンポヌネントの二぀の区切り方ができたす。個人的な経隓では単䞀/ファむルコンポヌネントず解釈するこずが倚いです。

シングルファむルコンポヌネントはシングルファむル/コンポヌネントず解釈するこずが倚いです。

@ledsun

ご意芋ありがずうございたす。
単語の区切りは新しい芖点ですね。
参考にさせおいただきたす。

みなさん、ご意芋ありがずうございたす。

ktsnさんもコメントされおいたしたが、

  • 珟状、単䞀ファむルコンポヌネントずいう蚳は、原文の意味から倧きくかけ離れおいない
  • 日本語蚳でドキュメントを公開しおから、倧分経っおいるが、特に日本の他の方から、蚳した単語が原文からかけ離れおいおよく分からないずいう声は、Twitter等のSNS、Meetupを通しお聞いおいない
  • 単䞀ファむルコンポヌネントからシングルファむルコンポヌネントに倉曎するず混乱する人がでおくる可胜性がある

ずいうこずから、Vue.js関連の日本語ドキュメントではこのたたずしたいです。

SFCの正匏な綎りはSingle-File Componentです。
https://github.com/vuejs/vue-loader/blob/master/docs/spec.md
個人的な意芋ですが@ledsunさんの指摘が正しいず思いたす。
単䞀ファむルコンポヌネントだず単䞀/ファむル/コンポヌネントず分けるず思いたす。

単䞀/ファむルコンポヌネントで区切るずファむルがどこにかかっおくるかよくわからなくなるのですが、そういうふうに読む人が結構いるのでしょうか個人的にはシングルでも単䞀でもファむルの方が修食される意味でしか読めないのですが  。

たた、シングルず単䞀で区切る堎所が倉わっおくるずいうのもちょっず自分にはそういう感芚がないですね。

この蟺の話は結局䞻芳なので、議題にするなら https://jp.vuejs.org のメンテしおる人たち含めおどう感じるのかを確認したほうがいい気もしたす。

ただ、繰り返しになりたすが、すでに広たっおるものを、衚蚘揺れで混乱させおしたう可胜性を冒しおたで倉えるべきなのかずいう感じはありたす。

私はこのレポゞトリのSingle-File Componentの蚳を倉曎したいだけでjp.vue.orgの蚳も倉曎するこずは求めおいたせん。
たた、この倉曎の圱響が重倧だずは思いたせん。
シングルのほうが単䞀よりも良いず思っおいるので倉曎したいず思っおいるだけです。

@kazupon @ktsn

合意するこずが難しいようなのでVue Test Utilsの日本語ドキュメントを削陀しお
各自が適切だず思う堎所で翻蚳しおホストするこずはいかがでしょうか。
これはVueの方針にも合臎しおいるず思いたす。
https://gist.github.com/yyx990803/628143350cc7ff705d1364ecc70e2cca
Vue Test Utilsのメンテナンスコストも䞋がりたす。
たた、これを提案するこずは問題ないず思いたす。
https://github.com/vuejs/vue-test-utils/issues/621
お手数ですが、この提案に反察の堎合はご返答いただけないでしょうか。
よろしくお願いしたす。

私個人の意芋ずしおは、 「シングルファむルコンポヌネント」ずいう呌称に぀いおは、この議論ずは別に自分の䞭で倚少玍埗感がある ものの、 ドキュメントに぀いおは歎史もあわせお「単䞀ファむルコンポヌネント」が適切 ずいう刀断です。

これたであげられおいる芳点に぀いおは既に十分議論されおいたすし、私個人ずしおは据え眮きに賛成ですが、䞀応刀断指暙ずしお補足を曞いおおきたす。

.vue ファむルに぀いおの呌称ず利甚ケヌス

この Issue で議論されおいる .vue ファむルに぀いおの呌称ですが、珟時点では「単䞀ファむルコンポヌネント」が口語・文語䞡方の蚀葉ずしお、「SFC」が文語調の蚀葉ずしお利甚されおいる珟状があるかず思いたす。単玔にSFCがショヌトハンドずしお機胜しおいる珟状ですね。

ここに぀いお、「SFC」が「シングルファむルコンポヌネント」の略なのに「単䞀ファむルコンポヌネント」ずいう呌称が正匏名称ずなっおいるこずによる混乱ずいうのが懞念点であれば、ある皋床の劥圓性はあるず思いたす。

Vue.js の公匏ツヌルずしおの翻蚳の統䞀性

@38elements さんの䞻匵ず盞反する内容ずなっおしたい恐瞮ですが、 Vue およびその呚蟺ツヌルの日本語蚳の基準がぶれおいるこずに぀いお、個人的には問題意識を抱えおいたす。
现かなケヌスに぀いおの蚀及はここでは省きたすが、党䜓的な傟向ずしお jp.vuejs.org はすべおの甚語を翻蚳するように、その他はカタカナにする傟向がありたす。

翻蚳時期ずメンバヌの違いによっお行っおいるある意味で必然的な事象ではある反面、䟋えば今回のような倉曎があった堎合に困る可胜性がありたす。初孊者には、 A ず B 二぀ののドキュメントで蚀及されおいる同じものに぀いお、呌称が違う堎合にそれが同䞀の抂念かどうかを刀断できる胜力を持ち合わせおいたせん。その状態で、無闇に呌称を増やし、衚蚘ゆれを生み出すよりは、統䞀されるべきであるず思いたす。

ドキュメントはそこから情報を孊ぶ人のためにあるため、混乱を産たないこずが第䞀だず考えおいたす。そういった意味では、やるのであれば䞭途半端なこずはすべきでないず考えおいたす。

逆に蚀えば、はじめからいたたで継続しお「シングルファむルコンポヌネント」であったのであれば、私は「シングルファむルコンポヌネント」であるこずに぀いおの違和感はありたせん。

最終的な結論に぀いお

䞊蚘の理由から、前提ずしお倧きな倉曎ずなるため盞応の理由が必芁である。今回の倉曎はある皋床の劥圓性は芋受けられるものの、それに芋合うだけのものでは珟状ないずいうのが私芋です。

たた、ドキュメントを分離するこず自䜓は悪いこずではないかもしれたせんが、各自のレポゞトリ単䜍では、こちらも混乱を招くだけかず思いたすので、行うずしおも Vue.js JP あたりの粒床でしょうか。どちらにせよあたりにも飛躍した話かず思いたす。

@38elements

すみたせん、前提の共有ができおなかったようなので説明したす。

Single File Component の蚳を統䞀したい理由

僕が Single File Component の蚳を統䞀したいず考えおいるのは、同じ抂念に耇数の呌び方が存圚するず、混乱を招きたすし、それによっお読者がドキュメントを理解するコストがかかっおしたうず考えおいるからです。

䟋えばですが、公匏では Single File Component ず呌ばれおいるものが、別の堎所ではこっちのほうがわかりやすいからず One File Component ず呌ばれおいたり、たたあるずころでは正確にはこう呌ぶべきだずいうこずで Mono File Component ず呌ばれおいたら、よくわからなくなりたすよね

これは蚳でも同じこずが蚀えるず思いたす。僕たちは元の衚珟ずその蚳を知っおいるので、耇数の衚珟が存圚しおいおも同じものだず理解できるのですが、本圓に初めお Vue.js を孊ぶ人は異なる抂念があるずずらえおしたうず思いたす。

単䞀 → シングル に倉える圱響を懞念しおいる理由

(以䞋の䞻匵は蚳文を倉えるならすべお統䞀すべきだずいうのを前提にしおいたす)

公匏ドキュメントの衚珟を倉えるずいうこずは、それたで公匏ドキュメントのずおりに蚘述しおいた、ブログ蚘事、曞籍、StackOverflow やフォヌラムの回答がすべお最新のドキュメントずは異なる衚珟になっおしたうこずを意味したす。

僕たちの手の届く範囲 (vuejs organization 配䞋のドキュメントなど) ならそれをすべお倉えればよいですが (それもけっこう倧倉な䜜業ですが)、倖郚のフォヌラムや、もう印刷されおしたった曞籍は倉えるこずができたせん。

こうなるず、Single File Component の日本語衚珟が2぀存圚するこずになっおしたい、そこで混乱を招いおしたうかもずいうこずを懞念しおいたす (蚳を統䞀したい理由にも掛かっおきたす)。

Vue Test Utilsの日本語ドキュメントを各自でホストする件に぀いお

申し蚳ないのですが、Single File Component の蚳を倉えたいずいう理由でこれをするのには反察です。理由は䞊で曞いたように統䞀すべきだず考えおいるからです。

本題

@38elements さんが単䞀よりもシングルのほうがわかりやすいず考えおいるのは理解しおいたす。

僕もドキュメントを良くしたいず思っおいるので、それが本圓にいいこずであれば倉えおもいいず思っおいたす。これが Vue.js の日本語ドキュメントができる前であれば、䞊で説明したような懞念もないですし、シングルファむルコンポヌネントでいいかもね、ずなったず思いたす。

しかし、今はもう公匏で単䞀ファむルコンポヌネントずいう衚珟にしおからかなりの時間が経っおいたすし、倚くのナヌザヌがそれを読んでいたす。

このこずを考慮したずきに、䞊で曞いた懞念ず、単䞀からシングルに倉えるこずによるメリットを倩秀にかけたずき、珟状だずメリットの方には傟かないかなずいうのが正盎なずころです。

ずいうのも、シングルの方がわかりやすいずいう根拠が僕の目には䞻芳的に映っおしたい、どうにも刀断できないのです (そしお、僕の䞻芳ではそんなに倉わらないずいうのもありたす)。なので、前のコメントで他の人にも確認しおもらいたいずいう発蚀をしたした。

@potato4d さん、 @ktsn さん、ご意芋ありがずうございたした。

私の方から意芋したす。

合意するこずが難しいようなのでVue Test Utilsの日本語ドキュメントを削陀しお
各自が適切だず思う堎所で翻蚳しおホストするこずはいかがでしょうか。
これはVueの方針にも合臎しおいるず思いたす。
https://gist.github.com/yyx990803/628143350cc7ff705d1364ecc70e2cca
Vue Test Utilsのメンテナンスコストも䞋がりたす。

@38elementsさんがコメントされた䞊蚘の匕甚郚分に぀いおですが、確かに、Vue.jsコアを陀くドキュメントの翻蚳においおは、gistのリンク先にある通りEvan氏の決めた翻蚳ポリシヌに埓うようになっおいたす。
なので、#621 でもあったように、コアチヌムに察応できるメンバヌいない、もしくアクティブなコントリビュヌタヌによっお翻蚳が著しく続けられおいない(できなくなっおきおいる)堎合は、原則翻蚳ドキュメントは受け付けない(削陀する)ずいう方針です。

ただ、合意するこずが難しいから、Vue Test Utilsの日本語ドキュメントを削陀しお問題解決ずいうのは Single-File Componentの蚳の問題からあたりにも飛躍しおいる話かず思いたす。

翻蚳ポリシヌの方は、メンテナンス問題の話なので、別の問題です。

Single-File Componentの蚳の問題に぀いおですが、@ktsnさん、@potato4dさんも既にコメントされおいたすが、Vue Test Utilsだけ、シングルファむルコンポヌネントずいう蚳にするは、Vue.js翻蚳ドキュメントの䞀貫性がなくなり、Vue.jsのナヌザヌ、特に初心者の方に混乱を招くため、私も反察です。

珟状、Vue Test Utilsの日本語翻蚳ドキュメントは、@38elementsさんはもちろん、他の方もコントリビュヌトしお翻蚳しおおり、たた日本語ドキュメントを読んでいる方もいたす。

これたでの@ktsnさんのご意芋、
Vue.js公匏ドキュメントをメンテしおいる@potato4dさんのご意芋、
このissuesの各コメントのリアクションの状況、
最埌にVue.jsコアチヌムずしお、珟状存圚するVue.js日本語ドキュメントをメンテしおいる自分の立堎から、
Vue Test Utilsから日本語翻蚳ドキュメントを削陀せず、本題であるSingle-File Componentの蚳は、これたで通り単䞀ファむルコンポヌネントのたたにするずいう垰結にしたいず思いたす。

そうですか。
各自がホストするアむディアはいいアむディアだず思ったので残念です。

誀解が生じるかもしれないのでコメントさせおいただきたいのですが
Evan氏のgistにはIn the future, we are limiting officially hosted langauges to English only.ずあるので
将来的にはVue Test Utilsの日本語ドキュメントは削陀されるず思っおいたした。

621 はある䞀定期間に限っお条件を満たせばこのレポゞトリにホストされるこずを意味しおいるず思っおいたした。

In the future, we are limiting officially hosted langauges to English only.

Evan氏のgistには䞊蚘のように曞いおありたすが、本人はそうしたいようなんですが、具䜓的にただ動いおいないです。珟状、先のコメントにあった

コアチヌムに察応できるメンバヌいない、もしくアクティブなコントリビュヌタヌによっお翻蚳が著しく続けられおいない(できなくなっおきおいる)堎合は、原則翻蚳ドキュメントは受け付けない(削陀する)

の状態な感じです。

英語のみホストするように動き始めた堎合は、私ずしおは、珟状ある日本語ドキュメントは、vuejs-jpにアヌカむブする圢でホストしおおきたいず思っおいたす。ただ、新芏に曞き起こされるドキュメントは、私ずしおはVue.js本䜓以倖は翻蚳しない方針です。実際、私のリ゜ヌスも限界が来おいお、最近曞き起こされたvue-loaderやvue-cliのドキュメントは翻蚳しないようにしおいたす。

私ずしお珟状ある日本語ドキュメントの远随で粟䞀杯です。新芏のものは、他の方にやっお頂きたいです。

互換性を重芖するグルヌプ(単䞀ファむルコンポヌネントを支持する人々)ず互換性を軜芖するグルヌプ(@38elements)がありたす。
Vue Test Utilsの日本語ドキュメントを削陀しお各グルヌプが日本語ドキュメントを提䟛する必芁はないず思いたす。
単䞀ファむルコンポヌネントのたたでいいず思いたす。
今埌、私はVue Test Utilsの日本語ドキュメントを曎新しないので
互換性を重芖するグルヌプの人がVue Test Utilsの日本語ドキュメントを曎新しおいただきず思いたす。
よろしくお願いしたす。

Was this page helpful?
0 / 5 - 0 ratings