no4-co-jp / no4-official-site

0 stars 0 forks source link

#5 Code Formatter, Linter導入/設定 #14

Closed runa-sakagoshi0830 closed 1 year ago

runa-sakagoshi0830 commented 1 year ago

Closes #5

■.editorconfigの作成 以下サイトを参考にして作成。 Projects Using EditorConfig

■prettierの導入 公式サイトから変更したいものだけ記載。 Options

■ eslintの導入 以下サイトを参考 Vite + Svelte + TypeScript + ESLint + Prettier の環境構築 TypeScriptプロジェクトに3分でESLint/Prettierを入れる(2022年) Astro v2の環境でESLint・Stylelintの導入を行う .eslintrc.cjsについてはeslint --initを実行して作成。(各スタイルガイドも調べたが不要だった。。)

また以下をルールとして追加。

■stylelintの導入 以下サイトを参考 Vite + Svelte + Eslint(airbnb) + Prettier + Stylelint + Storybook の開発環境構築メモ stylelintはv15以上で結構な数のルールが非推奨になり、stylelint-config-standardの導入が推奨されている。 (Migrating to 15.0.0)  → stylelint-config-prettierの導入は不要になった ※stylelint-config-standardの中身も一通りサッと確認して、そこまでしなくても良いかな?と思いつつ、既存のプロジェクトというわけでもないのでひとまずあまり触らずです。

■configの補完 https://github.com/no4-co-jp/no4-official-site/issues/5#issuecomment-1445136576 上記対応

■vscodeの設定(他のエディタ使ってる人すいません。。) 保存した際に諸々のルールが適用されるように、vscodeの設定にいれてます。(.vscode/settings.json) 様々な拡張機能については各自でインストールをお願いします。 (ESLint, prettier, stylelintなどなど。。) package.jsonのscriptに諸々追加はできてないです。

■その他 あまり知識がなく、色々調べながら設定していったので、認識が間違ってる・好みが合わない等の指摘お願いします。。

runa-sakagoshi0830 commented 1 year ago

@yuki-ohnaka-no4

.prettierignoreファイルは不要そうです?

.eslintignoreはつくらなくて大丈夫そうですか?

上記を除きpush済みです。

runa-sakagoshi0830 commented 1 year ago

@yuki-ohnaka-no4 遅くなり申し訳ないです。。 https://github.com/no4-co-jp/no4-official-site/pull/14#issuecomment-1460163113 上記追加しました。

https://github.com/no4-co-jp/no4-official-site/pull/14#discussion_r1133079165 上記について、vscodeでは補完されてしまっていましたが、1行空けてはいけない気がしますので修正しました。 (多分当たり前過ぎて「空けてはいけない」のような記述は見つかりませんでしたが、JSDocのリファレンスを見る限り空けずに記載が正しいです。失礼しました。)