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

dressca-backendの.editorconfigの改行コードの設定が全ファイルに対して有効になっていない #836

Closed
kharada7 opened this issue Feb 21, 2024 · 4 comments · Fixed by #903
Assignees
Labels
target: ConsoleAppWithDI コンソールアプリケーションの要件別サンプルに関係がある target: Dressca サンプルアプリケーションDresscaに関係がある
Milestone

Comments

@kharada7
Copy link
Contributor

kharada7 commented Feb 21, 2024

概要

dressca-backend の .editorconfig には改行コードを LF に変換する設定が存在するが、以下のようにC# と VB.NET に対してしか有効になっていない。

[*.{cs,vb}]
(中略)
end_of_line = lf

このままだと nswag.json の改行コードが CRLF に勝手に変換されてしまうため、以下のようにすべてのファイルに対して改行コードを LF に変換するようにする。

[*]
end_of_line = lf

ConsoleAppWithDIの方にも同様の問題がないか確認し、必要があれば別途Issueをたてる。

完了条件

  • dressca-backend の .editorconfig に上掲の修正が反映されていること。
  • nswag.json の改行コードが勝手に CRLF に変換されないこと。
@tsuna-can-se tsuna-can-se added target: Dressca サンプルアプリケーションDresscaに関係がある target: ConsoleAppWithDI コンソールアプリケーションの要件別サンプルに関係がある labels Feb 29, 2024
@tsuna-can-se tsuna-can-se added this to the v0.8 milestone Feb 29, 2024
@KentaHizume
Copy link
Contributor

調査

  • ConsoleAppWithDIも同様に[*.{cs,vb}]配下に設定があるため、要修正

@KentaHizume
Copy link
Contributor

KentaHizume commented Mar 5, 2024

課題

  • 変更後の設定がVisual Studioに反映されない 下記いずれもNG
  • どこかにキャッシュされていて、古いものを読んでいたりする?
    • VSの再起動
    • PCの再起動
  • 追加>新しい項目 を行った際に、C#クラスファイルはデフォルトでLFになるが、JSONファイルはCRLFのままなので、nswagだけではなく全体的に設定が反映されていない

@KentaHizume
Copy link
Contributor

KentaHizume commented Mar 6, 2024

  • 手詰まり状態なので、他の方の環境ではどのような動作をするか確認を依頼する

    • 追加>JSONファイルを追加した際どうなるか
    • ソリューションのリビルド時、nswag.jsonの改行コードがどうなるか
  • 別環境で試していただいたが、同様の現象が発生しているので、Visual Studioの仕様の可能性が高い

試したがNG

  • end_of_line = lf以外の設定をすべて消す
  • root = trueを指定する
  • 新しくリポジトリをgit cloneする
  • [*.json]セクションを作って設定する
  • プロジェクト内に新しいeditorconfigを作成する
  • Visual Stuidioの修復

確認した内容

  • end_of_line = crlfに変更して再起動すると、C#クラスファイルがCRLFで作成されるようになる
  • その後end_of_line = lfに戻すと、LFで作成されるので、editorconfigの読み込みは行われている

不明点

  • .cs以外のファイルに設定が反映されない理由が不明(逆に.csには反映される理由が不明)

@KentaHizume
Copy link
Contributor

KentaHizume commented Mar 8, 2024

すべてのファイルを対象とすると、バイナリファイル(画像など)に変な副作用があるかもしれないので、
対象は必要なファイルに絞ったほうがよいかもしれない

フロントエンド側は全ファイルを指定しているので、全ファイル指定でも問題ないように見える。

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_size = 2
indent_style = space
trim_trailing_whitespace = true

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target: ConsoleAppWithDI コンソールアプリケーションの要件別サンプルに関係がある target: Dressca サンプルアプリケーションDresscaに関係がある
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants