Skip to content

feat: サーバが出した画像エラーを目立たせるようにする #522

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

Merged
merged 1 commit into from
Apr 18, 2025

Conversation

0Delta
Copy link
Contributor

@0Delta 0Delta commented Apr 9, 2025

画像の参照エラー等を、既存のエラーと同じ場所に出してあげることで UX を改善する。

内部的には zenn-cli/server で出力するタグに専用のクラスを追加し、それを zenn-model から全文検索で検出している。
将来的にクラスを増やすことで別メッセージを出力させるようにすることも可能。
2つのパッケージに同じ単語を入れなければならない暗黙的なルールができてしまう所は要検討か。

📑 Summary

プルリクエストに含む内容の簡潔な記述

Resolves zenn-dev/zenn-community#681

📋 Tasks

プルリクエストを作成いただく際、お手数ですが以下の内容についてご確認をお願いします。

  • 📖 Contribution Guide を読んだ
  • 👩‍💻 canary ブランチに対するプルリクエストである
  • zenn-cli で実行して正しく動作しているか確認する
  • 不要なコードが含まれていないか( コメントやログの消し忘れに注意 )
  • XSS になるようなコードが含まれていないか
  • モバイル端末での表示が考慮されているか
  • Pull Request の内容は妥当か( 膨らみすぎてないか )

より詳しい内容は Pull Request Policy を参照してください。

@cm-dyoshikawa
Copy link
Contributor

@0Delta PRを作成いただきありがとうございます!

お手数ですが、以下の手順でローカルサーバを起動し、今回の変更がわかるようにスクリーンショットを撮影して共有いただくことは可能でしょうか? 🙏


共通のセットアップ

# プロジェクトルートで実行
pnpm i
pnpm run build

zenn-cliのセットアップ

cd packages/zenn-cli
cp .env.example .env
pnpm i
# ローカルサーバが起動、ブラウザから動作確認が可能
pnpm run dev

@0Delta
Copy link
Contributor Author

0Delta commented Apr 15, 2025

以下の方法で確認しました。

# 複数パッケージを変更したので全体ビルド
pnpm i && pnpm build

# プレビュー
cd packages/zenn-cli
pnpm exec:zenn preview

# localhost:8000 で確認

画像にエラーがあった場合、ヘッダに以下のように出るようになります。
image

既存のエラーメッセージはそのまま表示させています。
これはどの画像がエラーになっているか非常にわかりやすいためです。
image

ですので、ヘッダーへの追記はものぐさな人向けの注意喚起という位置付けでエラー箇所への誘導を行なうような文言にしてあります。

Copy link
Contributor

@cm-dyoshikawa cm-dyoshikawa left a comment

Choose a reason for hiding this comment

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

@0Delta

ありがとうございます!

チームで話し合いまして、本文中の画像エラーを画面上部にも表示するというアイデアは受け入れるつもりです。
コードについていくつかコメントしましたので、対応いただけますと幸いです。

`zenn-cli/server` で出力するタグに専用の要素を追加し、それを
`zenn-model` からcheerioを利用して検出。
該当があるなら、既存のエラーと同等に出してあげることで UX を改善する。
@0Delta 0Delta force-pushed the feat-server-error-ux branch from 781d67a to 681b68a Compare April 17, 2025 17:55
@0Delta
Copy link
Contributor Author

0Delta commented Apr 17, 2025

@cm-dyoshikawa 諸々修正したコミット作りました!
確認お願いします 🙇

@cm-dyoshikawa cm-dyoshikawa merged commit faddbbb into zenn-dev:canary Apr 18, 2025
3 checks passed
@cm-dyoshikawa
Copy link
Contributor

@0Delta マージしました!対応ありがとうございました!

当面はzenn-cliのcanaryバージョンでお使いいただけます。

@cm-dyoshikawa cm-dyoshikawa mentioned this pull request Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature 機能追加・改善
Projects
None yet
Development

Successfully merging this pull request may close these issues.

不正な画像が入っている時のエラーメッセージの可視性を上げる
3 participants