hanami-cli 2.3.5 → 3.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fab5179afc7358ed28f6f47f4f446004b66e2235b3e4064760277375b67f793
-  data.tar.gz: 3ff9a30757fa557dd1a516a273a9a6618dd36a0b04318ab12603b01722bf2bd9
+  metadata.gz: 38ac5ab30e64a9471ad60f858b4d0131a1909871b422b13526f520169bddc0d5
+  data.tar.gz: 1714ec1452959aaebdb78f6252324fb90a0a19722b4a1a90fd5c21a8fe64dabd
 SHA512:
-  metadata.gz: c66556edf928261ce41bcd910a39cf11a373db8f0b618314b6535fe8d747377fbe65b3630b24b40dea5f49cb8ebd16d5a2551c0fe4d6ff145d04f7c91fd405ea
-  data.tar.gz: bdd6dfee069f0d5bb5883693d97a1c0bb4685023225ed5e6835446269db2578c79934add5b586319d21ad001c8981017d399b72230a6fad6ba987b6897710fbb
+  metadata.gz: 45a42295cf181115a14ad073a48cae13539966c5f85350a5faf4ca5a33935ebf3a804f41650a3cb43f72727d889037e330e41d27e143aca1e07bcad81325e2f6
+  data.tar.gz: e851af6f7c47ba168adab4e4f471b49a32d169ab4a17ed2861644577731b93b475569381b863f6a3fcfb1af0b337cba95ab1d07d42bc2ad8411881e4bfc0c3e5

data/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+and this project adheres to [Break Versioning](https://www.taoensso.com/break-versioning).
 
 ## [Unreleased]
 
@@ -11,8 +11,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- In `assets` commands, provide the node command with the assets config path _relative to app root_ instead of an absolute path (`config/assets.js` instead of `/full/path/to/config/assets.js`). This allows the assets commands to work in environments where Node.js is "sandboxed" in such a way that it doesn't share the same absolute path. (@haileys in #381).
-
 ### Deprecated
 
 ### Removed
@@ -21,7 +19,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Security
 
-[Unreleased]: https://github.com/hanami/cli/compare/v2.3.5...HEAD
+[Unreleased]: https://github.com/hanami/cli/compare/v3.0.0.rc1...HEAD
+
+## [3.0.0.rc1] - 2026-06-16
+
+### Added
+
+- Include `hanami-mailer` in the default `Gemfile`, include sample mailer env vars in `.env`, and generate a base `Mailer` class for the app and each slice (`app/mailer.rb` and `mailer.rb` in slices). Use `hanami new --skip-mailer` to opt out. (@timriley in #420, #425)
+- Add `generate mailer` command. (@timriley in #426)
+- Add `i18n` gem to the default `Gemfile`, and generate a placeholder `config/i18n/en.yml` for the app and each generated slice. (@timriley in #409)
+- Add `--name` option to `hanami new`, to specify a custom module namespace while using the positional argument as the directory path. For example, `hanami new my_bookshelf --name=bookshelf` creates the app in `my_bookshelf/` with `Bookshelf` as the module name. (@aaronmallen in #387)
+- Add `--test` option to `hanami new` to specify which test framework to use. Supports `rspec` (default) and `minitest`. (@timriley in #399)
+- Add `generate provider` command. (@timriley in #419)
+- Add `--template-engine` option to `hanami generate` and `hanami new` to specify which template engine should be used for generated template files. Supports `erb`, `haml` and `slim`. (@katafrakt in #280, #389, #390)
+- Add `--force` option to all generators (except migration), which will override existing files instead of exiting early (@katafrakt in #397)
+
+### Changed
+
+- In generated `Gemfile`, depend on dry-validation rather than hanami-validations. Hanami Validations will no longer be used; Hanami Action now checks for Dry Validation directly. (@timriley in #401)
+- In generated `package.json`, include `esbuild` as a direct dependency. `esbuild` is now a peer dependency of `hanami-assets`, which requires the app to depend on it directly. (@timriley in #428)
+- Check for the hanami-action gem rather than hanami-controller (now retired) across various commands. (@cllns in #402)
+- Include rouge gem in generated `Gemfile` to enable SQL syntax highlighting in logs. (@kyleplump in #405)
+- When `--gem-source=gem.coop` is used, Hanami and Dry gems are installed from their respective namespaces on gem.coop (@katafrakt in #424)
+- Require Puma 7.1 or later, and remove unneeded `preload_app!` in generated `config/puma.rb`. Preloading is now enabled by default in Puma's cluster mode. (@joshuay03 in #372)
+- In generated `.env`, include a link the guide explaining how these files are loaded. (@timriley in #425)
+- In generated files, update all guides.hanamirb.org links to hanakai.org. (@yosangwon in #407)
+- Require dry-cli 1.4 or later, allowing for simplified argument handling in hanami-rspec callback methods. (@timriley in #408)
+- Link to new hanakai.org site in generated `README.md`. (@katafrakt in #423)
+- Require Ruby 3.3 or newer.
+
+### Fixed
+
+- Skip generating duplicate routes when running `generate action`. (@sandbergja in #417)
+- Don't overwrite libpq ENV vars with empty strings derived from certain DATABASE_URLs. (@StantonMatt in #414)
+- Remove duplicate text in `middleware` and `routes` command usage output. (@katafrakt in #406
+
+[3.0.0.rc1]: https://github.com/hanami/cli/compare/v2.3.5...v3.0.0.rc1
 
 ## [2.3.5] - 2026-02-06
 
@@ -29,7 +62,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - In `assets` commands, provide the node command with the assets config path _relative to app root_ instead of an absolute path (`config/assets.js` instead of `/full/path/to/config/assets.js`). This allows the assets commands to work in environments where Node.js is "sandboxed" in such a way that it doesn't share the same absolute path. (@haileys in #381).
 
-[2.3.4]: https://github.com/hanami/cli/compare/v2.3.4...v2.3.5
+[2.3.5]: https://github.com/hanami/cli/compare/v2.3.4...v2.3.5
 
 ## [2.3.4] - 2026-01-23
 

data/README.md

@@ -1,10 +1,15 @@
 <!--- This file is synced from hanakai-rb/repo-sync -->
 
-[rubygem]: https://rubygems.org/gems/hanami-cli
 [actions]: https://github.com/hanami/hanami-cli/actions
+[chat]: https://discord.gg/naQApPAsZB
+[forum]: https://discourse.hanamirb.org
+[rubygem]: https://rubygems.org/gems/hanami-cli
 
 # Hanami CLI [![Gem Version](https://badge.fury.io/rb/hanami-cli.svg)][rubygem] [![CI Status](https://github.com/hanami/hanami-cli/workflows/CI/badge.svg)][actions]
 
+[![Forum](https://img.shields.io/badge/Forum-dc360f?logo=discourse&logoColor=white)][forum]
+[![Chat](https://img.shields.io/badge/Chat-717cf8?logo=discord&logoColor=white)][chat]
+
 This library contains all of the CLI commands for [full-stack Hanami applications](`https://github.com/hanami/hanami`).
 
 **NOTE**: For versions 0.4 and below, there was a general purpose CLI utility library with this name.

data/hanami-cli.gemspec

@@ -23,16 +23,15 @@ Gem::Specification.new do |spec|
 
   spec.extra_rdoc_files = ["README.md", "CHANGELOG.md", "LICENSE"]
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["changelog_uri"]     = "https://github.com/hanami/hanami-cli/blob/main/CHANGELOG.md"
   spec.metadata["source_code_uri"]   = "https://github.com/hanami/hanami-cli"
   spec.metadata["bug_tracker_uri"]   = "https://github.com/hanami/hanami-cli/issues"
   spec.metadata["funding_uri"]       = "https://github.com/sponsors/hanami"
 
-  spec.required_ruby_version = ">= 3.2"
+  spec.required_ruby_version = ">= 3.3"
 
   spec.add_runtime_dependency "bundler", ">= 2.1"
-  spec.add_runtime_dependency "dry-cli", "~> 1.0", ">= 1.1.0"
+  spec.add_runtime_dependency "dry-cli", "~> 1.0", ">= 1.4.0"
   spec.add_runtime_dependency "dry-files", "~> 1.0", ">= 1.0.2"
   spec.add_runtime_dependency "dry-inflector", "~> 1.0"
   spec.add_runtime_dependency "irb"

data/lib/hanami/cli/commands/app/db/migrate.rb

@@ -12,10 +12,10 @@ module Hanami
             option :gateway, required: false, desc: "Use database for gateway"
             option :target, desc: "Target migration number", aliases: ["-t"]
             option :dump,
-                   required: false,
-                   type: :boolean,
-                   default: true,
-                   desc: "Dump the database structure after migrating"
+              required: false,
+              type: :boolean,
+              default: true,
+              desc: "Dump the database structure after migrating"
 
             def call(target: nil, app: false, slice: nil, gateway: nil, dump: true, command_exit: method(:exit), **)
               databases(app: app, slice: slice, gateway: gateway).each do |database|

data/lib/hanami/cli/commands/app/db/utils/postgres.rb

@@ -86,12 +86,10 @@ module Hanami
                 Shellwords.escape(name)
               end
 
-              def cli_env_vars # rubocop:disable Metrics/AbcSize
-                @cli_env_vars ||= {}.tap do |vars|
-                  vars["PGHOST"] = database_uri.host.to_s if database_uri.host
-                  vars["PGPORT"] = database_uri.port.to_s if database_uri.port
-                  vars["PGUSER"] = database_uri.user.to_s if database_uri.user
-                  vars["PGPASSWORD"] = database_uri.password.to_s if database_uri.password
+              def cli_env_vars
+                @cli_env_vars ||= %i[host port user password].each_with_object({}) do |field, vars|
+                  value = database_uri.public_send(field).to_s
+                  vars["PG#{field}".upcase] = value unless value.empty?
                 end
               end
             end

data/lib/hanami/cli/commands/app/generate/action.rb

@@ -28,6 +28,9 @@ module Hanami
             DEFAULT_SKIP_ROUTE = false
             private_constant :DEFAULT_SKIP_ROUTE
 
+            DEFAULT_TEMPLATE_ENGINE = "erb"
+            private_constant :DEFAULT_TEMPLATE_ENGINE
+
             argument :name, required: true, desc: "Action name"
 
             option :url, as: :url_path, required: false, type: :string, desc: "Action URL path"
@@ -56,6 +59,12 @@ module Hanami
               desc: "Skip route generation"
 
             option :slice, required: false, desc: "Slice name"
+            option :template_engine, required: false,
+              values: %w[erb haml slim],
+              desc: "Template engine to use"
+
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
 
             # option :format, required: false, type: :string, default: DEFAULT_FORMAT, desc: "Template format"
 
@@ -85,22 +94,37 @@ module Hanami
               http_method: nil,
               skip_view: DEFAULT_SKIP_VIEW,
               skip_route: DEFAULT_SKIP_ROUTE,
-              skip_tests: DEFAULT_SKIP_TESTS
+              skip_tests: DEFAULT_SKIP_TESTS,
+              template_engine: nil,
+              force: false,
+              **opts
             )
               name = Naming.new(inflector:).action_name(name)
 
               raise InvalidActionNameError.new(name) unless name.include?(".")
 
               super(
-                name: name,
-                slice: slice,
-                url_path: url_path,
-                skip_route: skip_route,
-                http_method: http_method,
+                name:,
+                slice:,
+                url_path:,
+                skip_route:,
+                http_method:,
                 skip_view: skip_view || !Hanami.bundled?("hanami-view"),
-                skip_tests: skip_tests
+                skip_tests:,
+                template_engine: template_engine || default_template_engine,
+                force:
               )
             end
+
+            private
+
+            def default_template_engine
+              if Hanami.bundled?("hanami-view") && app.config.views.respond_to?(:default_template_engine)
+                app.config.views.default_template_engine
+              else
+                DEFAULT_TEMPLATE_ENGINE
+              end
+            end
           end
         end
       end

data/lib/hanami/cli/commands/app/generate/component.rb

@@ -13,6 +13,8 @@ module Hanami
           # @since 2.2.0
           class Component < Command
             argument :name, required: true, desc: "Component name"
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
 
             example [
               %(isbn_decoder               (MyApp::IsbnDecoder)),

data/lib/hanami/cli/commands/app/generate/mailer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @api private
+          class Mailer < Command
+            DEFAULT_TEMPLATE_ENGINE = "erb"
+
+            argument :name, required: true, desc: "Mailer name"
+
+            option :template_engine, required: false,
+              values: %w[erb haml slim],
+              desc: "Template engine to use (default: set in app config or erb)"
+
+            option :skip_tests, required: false, type: :flag, default: false,
+              desc: "Skip test generation"
+
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
+
+            example [
+              %(welcome               (MyApp::Mailers::Welcome)),
+              %(welcome --slice=admin (Admin::Mailers::Welcome))
+            ]
+
+            def generator_class
+              Generators::App::Mailer
+            end
+
+            def call(template_engine: nil, **opts)
+              template_engine ||= default_template_engine
+              super(template_engine:, **opts)
+            end
+
+            private
+
+            def default_template_engine
+              if Hanami.bundled?("hanami-view") && app.config.views.respond_to?(:default_template_engine)
+                app.config.views.default_template_engine
+              else
+                DEFAULT_TEMPLATE_ENGINE
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/generate/operation.rb

@@ -10,6 +10,12 @@ module Hanami
           class Operation < Command
             argument :name, required: true, desc: "Operation name"
 
+            option :skip_tests, required: false, type: :flag, default: false,
+              desc: "Skip test generation"
+
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
+
             example [
               %(books.add               (MyApp::Books::Add)),
               %(books.add --slice=admin (Admin::Books::Add))

data/lib/hanami/cli/commands/app/generate/part.rb

@@ -12,18 +12,14 @@ module Hanami
           # @since 2.1.0
           # @api private
           class Part < Command
-            DEFAULT_SKIP_TESTS = false
-            private_constant :DEFAULT_SKIP_TESTS
-
             argument :name, required: true, desc: "Part name"
 
-            option \
-              :skip_tests,
-              required: false,
-              type: :flag,
-              default: DEFAULT_SKIP_TESTS,
+            option :skip_tests, required: false, type: :flag, default: false,
               desc: "Skip test generation"
 
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
+
             example [
               %(book               (MyApp::Views::Parts::Book)),
               %(book --slice=admin (Admin::Views::Parts::Book))

data/lib/hanami/cli/commands/app/generate/provider.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Generate
+          # @api private
+          class Provider < Command
+            argument :name, required: true, desc: "Provider name"
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
+
+            example [
+              %(mailer                (config/providers/mailer.rb)),
+              %(mailer --slice=admin  (slices/admin/config/providers/mailer.rb))
+            ]
+
+            def generator_class
+              Generators::App::Provider
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/generate/relation.rb

@@ -10,6 +10,8 @@ module Hanami
           class Relation < Command
             argument :name, required: true, desc: "Relation name"
             option :gateway, desc: "Generate relation for gateway"
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
 
             example [
               %(books               (MyApp::Relation::Book)),
@@ -24,20 +26,22 @@ module Hanami
               Generators::App::Relation
             end
 
-            def call(name:, slice: nil, gateway: nil)
+            def call(name:, slice: nil, gateway: nil, force: false)
               if slice
                 generator.call(
                   key: name,
                   namespace: slice,
                   base_path: fs.join("slices", inflector.underscore(slice)),
-                  gateway: gateway
+                  gateway: gateway,
+                  force: force
                 )
               else
                 generator.call(
                   key: name,
                   namespace: app.namespace,
                   base_path: "app",
-                  gateway: gateway
+                  gateway: gateway,
+                  force: force
                 )
               end
             end

data/lib/hanami/cli/commands/app/generate/repo.rb

@@ -15,6 +15,8 @@ module Hanami
           # @api private
           class Repo < Command
             argument :name, required: true, desc: "Repo name"
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
 
             example [
               %(books               (MyApp::Repos::BooksRepo)),
@@ -30,7 +32,7 @@ module Hanami
 
             # @since 2.2.0
             # @api private
-            def call(name:, **opts)
+            def call(name:, force: false, **opts)
               name = "#{inflector.singularize(name)}_repo" unless name.end_with?("_repo")
               super
             end

data/lib/hanami/cli/commands/app/generate/slice.rb

@@ -29,17 +29,22 @@ module Hanami
             # @since 2.2.0
             # @api private
             option :skip_db,
-                   type: :flag,
-                   required: false,
-                   default: SKIP_DB_DEFAULT,
-                   desc: "Skip database"
+              type: :flag,
+              required: false,
+              default: SKIP_DB_DEFAULT,
+              desc: "Skip database"
             # @since 2.2.0
             # @api private
             option :skip_route,
-                   type: :flag,
-                   required: false,
-                   default: DEFAULT_SKIP_ROUTE,
-                   desc: "Skip route generation"
+              type: :flag,
+              required: false,
+              default: DEFAULT_SKIP_ROUTE,
+              desc: "Skip route generation"
+
+            # @since 2.2.0
+            # @api private
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
 
             example [
               "admin          # Admin slice (/admin URL prefix)",
@@ -63,7 +68,8 @@ module Hanami
               name:,
               url: nil,
               skip_db: SKIP_DB_DEFAULT,
-              skip_route: DEFAULT_SKIP_ROUTE
+              skip_route: DEFAULT_SKIP_ROUTE,
+              force: false
             )
               require "hanami/setup"
 
@@ -71,7 +77,7 @@ module Hanami
               name = inflector.underscore(Shellwords.shellescape(name))
               url = sanitize_url_prefix(name, url)
 
-              generator.call(app, name, url, skip_db: skip_db, skip_route: skip_route)
+              generator.call(app, name, url, skip_db: skip_db, skip_route: skip_route, force: force)
             end
 
             private

data/lib/hanami/cli/commands/app/generate/struct.rb

@@ -9,6 +9,8 @@ module Hanami
           # @api private
           class Struct < Command
             argument :name, required: true, desc: "Struct name"
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
 
             example [
               %(book                (MyApp::Structs::Book)),

data/lib/hanami/cli/commands/app/generate/view.rb

@@ -15,9 +15,16 @@ module Hanami
           # @api private
           class View < Command
             # TODO: make format configurable
-            # TODO: make engine configurable
+
+            DEFAULT_TEMPLATE_ENGINE = "erb"
+            private_constant :DEFAULT_TEMPLATE_ENGINE
 
             argument :name, required: true, desc: "View name"
+            option :template_engine, required: false,
+              values: %w[erb haml slim],
+              desc: "Template engine to use (default: set in app config or erb)"
+            option :force, required: false, type: :flag, default: false,
+              desc: "Overwrite existing files during generation"
 
             example [
               %(books.index               (MyApp::Actions::Books::Index)),
@@ -29,6 +36,22 @@ module Hanami
             def generator_class
               Generators::App::View
             end
+
+            # @since 2.0.0
+            # @api private
+            def call(name:, slice: nil, template_engine: nil, force: false, **opts)
+              super(name:, slice:, template_engine: template_engine || default_template_engine, force: force)
+            end
+
+            private
+
+            def default_template_engine
+              if Hanami.bundled?("hanami-view") && app.config.views.respond_to?(:default_template_engine)
+                app.config.views.default_template_engine
+              else
+                DEFAULT_TEMPLATE_ENGINE
+              end
+            end
           end
         end
       end

data/lib/hanami/cli/commands/app/middleware.rb

@@ -34,11 +34,11 @@ module Hanami
           private_constant :DEFAULT_WITH_ARGUMENTS
 
           option :with_arguments, default: DEFAULT_WITH_ARGUMENTS, required: false,
-                                  desc: "Include inspected arguments", type: :flag
+            desc: "Include inspected arguments", type: :flag
 
           example [
-            "middleware                  # Print app Rack middleware stack",
-            "middleware --with-arguments # Print app Rack middleware stack, including initialize arguments"
+            "                 # Print app Rack middleware stack",
+            "--with-arguments # Print app Rack middleware stack, including initialize arguments"
           ]
 
           # @since 2.0.0

data/lib/hanami/cli/commands/app/routes.rb

@@ -40,13 +40,13 @@ module Hanami
           desc "Print app routes"
 
           option :format,
-                 default: DEFAULT_FORMAT,
-                 required: false,
-                 desc: "Output format"
+            default: DEFAULT_FORMAT,
+            required: false,
+            desc: "Output format"
 
           example [
-            "routes              # Print app routes",
-            "routes --format=csv # Print app routes, using CSV format"
+            "             # Print app routes",
+            "--format=csv # Print app routes, using CSV format"
           ]
 
           # @since 2.0.0

data/lib/hanami/cli/commands/app/server.rb

@@ -36,9 +36,9 @@ module Hanami
           desc "Start Hanami app server"
 
           option :host, default: nil, required: false,
-                        desc: "The host address to bind to (falls back to the rack handler)"
+            desc: "The host address to bind to (falls back to the rack handler)"
           option :port, default: Hanami::Port::DEFAULT, required: false,
-                        desc: "The port to run the server on (falls back to the rack handler)"
+            desc: "The port to run the server on (falls back to the rack handler)"
           option :config, default: DEFAULT_CONFIG_PATH, required: false, desc: "Rack configuration file"
           option :debug, default: false, required: false, desc: "Turn on/off debug output", type: :flag
           option :warn, default: false, required: false, desc: "Turn on/off warnings", type: :flag

data/lib/hanami/cli/commands/app.rb

@@ -45,8 +45,9 @@ module Hanami
             register "generate", aliases: ["g"] do |prefix|
               prefix.register "slice", Generate::Slice
               prefix.register "component", Generate::Component
+              prefix.register "provider", Generate::Provider
 
-              if Hanami.bundled?("hanami-controller")
+              if Hanami.bundled?("hanami-action")
                 prefix.register "action", Generate::Action
               end
 
@@ -59,6 +60,10 @@ module Hanami
                 prefix.register "part", Generate::Part
               end
 
+              if Hanami.bundled?("hanami-mailer")
+                prefix.register "mailer", Generate::Mailer
+              end
+
               if Hanami.bundled?("hanami-db")
                 prefix.register "migration", Generate::Migration
                 prefix.register "relation", Generate::Relation