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

Docs: リファクタリング例を募集 #11

Open
azu opened this issue May 6, 2016 · 2 comments
Open

Docs: リファクタリング例を募集 #11

azu opened this issue May 6, 2016 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@azu
Copy link
Member

azu commented May 6, 2016

機械的に直すのは難しいので、READMEに修正例を載せていきたい。
Lintの結果を元に(そうでなくても問題ない)、修正したコミットへのリンクがあったらコメントに書いて欲しい

コミット以外にも参考リンクや文法の解説についての参考サイトも募集中

@azu azu changed the title リファクタリング例を載せる Docs: リファクタリング例を募集 May 6, 2016
@azu azu added the help wanted Extra attention is needed label May 6, 2016
@azu
Copy link
Member Author

azu commented May 6, 2016

このルールを使ってリファクタリングしてみた。

refactor(textlint): 敬体(ですます調)と常体(である調)の使い分けを厳密に by azu · Pull Request #94 · azu/JavaScript-Plugin-Architecture

-先ほどのgulpタスクの例では、既にモジュール化された処理を`pipe`で繋げただけであるため、
+先ほどのgulpタスクの例では、既にモジュール化された処理を`pipe`で繋げただけで、
 それぞれの処理がどのように実装されているかはよく分かりませんでした。
-BufferはStringと相互変換が可能であるため、多くのgulpプラグインと呼ばれるものは、`gulpPrefixer`と`prefixBuffer`にあたる部分だけを実装しています。
+BufferはStringと相互変換が可能なので、多くのgulpプラグインと呼ばれるものは、`gulpPrefixer`と`prefixBuffer`にあたる部分だけを実装しています。
-gulpではプラグインが持つ機能は1つ(単機能)であること推奨しています。
+gulpではプラグインが持つ機能は1つ(単機能)とすることを推奨しています。
-`jQuery.fn`の実装を見てみると、実態は`jQuery.prototype`であるため実際にprototype拡張していることがわかります。
+`jQuery.fn`の実装を見てみると、実態は`jQuery.prototype`なので、prototype拡張していることがわかります。
-単純なprototype拡張であると言えるので、利点はJavaScriptのprototypeと同様です。
+単純なprototype拡張なので、利点はJavaScriptのprototypeと同様です。
-まだNode.jsで使われているCommonJSやES6 Modulesといったものがなかった時代に作られた仕組みであるため、
+まだNode.jsで使われているCommonJSやES6 Modulesなどがなかった時代に作られた仕組みなので、
  • である => とする or にする
  • である => なので

のような書き換えが多い。

であるに引っ張られて前後の文が冗長になっているケースも多かった。

azu added a commit that referenced this issue May 6, 2016
@azu
Copy link
Member Author

azu commented May 6, 2016

http://petit.lib.yamaguchi-u.ac.jp/G0000006y2j2/file/21611/20130514114653/C060036000008.pdf
"とする"と"になる"の使い分けについて

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant