🐈

[GitHub Actions] ymlに対してのフォーマットがきかない

myabaou

2024/08/08に公開

事象内容

GitHub Actionsのymlをかいているときに
改行すると次の行の文頭がスペースではなくタブが入るようになっており、
タブだとSyntaxErrorになってしまうため
毎回タブをスペースに変換するという苦行が発生していました。

ただ以前、以下の記事を参考に変更し、問題なかったのになぜと思い調査しました。

設定内容

    "[yml]": {
        "editor.defaultFormatter": "redhat.vscode-yaml",
        "editor.insertSpaces": true,
        "editor.tabSize": 2,
        "editor.autoIndent": "advanced",
        "editor.formatOnSave": true
    },

原因

結論、ymlとGitHubActionsの設定は別々に設定する必要があるようです。

上記の記事にもあるとおりymlとcompose.ymlは別々に設定する必要があることから
以下のような設定が必要でした。

    "[github-actions-workflow]": {
        "editor.defaultFormatter": "redhat.vscode-yaml",
        "editor.insertSpaces": true,
        "editor.tabSize": 2,
        "editor.autoIndent": "advanced",
        "editor.formatOnSave": true
    },

上記の設定をすることでGithubActionsのymlに対してもスペースが入るようになりました。

ymlの設定とGitHubActionsの設定で
同一設定にも関わらず、別々に設定するのが冗長感があるのですが、
一旦これで動いているのでよしとしています。

まとめる設定できる方法を知っている人がいれば教えてください。。

rakiさんに教示いただきました！
合わせて記述する場合は以下のように記述することで設定可能です

    "[yml][github-actions-workflow]": {
        "editor.defaultFormatter": "redhat.vscode-yaml",
        "editor.insertSpaces": true,
        "editor.tabSize": 2,
        "editor.autoIndent": "advanced",
        "editor.formatOnSave": true
    },