katanaSpecYamlCode function

String katanaSpecYamlCode(bool showAllConfig)

Contents of katana_spec.yaml.

katana_spec.yamlの中身。

Implementation

String katanaSpecYamlCode(bool showAllConfig) => """
########################################################
# This is a configuration file for spec-driven development.
# By changing settings here, you can create the application's scaffold.
# The settings will be applied by running the command below. Generally, changes are not made to files that already exist.
# ```bash
# katana spec init
# ```
# Furthermore, the presence of this file will cause a spec file `xxx.spec.md` to be created when using the `katana code` command to generate files.
# This file will also not be overwritten if it already exists.
# スペック駆動開発用の設定ファイルです。
# ここの設定を変更することでアプリケーションの骨組み（Scaffold）を作成することができます。
# 下記コマンドを実行することで設定が反映されます。基本的にすでに作成済みのファイルには変更は加えられません。
# ```bash
# katana spec init
# ```
# また、このファイルが存在することで`katana code`コマンドでのファイル作成時にスペックファイル`xxx.spec.md`が作成されます。
# このファイルについてもすでに存在する場合は上書きされません。
########################################################

# Common Settings
# アプリのメタデータ
# アプリ名やアプリの概要、各種リンクなどの情報を記載します。
metadata:

  # Application Title (maximum 30 characters)
  # A title will be provided for each language code.
  # アプリケーションのタイトル（最大30文字）
  # 各言語コードに対してタイトルを記載します。
  title:
    en: Application
    ja: アプリケーション

  # Application Short Title (maximum 15 characters)
  # A short title will be provided for each language code.
  # アプリケーションの短いタイトル（最大15文字）
  # 各言語コードに対して短いタイトルを記載します。
  short_title:
    en: App
    ja: アプリ

  # Application Overview (maximum 30 characters)
  # A overview will be provided for each language code.
  # アプリケーションの概要（最大30文字）
  # 各言語コードに対して概要を記載します。
  overview:
    en: Application Overview
    ja: アプリケーションの概要

  # Application Details (maximum 3000 characters)
  # A description will be provided for each language code. Line breaks are also possible.
  # アプリケーションの詳細内容（最大3000文字）
  # 各言語コードに対して詳細内容を記載します。改行も可能です。
  description:
    en: |-
      Application Details (maximum 3000 characters)
      Line breaks are also possible.
    ja: |-
      アプリケーションの詳細内容（最大3000文字）
      改行も可能

  # Developer's name
  # 開発者の名前
  developer_name: mathru.net

  # Support Email
  # サポート用のメールアドレス
  support_email: [e-mail]

  # Link to the official developer website
  # デベロッパー公式サイトへのリンク
  developer_website: https://mathru.net

  # Link to the official app website
  # アプリ公式サイトへのリンク
  app_website: https://mathru.net/app/xxx/

  # Link to the support website
  # サポートサイトへのリンク
  support_website: https://mathru.net/contact

  # Link to the terms of use
  # 利用規約へのリンク
  terms_of_use: https://mathru.net/terms

  # Link to the privacy policy
  # プライバシーポリシーへのリンク
  privacy_policy: https://mathru.net/privacy

  # Link to the app store
  # アプリストアへのリンク
  app_store: https://apps.apple.com/app/id1234567890

  # Link to the google play store
  # Google Playストアへのリンク
  google_play: https://play.google.com/store/apps/details?id=net.mathru.xxx

# Set the app's theme.
# Set theme mode and various theme colors.
# アプリのテーマを設定します。
# テーマモードと各種テーマカラーを設定します。
theme:

  # Theme Mode
  # dark: Dark Mode
  # light: Light Mode
  # system: Follow system settings
  # テーマモード
  # dark: ダークモード
  # light: ライトモード
  # system: システム設定に従う
  mode: dark

  # Sets the main color.
  # Specify a color available in Dart's `Colors` class or in the format `#RRGGBB`.
  # メインカラーを設定します。
  # Dartの[Colors]クラスで指定可能な色か[#RRGGBB]の形式で指定します。
  primary_color: red

  # Sets the secondary color.
  # Specify a color available in Dart's `Colors` class or in the format `#RRGGBB`.
  # セカンダリカラーを設定します。
  # Dartの[Colors]クラスで指定可能な色か[#RRGGBB]の形式で指定します。
  secondary_color: orange

  # Sets the tertiary color.
  # Specify a color available in Dart's `Colors` class or in the format `#RRGGBB`.
  # サードリカラーを設定します。
  # Dartの[Colors]クラスで指定可能な色か[#RRGGBB]の形式で指定します。
  tertiary_color: green

# Displaying the Boot Page
# By setting `enable: true`, the Boot page will be displayed when the app starts.
# The app's logo will be shown, and app initialization processes can be performed during this time.
# User authentication information restoration will be performed.
# Bootページの表示
# これをenable: trueにすることでアプリ起動時のBootページが表示されます。
# アプリのロゴが表示され、この間にアプリの初期化処理を行うことができます。
# ユーザーの認証情報の復元処理が行われます。
boot:
  enable: false

  # Forced Update Check Feature
  # Enabling this will trigger a forced update check when the app launches.
  # If a forced update check is performed and the app version is outdated, an update dialog will be displayed.
  # The update dialog will display a platform-specific link button to the store.
  # If the update dialog is closed, the app will terminate.
  # 強制アップデートのチェック機能
  # これをtrueにすることでアプリ起動時に強制アップデートのチェックが行われます。
  # 強制アップデートのチェックが行われると、アプリのバージョンが古い場合にアップデートダイアログが表示されます。
  # アップデートダイアログにはプラットフォームごとのストアへのリンクボタンが表示されます。
  # アップデートダイアログを閉じると、アプリは終了します。
  force_update: false

# Enable login and authentication function
# Enabling this by setting `enable: true` will activate the login and authentication function.
# The login page and RedirectQuery will be created. By setting RedirectQuery to the PagePath of the initial launch page, unauthenticated users will be redirected to the login page.
# ログイン・認証機能を有効にする
# これをenable: trueにすることでログイン・認証機能が有効になります。
# ログインページおよびRedirectQueryが作成されます。RedirectQueryを初回起動ページのPagePathに設定することで未認証時にログインページにリダイレクトされます。
authentication:
  enable: false

  # Authentication Type
  # sns: SNS Authentication (Apple ID and Google account authentication)
  # 認証のタイプ
  # sns: SNS認証（AppleIDおよびGoogleアカウントの認証）
  type: sns

  # Enable Anonymous Authentication
  # Setting this to true enables anonymous authentication.
  # When anonymous authentication is enabled, users can authenticate by simply pressing a button on the login page.
  # However, features such as billing will be unavailable.
  # 匿名認証を有効にする
  # これをtrueにすることで匿名認証が有効になります。
  # 匿名認証が有効になると、ユーザーはログインページでボタンを押すだけで認証を行うことができます。
  # ただし課金等は使用不可となります。
  enable_anonymous: false

# Configuration for the index page displayed upon app launch. This page is always created.
# The created index page is registered as AppRoute's initial page.
# You can change the type of page to display by specifying the type.
# アプリ起動時に表示するインデックスページの設定。必ず作成されます。
# AppRouteの初期ページに作成されたインデックスページが登録されます。
# タイプを指定して表示するページの種類を変更することができます。
index:

  # Index Page Types
  # normal: A standard index page
  # navigation: An index page that displays a bottom navigation bar
  # tab: An index page that displays a tab view
  # navigation+tab: An index page that displays both a bottom navigation bar and a tab view
  # インデックスページのタイプ
  # normal: 通常のインデックスページ
  # navigation: ボトムナビゲーションバーを表示するタイプのインデックスページ
  # tab: タブビューを表示するタイプのインデックスページ
  # navigation+tab: ボトムナビゲーションバーとタブビューを表示するタイプのインデックスページ
  type: normal

  # Create a page for terms of service and obtain consent.
  # When this is set to true, a Terms of Service page will be created.
  # If the user has not yet agreed, they will be redirected to this page before the index page is displayed.
  # Once consent is given, a flag will be saved locally so that the user is not redirected on subsequent visits.
  # The Terms of Service content itself will be displayed within a WebView, showing the specified URL.
  # 利用規約用のページを作り同意をさせる
  # これがtrueになると利用規約用のページが作成され、同意していない場合はインデックスページ表示前にそこにリダイレクトされるようになります。
  # 同意した場合、ローカルにフラグを保存し次回以降は同意していない場合はリダイレクトされないようになります。
  # 利用規約自体はWebViewで利用規約のURLページが表示されます。
  agree_terms: false

  # Enable App Tutorial
  # Setting this to true will enable the app tutorial plugin and create a tutorial page.
  # If you have not viewed the tutorial, you will be redirected to it before the index page is displayed.
  # Once you have viewed the tutorial, a flag will be saved locally, and you will not be redirected to the tutorial again in subsequent sessions.
  # The tutorial content itself is currently empty, so please add content later.
  # アプリのチュートリアルを有効にします
  # これをtrueにするとアプリのチュートリアルプラグインが有効になり、チュートリアルページが作成されます。
  # チュートリアルを閲覧していない場合インデックスページ表示前にそこにリダイレクトされるようになります。
  # チュートリアルを閲覧した場合、ローカルにフラグを保存し次回以降はチュートリアルを閲覧していない場合はリダイレクトされないようになります。
  # チュートリアルの内容自体は空なので後々コンテンツを追加してください。
  tutorial: false

# アプリケーションのマイページを有効にする
# これをenable: trueにすることでマイページが有効になり作成されます。
# 認証が有効な場合はログアウトおよびアカウント削除が表示され、プロフィールが有効な場合はプロフィールの確認と設定が表示されます。
mypage:
  enable: true

  # Displaying Various Links
  # Set `enable: true` to enable the display of various links.
  # The various links include those to the developer's official website, the app's official website, terms of service, privacy policy, the App Store, and the Google Play Store.
  # 各種リンクの表示
  # これをenable: trueにすることで各種リンクの表示が有効になります。
  # 各種リンクにはデベロッパー公式サイト、アプリ公式サイト、利用規約、プライバシーポリシー、アプリストア、Google Playストアへのリンクが表示されます。
  enable_links: true

# Enable profile feature
# By setting `enable: true` for this, the profile feature will be enabled.
# A profile editing page and a profile confirmation page will be created.
# A profile image upload function will also be added. FileStorage will be required on the backend.
# プロフィール機能を有効にする
# これをenable: trueにすることでプロフィール機能が有効になります。
# プロフィール編集ページとプロフィールの確認ページが作成されます。
# プロフィール画像アップロード機能も追加されます。バックエンド側にFileStorageが必要になります。
profile:
  enable: false
""";