Implement clean subcommand (#664)

* implement clean command

* remove unused includes

* Use concrete types instead of auto

Co-authored-by: Ken Matsui <26405363+ken-matsui@users.noreply.github.com>

* s/std::filesystem/fs/

Co-authored-by: Ken Matsui <26405363+ken-matsui@users.noreply.github.com>

include/poac/cmd.hpp

@@ -2,6 +2,7 @@
 #define POAC_CMD_HPP_
 
 #include "poac/cmd/build.hpp"
+#include "poac/cmd/clean.hpp"
 #include "poac/cmd/create.hpp"
 #include "poac/cmd/fmt.hpp"
 #include "poac/cmd/graph.hpp"

include/poac/cmd/clean.hpp

@@ -0,0 +1,30 @@
+#ifndef POAC_CMD_CLEAN_HPP_
+#define POAC_CMD_CLEAN_HPP_
+
+// external
+#include <structopt/app.hpp>
+
+// internal
+#include "poac/cmd/build.hpp"
+#include "poac/poac.hpp"
+
+namespace poac::cmd::clean {
+
+struct Options : structopt::sub_command {
+  /// Whether or not to clean release artifacts
+  Option<bool> release = false;
+  /// Clean artifacts of the specified profile
+  Option<String> profile;
+};
+
+[[nodiscard]] Result<void>
+clean(const Options& opts);
+
+[[nodiscard]] Result<void>
+exec(const Options& opts);
+
+} // namespace poac::cmd::clean
+
+STRUCTOPT(poac::cmd::clean::Options, release, profile);
+
+#endif // POAC_CMD_CLEAN_HPP_

lib/cmd/CMakeLists.txt

@@ -1,6 +1,7 @@
 add_poac_target(poac_cmd
     SOURCES
         build.cc
+        clean.cc
         create.cc
         fmt.cc
         graph.cc

lib/cmd/clean.cc

@@ -0,0 +1,44 @@
+// external
+#include <spdlog/spdlog.h> // NOLINT(build/include_order)
+
+// internal
+#include "poac/cmd/clean.hpp"
+#include "poac/config.hpp"
+#include "poac/data/manifest.hpp"
+#include "poac/util/validator.hpp"
+
+namespace poac::cmd::clean {
+
+[[nodiscard]] Result<void>
+clean(const Options& opts) {
+  const Option<String> profile =
+      Try(util::validator::valid_profile(opts.profile, opts.release)
+              .map_err(to_anyhow));
+  if (profile.has_value() && profile.value() != "debug"
+      && profile.value() != "release") {
+    return Err<build::UnsupportedProfile>(profile.value());
+  }
+
+  const Path path = profile.has_value()
+                        ? config::path::output_dir / profile.value()
+                        : config::path::output_dir;
+
+  spdlog::trace("Removing ./{}", path);
+
+  if (fs::exists(path)) {
+    log::status("Removing", fs::canonical(path).string());
+    fs::remove_all(path);
+  }
+
+  return Ok();
+}
+
+[[nodiscard]] Result<void>
+exec(const Options& opts) {
+  spdlog::trace("Checking if required config exists ...");
+  Try(util::validator::required_config_exists().map_err(to_anyhow));
+
+  return clean(opts);
+}
+
+} // namespace poac::cmd::clean

src/main.cc

@@ -35,6 +35,9 @@ struct Commands {
   /// Compile a local package and all of its dependencies
   cmd::build::Options build;
 
+  /// Remove the output directory
+  cmd::clean::Options clean;
+
   /// Create a new poac package at <package_name>
   cmd::create::Options create;
 
@@ -75,7 +78,9 @@ struct Commands {
   STRUCTOPT(Commands, verbose, quiet, color, __VA_ARGS__); \
   DECL_CMDS(__VA_ARGS__)
 
-structopt(build, create, fmt, graph, init, lint, login, publish, run, search);
+structopt(
+    build, clean, create, fmt, graph, init, lint, login, publish, run, search
+);
 
 inline String
 colorize_structopt_error(String s) {
@@ -134,6 +139,8 @@ exec(const structopt::app& app, const Commands& args) {
 
   if (args.build.has_value()) {
     return cmd::build::exec(args.build);
+  } else if (args.clean.has_value()) {
+    return cmd::clean::exec(args.clean);
   } else if (args.create.has_value()) {
     return cmd::create::exec(args.create);
   } else if (args.fmt.has_value()) {