Leave editor appearance settings to each user#133
Conversation
| // "terminal.integrated.fontFamily": "HackGen, 'BIZ UDPGothic', Meiryo, 'Hiragino Kaku Gothic ProN', 'SF Mono', Consolas, monospace", | ||
| // "workbench.colorTheme": "Default Light+", | ||
| // "window.zoomLevel": 0, | ||
| // |
There was a problem hiding this comment.
ℹ️ [LOW] コメントアウトされたブロックの末尾(44行目の //)の直後に有効な設定行が続く構造になっています。JSONC としてはパース可能ですが、空のコメント行 // を区切りとして使う慣習はやや珍しく、将来的に誰かがコメントアウト行をアンコメントする際に末尾カンマの整合性を誤りやすい可能性があります。区切りには空行のみを使うか、あるいはコメントブロックの終端を // === のような視覚的に明確な形式にすることを検討してください。
f6a9c03 to
71915b1
Compare
|
レビューコメント([LOW] 空 対応内容
確認
ご確認をお願いします。 |
|
|
||
| // Font / appearance settings are left to each user's own VS Code config. | ||
| // Uncomment any of these to use the lab's recommended defaults. | ||
| // (osc52 above keeps a trailing comma, so any line here is safe to uncomment.) |
There was a problem hiding this comment.
osc52 above keeps a trailing comma, so any line here is safe to uncomment」とありますが、これは JSONC の末尾カンマ(trailing comma)の扱いについて誤解を招く説明です。
JSONC(VS Code が採用する JSON with Comments)は末尾カンマを許容しない仕様です。コメントアウトされた行をアンコメントすると、その行が最後のプロパティになった場合に末尾カンマが生じ、厳密な JSONC パーサではエラーになる可能性があります(VS Code 自体は寛容に扱うことが多いですが、CI や他ツールでのパースが壊れるリスクがあります)。
このコメントは削除するか、「コメントを外す際は末尾カンマに注意してください」という正確な注意書きに修正することを推奨します。
71915b1 to
b56b84b
Compare
| "window.zoomLevel": 0, | ||
|
|
||
| // Font / appearance settings are left to each user's own VS Code config. | ||
| // Uncomment any of these to use the lab's recommended defaults. |
There was a problem hiding this comment.
ℹ️ [LOW] コメントアウトされた設定ブロックの説明コメントが英語で書かれています。リポジトリ全体のコメントが日本語で統一されているのであれば、このコメントも日本語に合わせることを検討してください。ただし、英語のままでも問題はありません。
b56b84b to
af30a52
Compare
|
[MEDIUM] 指摘(注記コメントが JSONC の末尾カンマについて誤解を招く)に対応しました( 対応内容
確認
ご確認をお願いします。 |
| "window.zoomLevel": 0, | ||
|
|
||
| // Font / appearance settings are left to each user's own VS Code config. | ||
| // Uncomment any of these to use the lab's recommended defaults. |
There was a problem hiding this comment.
ℹ️ [LOW] コメントアウトされた設定ブロックの説明コメントが英語になっています。ファイル内の他のコメント(// Java settings - override host settings for container など)も英語なので統一性はありますが、このリポジトリが日本語話者向けの研究室環境であることを考えると、日本語コメントの方が利用者にとって分かりやすい可能性があります。例えば:
// フォント・外観設定は各ユーザの VS Code 設定に委ねます。
// 研究室推奨のデフォルト値を使う場合は、以下をコメントアウト解除してください。
必須ではありませんが、対象ユーザ層に合わせた言語選択を検討してください。
af30a52 to
eb35085
Compare
|
[LOW] 指摘(説明コメントの日本語化)に対応しました( 外観設定ブロックの説明コメントを日本語に変更: 研究室の利用者(日本語話者)にとって分かりやすくなりました。なお、既存の JSONC としてパース可能であることを確認済みです。ご確認をお願いします。 |
| "terminal.integrated.defaultProfile.linux": "bash", | ||
| "terminal.integrated.fontSize": 14, | ||
| "terminal.integrated.fontFamily": "HackGen, 'BIZ UDPGothic', Meiryo, 'Hiragino Kaku Gothic ProN', 'SF Mono', Consolas, monospace", | ||
| "terminal.integrated.osc52": "copy", |
There was a problem hiding this comment.
ℹ️ [LOW] "files.autoSave": "afterDelay" および "files.autoSaveDelay": 1000 は動作に影響する設定ですが、これらも個人の好みに依存する部分があります。例えば、自動保存を好まないユーザや、遅延時間を変えたいユーザにとっては強制になります。PR の方針(見た目系は委譲、動作系は維持)に照らすと、自動保存は「動作系」として残す判断も理解できますが、意図的に残した理由をコメントで補足しておくと、将来のメンテナンス時に混乱を防げます。
例:
// 自動保存: 編集中のファイルを自動保存します(研究室標準設定)
"files.autoSave": "afterDelay",
"files.autoSaveDelay": 1000,Comment out font and window.zoomLevel settings in devcontainer.json so they no longer override each user's personal VS Code configuration: - editor.fontFamily / editor.fontSize - terminal.integrated.fontFamily / terminal.integrated.fontSize - window.zoomLevel (forced zoom reset on every open; more intrusive than fonts, so delegated for the same reason) Functional settings are kept intentionally: terminal bash profile (asdf shims / makefile need a bash login shell), terminal osc52 clipboard copy (used by 'am s'), and the Java home/runtime overrides. The settings are commented out rather than deleted so users can opt into the lab's recommended defaults. Group separators use blank lines instead of bare '//' lines, and the commented block sits between active settings so JSONC stays valid. Indentation of the commented lines is normalized to tabs.
eb35085 to
3b81d37
Compare
|
[LOW] 指摘(維持した動作系設定に意図を補足)に対応しました(
// 動作に関わる設定(研究室標準として維持。見た目系のように各ユーザへは委ねない):
// - files.autoSave / autoSaveDelay: 編集中ファイルの自動保存
// - terminal...defaultProfile: makefile / asdf が bash ログインシェルを前提とする
// - terminal...osc52: `am s` のクリップボードコピーに必要
|
| // "terminal.integrated.fontFamily": "HackGen, 'BIZ UDPGothic', Meiryo, 'Hiragino Kaku Gothic ProN', 'SF Mono', Consolas, monospace", | ||
| // "workbench.colorTheme": "Default Light+", | ||
| // "window.zoomLevel": 0, | ||
|
|
There was a problem hiding this comment.
ℹ️ [LOW] コメントアウトされた外観設定ブロック(42〜47行目)の末尾に空行(48行目)が追加されていますが、その直後の // Java settings コメント(49行目)との間に空行が1つしかなく、視覚的な区切りとして十分かどうか確認してください。現状でも読めますが、有効な設定ブロックとコメントアウトブロックの境界をより明確にするために、コメントアウトブロックの前後に空行を1行ずつ統一するとさらに見やすくなります。軽微な点ですので優先度は低いです。
レビュー対応の区切りこれまでの指摘はすべて対応済みです:
直近の LOWは、レビュアーも「現状でも読める / 優先度は低い」としている任意の装飾的指摘のため、本 PR では見送ります。現状でも前後に空行 1 行ずつで統一されており、可読性に問題はないと判断しました。 機能面の変更はなく、CI( |
目的
devcontainer.jsonの VS Code 設定のうち、見た目に関する個人設定を強制せず、各ユーザの VS Code 設定に委ねる。変更内容
以下の見た目系設定をコメントアウト(削除ではなく、好みで uncomment できるよう残す):
editor.fontFamily/editor.fontSizeterminal.integrated.fontFamily/terminal.integrated.fontSizewindow.zoomLevel(開くたびにズームを 0 に強制し、ユーザのグローバル設定を打ち消すため、フォントと同じ理由で委譲)あわせて:
維持した設定(意図的に残す)
動作に必要なため、これらは委譲せず維持:
terminal.integrated.defaultProfile.linux: "bash"… asdf shim / makefile が bash ログインシェルを前提とするterminal.integrated.osc52: "copy"…am sのクリップボードコピーに使用java.jdt.ls.java.home/java.configuration.runtimes… ホスト設定を打ち消すための上書き品質確認