search

sounisi5011 / vec-draw

[WIP] SVGを書きやすくするDSL
0 stars 0 forks source link

`types`フィールドが一番下に移動してしまう #19

Closed sounisi5011 closed 5 years ago

sounisi5011 commented 5 years ago

問題

現在のpackage.jsonでは、TypeScriptの型定義ファイルを指定するtypesフィールドが一番下に記述されている。 このフィールドはmainやmoduleの下に併記されることが一般的であり、このような書き方は読みにくさを誘発してしまう。

原因

package.jsonのprettierとして導入されているprettier-package-jsonは、特定のキー以外を英字順にソートしてしまう。このパッケージはtypesフィールドに対応していない。

提案

prettier-package-json用の設定ファイルの追加、別のパッケージへの置き換え、などを提案する。

sounisi5011 commented 5 years ago

代用のパッケージとして、sort-package-jsonを考えている。最近更新されているし、膨大な量のフィールドに対応している。

sounisi5011 commented 5 years ago

代用のパッケージとして、sort-package-jsonを考えている。最近更新されているし、膨大な量のフィールドに対応している。

コードを読んでみたが、これは単純にフィールドをソートしているだけのように思える。 すなわち、prettier-package-jsonに存在したクールな機能が存在しない：

併用するのが良いと思う。

sounisi5011 commented 5 years ago

今確認してみたら、prettier-package-json@2.1.0にtypesフィールドが追加されていたぞ。 ただ、GitHubのほうはバージョン2.0.1のままなのが気にかかる… 大丈夫かこのパッケージ？

sounisi5011 commented 5 years ago

今確認してみたら、prettier-package-json@2.1.0にtypesフィールドが追加されていたぞ。 ただ、GitHubのほうはバージョン2.0.1のままなのが気にかかる… 大丈夫かこのパッケージ？

https://github.com/sounisi5011/vec-draw/pull/20#issuecomment-487268750 で更新してみた。

sounisi5011 commented 5 years ago

今確認してみたら、prettier-package-json@2.1.0にtypesフィールドが追加されていたぞ。 ただ、GitHubのほうはバージョン2.0.1のままなのが気にかかる… 大丈夫かこのパッケージ？

#20 (comment) で更新してみた。

実に酷い。sort-package-jsonも併用して。

sounisi5011 commented 5 years ago

今確認してみたら、prettier-package-json@2.1.0にtypesフィールドが追加されていたぞ。 ただ、GitHubのほうはバージョン2.0.1のままなのが気にかかる… 大丈夫かこのパッケージ？

#20 (comment) で更新してみた。

実に酷い。sort-package-jsonも併用して。

https://github.com/sounisi5011/vec-draw/pull/20/commits/ec63bf77ed55c4f38eaef1e1c69e9be1ad5fe888 でやってみた。 整形後のpackage.jsonは、かなり良い内容になったと思う。

sounisi5011 commented 5 years ago

https://github.com/sounisi5011/vec-draw/commit/ec63bf77ed55c4f38eaef1e1c69e9be1ad5fe888 でやってみた。 整形後のpackage.jsonは、かなり良い内容になったと思う。

素晴らしい👏