.editorconfig 生成器
ガイド
.editorconfig 生成器
妥当で規格に準拠した .editorconfig ファイルを作成し、プロパティ名を記憶せず、値を確認しなくても、言語のプレセットを選択し、グローバルデフォルトを調整し、いくつかの言語ごとのオーバーライドを切り替えて、結果をリポジトリのルートに直接コピーします。
EditorConfigファイルは、チームが使用するすべてのエディタとIDEでインデントスタイル、改行コード、文字セット、末尾の空白ルールを一貫性を持たせます。誤ったプロパティ名や許容範囲外の値は静的無視され、サポートされたキーのみを出力するジェネレーターは、開発者間の静かなズレを回避する最も安全な方法です。
使用方法
- [ブラウザのchrome]を選択し、 クイックプリセット あなたの主な言語(JavaScript/TypeScript、Python、Go、PHP、Ruby、ウェブ(HTML/CSS/JS)、または複数言語)に一致するものを選択します。プレセットは以下のすべてのグローバルデフォルトを事前に埋め込みます。
- 調整する グローバルデフォルト — インデントスタイル、インデントサイズ、タブ幅、改行コード、文字セット、最大行長、末尾の空白をトリム、および最終改行を挿入。
- 必要な項目をチェックしてください。 言語オーバーライド 各切り替えは、例えば
[*.py]または[{Makefile,makefile,GNUmakefile}]のような適切な範囲のルールを追加します。 - 生成されたファイルをコピーするか、ダウンロードして
.editorconfigをルートディレクトリに配置します。VS Code、JetBrains IDE、Vim、Sublime、および他の多くのエディタには、自動的に読み込まれます。
機能
- 言語プレセット JavaScript/TypeScript、Python、Go、PHP、Ruby、ウェブ(HTML/CSS/JS)、および複数言語をカバーする混合プロファイルが含まれます。
- すべての標準グローバルプロパティ –
indent_style,indent_size,tab_width,end_of_line,charset,trim_trailing_whitespace,insert_final_newline、および任意のmax_line_length. - スコープオーバーライド — Markdown、YAML、JSON、JS/TS、CSS、HTML/XML、Python、Go、PHP、Ruby、Makefile(タブインデントを強制)、および
.bat/.cmd(CRLFを強制)。 - ライブプレビュー — ファイルは変更ごとに更新され、コピーおよびワンクリックダウンロードボタンが提供されます。
- クライアントサイドのみ — フォームの状態はブラウザに残り、サーバーにアップロード、ログ、または保存されません。
- 常に妥当 — 出力されるプロパティはEditorConfig規格が許容する値に制限されており、ファイルが静かに無視されないようになります。
なぜEditorConfigですか?
共有設定がないと、1つのリポジトリは1つのファイルにタブ、別のファイルに4スペース、Windowsの貢献者がCRLF改行コードを導入するといった状況に陥ります。EditorConfigは、リーダーまたはフォーマッターが実行される前に、すべてのエディタが遵守すべきフォーマット契約をプロジェクトルートの1つのファイルで表現することで、これを解決します。
よくある質問
-
.editorconfigファイルをどこに置くべきですか?
リポジトリのルートに配置してください。EditorConfigをサポートするエディタは、編集されているファイルから上に進み、経過するすべての.editorconfigファイルの設定をマージします。そのため、ほとんどのプロジェクトではルートレベルのファイルが十分です。必要であれば、特定のフォルダにネストされた.editorconfigファイルを配置して、フォルダごとのルールを上書きできます。
-
root = true はどのような意味ですか?
ファイルのトップにある root = true ディレクティブは、EditorConfigプラグインが親ディレクトリにさらに.editorconfigファイルを検索しないようにします。これがないと、プラグインは上に進み、意図していないホームディレクトリや親プロジェクトファイルの設定をマージする可能性があります。
-
indent_size は tab_width と同じですか?
関連性はありますが、別物です。indent_size は選択されたインデントスタイルで、インデントレベルが何列を表すかを示します。tab_width は、文字列のタブ文字の視覚的な幅です。これらが異なる場合、EditorConfigは indent_style = space と indent_size = 4 というスタイルをサポートしつつ、tab_width によりタブ文字を8列として表示します。
-
なぜMakefileはタブを使用しなければなりませんか?
GNU make はレシピ行の先頭に文字列のタブ文字を必要とします。そのタブをスペースに変換すると、makeはセパレータが欠けているというエラーを出力します。そのため、Makefileオーバーライドは indent_style = tab と indent_size を省略し、それ以外のものはすべて無効なビルドファイルになります。
-
私のエディタがEditorConfigをネイティブにサポートしていない場合どうなりますか?
ほとんどの現代のエディタとIDEは、第一-partyサポート(JetBrains、Visual Studio、GitHubウェブ)または第一-partyプラグイン(VS Code、Sublime Text、Vim、Emacs)を持っています。プラグインがなければ、ファイルは無視され、誤ったまたはサポートされていないプロパティは静的無視され、不正なルールはビルドやエディタエラーを引き起こしません。
恵 スコアボードが到着しました!
スコアボード ゲームを追跡する楽しい方法です。すべてのデータはブラウザに保存されます。さらに多くの機能がまもなく登場します!
