コンテンツにスキップ

コーディング規約⚓︎

AlesInfiny Maris OSS Edition （以下 AlesInfiny Maris ）では、一般に広く採用されている規約に準拠し、必要に応じて最低限のカスタムルールを加えることを基本方針とします。 ゼロから独自規約を作成することは、以下のような問題があるため推奨しません。

  • 規約作成にかかる負荷が大きい
  • 必要な規約の漏れが発生しやすい
  • 機械的なチェックの仕組みを作りにくい

AlesInfiny Maris で採用している規約⚓︎

.NET アプリケーション、 Vue.js アプリケーションそれぞれで以下の内容を基本のコーディング規約としています。

  • .NET アプリケーション

  • Vue.js アプリケーション

    • Vue.js スタイルガイド

      Vue.js が公式に提供するスタイルガイドです。 TypeScript に対する規約ではカバーできない Vue 固有の記法について、エラーの発生やアンチパターンを避けるための規約を優先度別に定めています。 Vue.js ではこれらの規約への違反を検出するための ESLint のプラグイン eslint-plugin-vue を提供しており、 Bundle Configurations としていくつかの定義済み構成が公開されています。 AlesInfiny Maris では、一般的に必須と考えられるルールに Vue.js コミュニティーの慣例に従ったルールを加えた構成である flat/recommended を使用します。

    • typescript-eslint の推奨構成

      typescript-eslint プロジェクトが提供する推奨設定です。 AlesInfiny Maris では、公開されている推奨構成のうち、一般的に推奨されるルールに TypeScript の型情報を使用するルールを加えた recommended-type-checked を使用します。

    • CSS specifications

      W3C が策定する CSS の標準仕様です。 Stylelint では、この標準仕様に従うための設定が公開されています。

上記のコーディング規約は静的コード解析ツールによって自動的にチェックできるようにします。 バックエンド側では Visual Studio でのコーディング中やビルド時に .NET コンパイラーによる自動チェックが行われます。 フロントエンド側では Prettier 、 ESLint 、 Stylelint を利用してコーディング規約の自動チェックを行っています。 コーディング規約の内容および静的コード解析ツールの詳しい設定方法については、以下のページとサンプルアプリの実装を確認してください。