feat(cli): add database storage status command

Author: GaspardKirira

include/vix/cli/commands/DbCommand.hpp

@@ -0,0 +1,53 @@
+/**
+ *
+ *  @file DbCommand.hpp
+ *  @author Gaspard Kirira
+ *
+ *  Copyright 2026, Gaspard Kirira.  All rights reserved.
+ *  https://github.com/vixcpp/vix
+ *  Use of this source code is governed by a MIT license
+ *  that can be found in the License file.
+ *
+ *  Vix.cpp
+ */
+#ifndef VIX_DB_COMMAND_HPP
+#define VIX_DB_COMMAND_HPP
+
+#include <string>
+#include <vector>
+
+namespace vix::commands
+{
+  /**
+   * @brief Command entry point for database and storage inspection.
+   */
+  struct DbCommand
+  {
+    /**
+     * @brief Run the db command.
+     *
+     * Supported forms:
+     *
+     * `vix db`
+     * `vix db status`
+     *
+     * Options:
+     *
+     * `--json`
+     * `--verbose`
+     *
+     * @param args Command arguments after `db`.
+     * @return Process exit code.
+     */
+    static int run(const std::vector<std::string> &args);
+
+    /**
+     * @brief Print db command help.
+     *
+     * @return Process exit code.
+     */
+    static int help();
+  };
+}
+
+#endif

include/vix/cli/commands/db/DbChecker.hpp

@@ -0,0 +1,35 @@
+/**
+ *
+ *  @file DbChecker.hpp
+ *  @author Gaspard Kirira
+ *
+ *  Copyright 2026, Gaspard Kirira.  All rights reserved.
+ *  https://github.com/vixcpp/vix
+ *  Use of this source code is governed by a MIT license
+ *  that can be found in the License file.
+ *
+ *  Vix.cpp
+ */
+#ifndef VIX_DB_CHECKER_HPP
+#define VIX_DB_CHECKER_HPP
+
+#include <vix/cli/commands/db/DbTypes.hpp>
+
+namespace vix::commands::db::checker
+{
+  /**
+   * @brief Inspect the current database storage state.
+   *
+   * This function checks the resolved database configuration and inspects
+   * the filesystem for the SQLite database file, WAL file, SHM file,
+   * storage directory, storage permissions, and migrations directory.
+   *
+   * It does not execute migrations and does not modify the database.
+   *
+   * @param cfg Effective database configuration.
+   * @return Database inspection result.
+   */
+  DbCheckResult check_status(const DbConfig &cfg);
+}
+
+#endif

include/vix/cli/commands/db/DbConfig.hpp

@@ -0,0 +1,70 @@
+/**
+ *
+ *  @file DbConfig.hpp
+ *  @author Gaspard Kirira
+ *
+ *  Copyright 2026, Gaspard Kirira.  All rights reserved.
+ *  https://github.com/vixcpp/vix
+ *  Use of this source code is governed by a MIT license
+ *  that can be found in the License file.
+ *
+ *  Vix.cpp
+ */
+#ifndef VIX_DB_CONFIG_HPP
+#define VIX_DB_CONFIG_HPP
+
+#include <vix/cli/commands/db/DbTypes.hpp>
+
+#include <optional>
+#include <string>
+
+namespace vix::commands::db
+{
+  /**
+   * @brief Read the current Vix project name.
+   *
+   * The project name is resolved from `vix.json` when available.
+   * If no project name is found, the implementation may fall back to
+   * the current directory name.
+   *
+   * @return The detected project name, or std::nullopt if no name can be resolved.
+   */
+  std::optional<std::string> read_project_name();
+
+  /**
+   * @brief Load database configuration from vix.json.
+   *
+   * The configuration is read from the `database` object when available.
+   *
+   * Supported keys:
+   * - `database.engine`
+   * - `database.sqlite.path`
+   * - `database.storage`
+   * - `database.migrations`
+   *
+   * Fallbacks:
+   * - engine defaults to SQLite
+   * - SQLite path defaults to `storage/<project>.db`
+   * - storage directory defaults to the database parent directory
+   * - migrations directory defaults to `migrations`
+   *
+   * @return Loaded database configuration.
+   */
+  DbConfig load_db_config();
+
+  /**
+   * @brief Apply command-line database options to the loaded config.
+   *
+   * This function currently keeps the configuration unchanged, but it exists
+   * to keep the db command architecture consistent with other Vix commands.
+   *
+   * @param cfg Loaded database configuration.
+   * @param options Runtime database options.
+   * @return Effective database configuration.
+   */
+  DbConfig apply_db_options(
+      DbConfig cfg,
+      const DbOptions &options);
+}
+
+#endif

include/vix/cli/commands/db/DbOutput.hpp

@@ -0,0 +1,96 @@
+/**
+ *
+ *  @file DbOutput.hpp
+ *  @author Gaspard Kirira
+ *
+ *  Copyright 2026, Gaspard Kirira.  All rights reserved.
+ *  https://github.com/vixcpp/vix
+ *  Use of this source code is governed by a MIT license
+ *  that can be found in the License file.
+ *
+ *  Vix.cpp
+ */
+#ifndef VIX_DB_OUTPUT_HPP
+#define VIX_DB_OUTPUT_HPP
+
+#include <vix/cli/commands/db/DbTypes.hpp>
+
+#include <iosfwd>
+#include <string>
+
+namespace vix::commands::db::output
+{
+  /**
+   * @brief Print the database status report.
+   *
+   * @param out Output stream.
+   * @param result Database inspection result.
+   * @param options Runtime database options.
+   */
+  void print_status(
+      std::ostream &out,
+      const DbCheckResult &result,
+      const DbOptions &options);
+
+  /**
+   * @brief Print the database status report as JSON.
+   *
+   * @param out Output stream.
+   * @param result Database inspection result.
+   */
+  void print_status_json(
+      std::ostream &out,
+      const DbCheckResult &result);
+
+  /**
+   * @brief Print the beginning of a database command step.
+   *
+   * @param out Output stream.
+   * @param label Step label.
+   */
+  void step(
+      std::ostream &out,
+      const std::string &label);
+
+  /**
+   * @brief Print a successful database message.
+   *
+   * @param out Output stream.
+   * @param message Message to print.
+   */
+  void ok(
+      std::ostream &out,
+      const std::string &message);
+
+  /**
+   * @brief Print a database warning message.
+   *
+   * @param out Output stream.
+   * @param message Message to print.
+   */
+  void warn(
+      std::ostream &out,
+      const std::string &message);
+
+  /**
+   * @brief Print a database error message.
+   *
+   * @param out Output stream.
+   * @param message Message to print.
+   */
+  void error(
+      std::ostream &out,
+      const std::string &message);
+
+  /**
+   * @brief Print a fix suggestion.
+   *
+   * @param out Output stream.
+   * @param message Fix suggestion.
+   */
+  void fix(
+      std::ostream &out,
+      const std::string &message);
+}
+
+#endif