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(spindle-ui): stopped global import #548

Merged
merged 1 commit into from
Oct 13, 2022
Merged

Conversation

itsminadesu
Copy link
Contributor

@itsminadesu itsminadesu commented Oct 5, 2022

概要

ほとんどのコンポーネントのdocsにて、import文が個別インポートではなく

import { Button } from '@openameba/spindle-ui/Button';

spindle-ui丸ごとインポートになっていたので変更しました

import { Button } from '@openameba/spindle-ui';

@reg-suit
Copy link

reg-suit bot commented Oct 5, 2022

✨✨ That's perfect, there is no visual difference! ✨✨

Check out the report here.

@itsminadesu itsminadesu self-assigned this Oct 5, 2022
@itsminadesu itsminadesu marked this pull request as ready for review October 5, 2022 09:53
@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2022

Visit the preview URL for this PR (updated for commit 7069f9a):

https://ameba-spindle--pr548-docs-fix-import-docs-bxibaijy.web.app

(expires Sat, 12 Nov 2022 09:01:50 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Copy link
Contributor

@keiya01 keiya01 left a comment

Choose a reason for hiding this comment

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

ESMだと問題ないので悩ましいなと思ったりしました:thinking_face:
全ての例を変えるというよりかは注意書きで、cjsの場合はTree Shakingできないので明示的にパスを指定する必要がある有無を書いたほうが適切な気がしました!

@herablog
Copy link
Member

そっすな〜、記述として間違っているわけではないので無理にすべて書き換えるほどではないかなという感じがします。

ただ実利用時には考慮すべきポイントなので、注意点を1箇所(READMEとか?)書いておいて、参照してもいいかもっすね。

@itsminadesu
Copy link
Contributor Author

確かにそうですね、、!記述は元に戻しつつ、個別にインポートされていた箇所を逆に修正しました!

また、注意点を各々のドキュメントに書いてしまうとまた漏れが発生してしまいそうだったので、READMEの利用方法のところにコメントを追加しました!
c5ad1ae

Copy link
Contributor

@keiya01 keiya01 left a comment

Choose a reason for hiding this comment

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

良さそうです!:arigataya:

@herablog
Copy link
Member

nitsですが、コミットメッセージの冒頭 docs(spindle-ui): にしていただけるとよりよさそうです!

@itsminadesu
Copy link
Contributor Author

ハッ失礼しました、docs: -> docs(spindle-ui):に修正しました!

Copy link
Member

@herablog herablog left a comment

Choose a reason for hiding this comment

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

エンジニアを褒めるネコ:おすしどぞ

@itsminadesu itsminadesu merged commit 24b3ab4 into main Oct 13, 2022
@itsminadesu itsminadesu deleted the docs/fix-import-docs branch October 13, 2022 10:22
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.

None yet

3 participants