rubysmith 7.3.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1529b428758e620a07651f58648e9347d6285ae658c5ba7f4e60ec445958b279
-  data.tar.gz: 7efa1cd58738e11138bc31209ee0b6a2b0ab30a710f54016b8ad3c17b8f6a993
+  metadata.gz: 852415a9cd9eba19692d24330fb641cf6d19f039dbe1b90709e6c88881b844cf
+  data.tar.gz: 2d398b6d843ea06f0f9a6896b26eab8cc18caadcd2f6cc616a10609bbfaef907
 SHA512:
-  metadata.gz: bb59f4e7490b4e8298a9c14d31923f8e46d1f1ed28cc2ae0f6778d8269d4ee08eab8c304aef3c276439eb447ae5fb43d9b63cf6f9239d64a6e17bfaf70f81a7c
-  data.tar.gz: 51d8e56f5b799df3b03a9a20c8331004d5f44f0bbdf4371c8299f8a8f75a17719c74c11d2d9d4bc9159cd535f0c3bf26c86e6c1d93ece452a18d149490f490c6
+  metadata.gz: 749891117987d624f28fef062d8b319df088a20c592b3fb17dd7ccc4ed1508a9841b7ca827c7073847bf8871a848c18feea57c364669e1240baf9f192c2c9c51
+  data.tar.gz: 5f9049b2774b91a3faab55f12fcd1fc1332425d514d8508f614ee18f8944fcdfc5dc2972ab737815b299d157159409329efe47d3b1ece6c87de7312cf0540cca

data/README.adoc

@@ -4,9 +4,12 @@
 
 :bundler_inline_link: link:https://alchemists.io/articles/ruby_bundler_inline[Bundler Inline]
 :development_containers_link: link:https://containers.dev[Development Containers]
+:docker_alpine_ruby_link: link:https://alchemists.io/projects/docker-alpine-ruby[Docker Alpine Ruby]
 :docker_link: link:https://www.docker.com[Docker]
 :gemsmith_link: link:https://alchemists.io/projects/gemsmith[Gemsmith]
+:runcom_link: link:https://alchemists.io/projects/runcom[Runcom]
 :string_formats_link: link:https://docs.ruby-lang.org/en/3.3/format_specifications_rdoc.html[String Formats]
+:xdg_link: link:https://alchemists.io/projects/xdg[XDG]
 
 = Rubysmith
 
@@ -103,19 +106,16 @@ options, you can use `--no-*` prefixes. Example:
 rubysmith build --name demo --no-debug --no-reek
 ----
 
-With the above example, both Debug and Reek support would have been disabled when building the
-`demo` project. Taking this a step further, you can also use the `--min` option to generate a
-project with bare minimum of options. Example:
+With the above example, both Debug and Reek support would have been disabled when building the `demo` project. Taking this a step further, you can also use the `--min` option to generate a project with bare minimum of options. Example:
 
 [source,bash]
 ----
 rubysmith build --name demo --min
 ----
 
-The above is essentially the same as building with _all_ options disabled. This is handy in situations where you need to quickly script something up for sharing with others yet still want to avoid using a {bundler_inline_link} script so gem dependencies are not installed each time the code is run.
+The above is the same as building with _all options disabled_. This is handy in situations where you need to quickly script something up for sharing with others yet still want to avoid using a {bundler_inline_link} script so gem dependencies are not installed each time the code is run.
 
-As shown earlier, you can combine options but be aware that order matters. Take the following, for
-example, where both minimum and maximum options are used in conjunction with other options:
+As shown earlier, you can combine options but be aware that order matters. Take the following, for example, where both minimum and maximum options are used in conjunction with other options:
 
 [source,bash]
 ----
@@ -123,15 +123,9 @@ rubysmith build --name demo --min --zeitwerk
 rubysmith build --name demo --max --no-debug
 ----
 
-With the above examples, the first line will _disable_ all options except Zeitwerk while the second
-line will _enable_ all options except Debug. This can be a handy way to build a new project with all
-options either disabled or enabled with only a few select options modified. To have specific options
-enabled/disabled _every time_ you build a new Ruby project, you can edit your global configuration
-for making these settings permanent (see below for details).
+With the above examples, the first line will _disable all options_ except Zeitwerk while the second line will _enable all options_ except Debug. This can be a handy way to build a new project with all options either disabled or enabled with only a few select options modified. To have specific options enabled/disabled _every time_, you can edit your global configuration for making these settings permanent (see below for details).
 
-There is a lot of flexibility when building a new project through the various build options. I'll
-walk you through each so you can better understand why you'd want to enable or disable any one of
-them.
+There is a lot of flexibility when building a new project through the various build options. I'll walk you through each so you can better understand why you'd want to enable or disable them.
 
 ===== Amazing Print
 
@@ -150,44 +144,66 @@ link:https://github.com/Shopify/bootsnap[Bootsnap] gem for improved performance.
 The `--caliber` option allows you to build your project with the
 link:https://alchemists.io/projects/caliber[Caliber] gem so you have an immediate working -- and
 high quality -- link:https://docs.rubocop.org/rubocop[RuboCop] configuration. Read the Caliber
-documentation for further customization.
+documentation for further customization. This adds the following files when enabled:
+
+....
+├── bin
+│  ├── rubocop
+├── .config
+│  └── rubocop
+│     └── config.yml
+....
 
 ===== Circle CI
 
 The `--circle_ci` option allows you to build your project with link:https://circleci.com[Circle CI]
-configured so you can get your project building as quickly as possible.
+configured so you can get your project building as quickly as possible. This adds the following file when enabled:
+
+....
+├── .circleci
+│  └── config.yml
+....
 
 ===== Citation
 
 The `--citation` option allows you to add a link:https://citation-file-format.github.io[citation]
 file to your project so you can help the research community cite your work in their studies if your
-project is used.
+project is used. This adds the following file when enabled:
+
+....
+├── CITATION.cff
+....
 
 ===== Community
 
 The `--community` option allows you to link to your open source community, organization, or group
-chat to help with community engagement of your work.
+chat to help with community engagement of your work. The link is added to the `README` file when enabled.
 
 ===== Code of Conduct
 
 The `--conduct` option allows you to link to your link:https://www.contributor-covenant.org[Code of
 Conduct] to encourage good community participation. Regardless of whether you have a community or
-not, the code of conduct is good to encourage in general.
+not, the code of conduct is good to encourage in general. The link is added to the `README` file when enabled.
 
 ===== Console
 
 The `--console` option allows you to add a `console` script for local development. So instead of
 typing `irb`, you can type `bin/console` and get an IRB session with all of your project's code
-loaded.
+loaded. This adds the following file when enabled:
+
+....
+├── bin
+│  ├── console
+....
 
 ===== Contributions
 
 The `--contributions` option allows you to link to contributing documentation so people know to
-contribute back to your work.
+contribute back to your work. The link is added to the `README` file when enabled.
 
 ===== Developer Certificate of Origin
 
-The `--dcoo` option allows to you add link:https://developercertificate.org[Developer Certificate of Origin] documentation so all contributors are aware of how their contributions are applied in terms of ownership, copyright, and licensing.
+The `--dcoo` option allows to you add link:https://developercertificate.org[Developer Certificate of Origin] documentation so all contributors are aware of how their contributions are applied in terms of ownership, copyright, and licensing. The link is added to the `README` file when enabled.
 
 ℹ️ This is disabled by default but will be enabled by default in the next major version.
 
@@ -199,17 +215,41 @@ much more.
 
 ===== Docker
 
-The `--docker` option allows you add {docker_link} to your project so you can build and deploy to production.
+The `--docker` option allows you add {docker_link} to your project so you can build and deploy a production image of your software. When enabled, these files will appear in your project:
+
+....
+├── bin
+│  ├── docker
+│  │  ├── build       # Use to build your production image for local use.
+│  │  ├── console     # Use to interact with your production image.
+│  │  └── entrypoint  # Conditionally enables jemalloc support.
+├── .dockerignore     # Defines the files/folders Docker should ignore.
+├── Dockerfile        # Defines how to build your production image.
+....
 
 ===== Development Containers
 
-The `--devcontainer` option allows you add {development_containers_link} support to your project so you can develop locally by running your project within a {docker_link} container.
+The `--devcontainer` option allows you add {development_containers_link} support to your project so you can develop locally by running your project within a {docker_link} container. When enabled, these files will be added to your project:
+
+....
+├── .devcontainer
+│  ├── compose.yaml       # Your Docker Compose configuration.
+│  ├── devcontainer.json  # Your Developer Container configuration.
+│  └── Dockerfile         # The steps for building your development environment.
+....
+
+ℹ️ The `Dockerfile` uses the {docker_alpine_ruby_link} base image so you have a small but functional image. This base image can be easily be swapped out with a base image you prefer.
 
 ===== Funding
 
 The `--funding` option allows you add a link:https://github.com[GitHub] funding configuration to
 your project so you can attract link:https://docs.github.com/en/sponsors[sponsors]. This option
-doesn't require use of the `--git_hub` option but is encouraged.
+doesn't require use of the `--git_hub` option but is encouraged. This adds the following file when enabled:
+
+....
+├── .github
+│  ├── FUNDING.yml
+....
 
 ===== Git
 
@@ -218,11 +258,23 @@ The `--git` option allows you add link:https://git-scm.com[Git] repository suppo
 ===== GitHub
 
 The `--git_hub` option allows you add link:https://github.com[GitHub] templates to your project for
-issues and pull requests.
+issues and pull requests. This adds the following fhile when enabled:
+
+....
+├── .github
+│  ├── ISSUE_TEMPLATE.md
+│  └── PULL_REQUEST_TEMPLATE.md
+....
 
 ===== GitHub CI
 
-The `--git_hub_ci` option allows you to build your project with link:https://docs.github.com/en/actions[GitHub Actions] configured so you can get your project building as quickly as possible.
+The `--git_hub_ci` option allows you to build your project with link:https://docs.github.com/en/actions[GitHub Actions] configured so you can get your project building as quickly as possible. This adds the following file when enabled:
+
+....
+├── .github
+│  ├── workflows
+│  │  └── ci.yml
+....
 
 ===== Git Lint
 
@@ -247,17 +299,23 @@ The `--license` option ensures you build your project with a license.
 
 ===== Maximum
 
-The `--max` option allows you to build your project with _all_ options _enabled_. This is a quick way
-to build a new project with all options enabled without having to pick and choose.
+The `--max` option allows you to build your project with _all options enabled_. This is a quick way
+to build a new project without having to pick and choose.
 
 ===== Minimum
 
-The `--min` option allows you to build your project with _all_ options _disabled_. This is a quick way to build a new project with the bare minimum of support which is a one step above reaching for a {bundler_inline_link} script.
+The `--min` option allows you to build your project with _all options disabled_. This is a quick way to build a new project with the bare minimum of support which is a one step above reaching for a {bundler_inline_link} script.
 
 ===== Rake
 
 The `--rake` option allows you to add the link:https://github.com/ruby/rake[Rake] gem for quickly
-crafting build scripts.
+crafting build scripts. This adds the following files to your project:
+
+....
+├── bin
+│  ├── rake
+├── Rakefile
+....
 
 ===== Readme
 
@@ -266,7 +324,7 @@ The `--readme` option allows you to add README documentation to your project.
 ===== Reek
 
 The `--reek` option allows you add the link:https://github.com/troessner/reek[Reek] gem to your
-project for code smell and code quality support.
+project for code smell and code quality support. This adds the `.reek.yml` configuration to your project.
 
 ===== Refinements
 
@@ -277,7 +335,19 @@ Ruby core objects without monkey patching your code.
 ===== RSpec
 
 The `--rspec` option allows you add the link:https://rspec.info[RSpec] gem to your project for
-defining your project specifications and have a framework for testing your code.
+defining your project specifications and have a framework for testing your code. This adds the following files to your project:
+
+....
+├── bin
+│  ├── rspec
+├── spec
+│  ├── lib
+│  │  └── <your project name>_spec.rb
+│  ├── support
+│  │  └── shared_contexts
+│  │     └── temp_dir.rb
+│  └── spec_helper.rb
+....
 
 ===== Repl Type Completor (RTC)
 
@@ -286,13 +356,17 @@ The `--rtc` option allows you add the link:https://github.com/ruby/repl_type_com
 ===== Setup
 
 The `--setup` option allows you to configure you project with automated setup instructions so anyone
-new to your project can quickly get started by running the `bin/setup` script.
+new to your project can quickly get started by running the `bin/setup` script. This adds the following file to your project:
+
+....
+│  └── setup
+....
 
 ===== SimpleCov
 
 The `--simple_cov` option allows you add the
 link:https://github.com/simplecov-ruby/simplecov[SimpleCov] gem to your project to provide full
-analysis of what your quality of code is for the project.
+analysis of your project's code quality and/or find code that is unused.
 
 ===== Versions
 
@@ -313,8 +387,7 @@ This gem can be configured via a global configuration:
 $HOME/.config/rubysmith/configuration.yml
 ....
 
-It can also be configured via link:https://alchemists.io/projects/xdg[XDG] environment
-variables. The default configuration is as follows:
+It can also be configured via {xdg_link}/{runcom_link} environment variables. The default configuration is as follows:
 
 [source,yaml]
 ----
@@ -358,6 +431,7 @@ build:
   versions: true
   zeitwerk: true
 citation:
+  affiliation: "%<organization_label>s"
   message: Please use the following metadata when citing this project in your work.
 documentation:
   format: "adoc"
@@ -387,11 +461,11 @@ repository:
   uri: https://github.com
 ----
 
-By customizing your configuration, you can change Rubysmith's default behavior when building projects. This is a great way to define your own specialized settings other than what is provide for you by default. This is also a handy way to provide additional information needed for some of the build options.
+By customizing your configuration, you can change Rubysmith's default behavior when building projects. This is a great way to define your own specialized settings other than what is provided by default. This is also a handy way to provide additional information needed for some of the build options.
 
 You'll also notice some of the values use {string_formats_link} which means you can use any fully qualified key as a string specifier for supported keys like those found in the `author` and `project` sections.
 
-The next sections will walk you through each configuration so you can learn more.
+Each section of the configuration is explained below.
 
 ==== Author
 
@@ -404,6 +478,7 @@ author:
   email: jsmith@example.com
   family_name: Smith
   given_name: Jill
+  author_uri:  # Requires being supplied.
 ----
 
 If your global link:https://git-scm.com[Git] configuration is properly configured, your given name;
@@ -421,15 +496,23 @@ this project.
 
 This section allows you to configure your link:https://orcid.org[ORCID]
 link:https://citation-file-format.github.io[citation] information used by the research community.
-You should definitely fill this in. Your author information, detailed above, will also be used when building this file.
+[source,yaml]
+----
+citation:
+  affiliation:  # Defaults to organization label (see above).
+  message:      # Defaults to supplied message (see above).
+  orcid:        # Defaults to https://orcid.org/ when no ID is supplied.
+----
+
+Your author, project, and license information will be used when building this file.
 
 ==== Documentation
 
 Use this section to define the kind of documentation you want generated for your project. The
 following options are available:
 
-* `adoc` - Uses link:https://asciidoctor.org[ASCII Doc] format.
-* `md` - Uses link:https://asciidoctor.org[Markdown] format.
+* `adoc`: Uses link:https://asciidoctor.org[ASCII Doc] format.
+* `md`: Uses link:https://daringfireball.net/projects/markdown[Markdown] format.
 
 ==== License
 
@@ -520,7 +603,13 @@ As for the `version` key, this defines the default version of newly created proj
 
 ==== Repository
 
-Your repisotry handle is the handle you setup when creating your account (i.e. `+https://github.com/<your_handle>+`). This information is used for template, funding, and/or URI construction purposes.
+Your repository handle is the handle you setup when creating your account (i.e. `+https://github.com/<your_handle>+`). This information is used for template, funding, and/or URI construction purposes. These are the defaults but you'll want to customize to reflect the service you are using:
+
+``` yaml
+repository:
+  handle: undefined
+  uri: https://github.com
+```
 
 == Development
 

data/lib/rubysmith/builder.rb

@@ -34,7 +34,7 @@ module Rubysmith
     end
 
     def delete
-      log_debug "Deleting: #{relative_build_path}"
+      log_info "Deleting: #{relative_build_path}"
       build_path.delete
       self
     end
@@ -52,7 +52,7 @@ module Rubysmith
     end
 
     def make_path
-      log_debug "Creating path: #{relative_build_path}"
+      log_info "Making: #{relative_build_path}"
       build_path.make_path
       self
     end
@@ -76,7 +76,7 @@ module Rubysmith
     end
 
     def render
-      log_debug "Rendering: #{relative_build_path}"
+      log_info "Rendering: #{relative_build_path}"
 
       pathway.start_path.read.then do |content|
         build_path.make_ancestors.write renderer.call(content)
@@ -92,7 +92,7 @@ module Rubysmith
     end
 
     def run *command
-      log_debug "Running: #{command}"
+      log_info "Running: #{command}"
       execute(*command)
       self
     rescue StandardError => error
@@ -100,7 +100,7 @@ module Rubysmith
     end
 
     def touch
-      log_debug "Touching: #{relative_build_path}"
+      log_info "Touching: #{relative_build_path}"
       build_path.deep_touch
       self
     end
@@ -132,6 +132,8 @@ module Rubysmith
 
     def pathway = settings.pathway
 
+    def log_info(message) = logger.info { message }
+
     def log_debug(message) = logger.debug { message }
 
     def log_error(message) = logger.error { message }

data/lib/rubysmith/builders/abstract.rb

@@ -4,10 +4,10 @@ module Rubysmith
   module Builders
     # Provides default implementation from which builders can inherit from.
     class Abstract
-      include Import[:settings]
+      include Import[:settings, :logger]
 
       def initialize(builder: Builder, **)
-        @builder = builder
+        @builder = -> settings, **keywords { builder.new settings, logger:, **keywords }
         super(**)
       end
 

data/lib/rubysmith/builders/docker/ignore.rb

@@ -10,7 +10,7 @@ module Rubysmith
         using Refinements::Struct
 
         def call
-          return false unless settings.build_git
+          return false unless settings.build_docker
 
           builder.call(settings.merge(template_path: "%project_name%/.dockerignore.erb")).render
           true

data/lib/rubysmith/cli/commands/build.rb

@@ -12,44 +12,44 @@ module Rubysmith
 
         # Order is important.
         BUILDERS = [
-          Builders::Init.new,
-          Builders::Core.new,
-          Builders::Version.new,
-          Builders::Documentation::Readme.new,
-          Builders::Documentation::Citation.new,
-          Builders::Documentation::License.new,
-          Builders::Documentation::Version.new,
-          Builders::Git::Setup.new,
-          Builders::Git::Ignore.new,
-          Builders::Git::Safe.new,
-          Builders::Bundler.new,
-          Builders::Rake::Binstub.new,
-          Builders::Rake::Configuration.new,
-          Builders::Console.new,
-          Builders::CircleCI.new,
-          Builders::Setup.new,
-          Builders::GitHub::Template.new,
-          Builders::GitHub::Funding.new,
-          Builders::GitHub::CI.new,
-          Builders::Guard.new,
-          Builders::Reek.new,
-          Builders::RSpec::Binstub.new,
-          Builders::RSpec::Context.new,
-          Builders::RSpec::Helper.new,
-          Builders::Caliber.new,
-          Builders::DevContainer::Dockerfile.new,
-          Builders::DevContainer::Compose.new,
-          Builders::DevContainer::Configuration.new,
-          Builders::Docker::Build.new,
-          Builders::Docker::Console.new,
-          Builders::Docker::Entrypoint.new,
-          Builders::Docker::File.new,
-          Builders::Docker::Ignore.new,
-          Extensions::Bundler.new,
-          Extensions::Pragmater.new,
-          Extensions::Tocer.new,
-          Extensions::Rubocop.new,
-          Builders::Git::Commit.new
+          Builders::Init,
+          Builders::Core,
+          Builders::Version,
+          Builders::Documentation::Readme,
+          Builders::Documentation::Citation,
+          Builders::Documentation::License,
+          Builders::Documentation::Version,
+          Builders::Git::Setup,
+          Builders::Git::Ignore,
+          Builders::Git::Safe,
+          Builders::Bundler,
+          Builders::Rake::Binstub,
+          Builders::Rake::Configuration,
+          Builders::Console,
+          Builders::CircleCI,
+          Builders::Setup,
+          Builders::GitHub::Template,
+          Builders::GitHub::Funding,
+          Builders::GitHub::CI,
+          Builders::Guard,
+          Builders::Reek,
+          Builders::RSpec::Binstub,
+          Builders::RSpec::Context,
+          Builders::RSpec::Helper,
+          Builders::Caliber,
+          Builders::DevContainer::Dockerfile,
+          Builders::DevContainer::Compose,
+          Builders::DevContainer::Configuration,
+          Builders::Docker::Build,
+          Builders::Docker::Console,
+          Builders::Docker::Entrypoint,
+          Builders::Docker::File,
+          Builders::Docker::Ignore,
+          Extensions::Bundler,
+          Extensions::Pragmater,
+          Extensions::Tocer,
+          Extensions::Rubocop,
+          Builders::Git::Commit
         ].freeze
 
         handle "build"
@@ -99,7 +99,7 @@ module Rubysmith
 
         def call
           log_info "Building project skeleton: #{settings.project_name}..."
-          builders.each(&:call)
+          builders.each { |builder| builder.new(settings:, logger:).call }
           log_info "Project skeleton complete!"
         end
 

data/lib/rubysmith/configuration/defaults.yml

@@ -38,6 +38,7 @@ build:
   versions: true
   zeitwerk: true
 citation:
+  affiliation: "%<organization_label>s"
   message: Please use the following metadata when citing this project in your work.
 documentation:
   format: "adoc"

data/lib/rubysmith/container.rb

@@ -22,6 +22,7 @@ module Rubysmith
                       .add_transformer(Configuration::Transformers::TemplateRoot.new)
                       .add_transformer(:root, :target_root)
                       .add_transformer(:format, :author_uri)
+                      .add_transformer(:format, :citation_affiliation)
                       .add_transformer(:format, :project_uri_community)
                       .add_transformer(:format, :project_uri_conduct)
                       .add_transformer(:format, :project_uri_contributions)

data/lib/rubysmith/extensions/bundler.rb

@@ -9,7 +9,7 @@ module Rubysmith
   module Extensions
     # Ensures gem dependencies are installed.
     class Bundler
-      include Import[:settings]
+      include Import[:settings, :logger]
 
       using Refinements::IO
       using Refinements::Pathname
@@ -20,6 +20,17 @@ module Rubysmith
       end
 
       def call
+        logger.info { "Installing gem dependencies..." }
+        install
+      rescue ::Bundler::HTTPError
+        log_error
+      end
+
+      private
+
+      attr_reader :client
+
+      def install
         settings.project_root.change_dir do
           client.start %w[install --quiet]
           STDOUT.squelch { client.start %w[lock --add-platform x86_64-linux --update] }
@@ -28,9 +39,10 @@ module Rubysmith
         true
       end
 
-      private
-
-      attr_reader :client
+      def log_error
+        logger.error { "Unable to install gem dependencies. Is your network stable?" }
+        false
+      end
     end
   end
 end

data/lib/rubysmith/extensions/pragmater.rb

@@ -7,7 +7,7 @@ module Rubysmith
   module Extensions
     # Ensures project skeleton has pragmas.
     class Pragmater
-      include Import[:settings]
+      include Import[:settings, :logger]
 
       using Refinements::Pathname
 
@@ -37,6 +37,7 @@ module Rubysmith
       end
 
       def call
+        logger.info { "Adding frozen string literal pragmas..." }
         settings.project_root.change_dir { client.call }
         true
       end

data/lib/rubysmith/extensions/rubocop.rb

@@ -8,7 +8,7 @@ module Rubysmith
   module Extensions
     # Ensures project skeleton adheres to style guide.
     class Rubocop
-      include Import[:settings]
+      include Import[:settings, :logger]
 
       using Refinements::IO
       using Refinements::Pathname
@@ -19,18 +19,22 @@ module Rubysmith
       end
 
       def call
-        project_root = settings.project_root
-
-        project_root.change_dir do
-          STDOUT.squelch { client.run ["--autocorrect-all", project_root.to_s] }
-        end
-
+        logger.info { "Running RuboCop autocorrect..." }
+        autocorrect
         true
       end
 
       private
 
       attr_reader :client
+
+      def autocorrect
+        project_root = settings.project_root
+
+        project_root.change_dir do
+          STDOUT.squelch { client.run ["--autocorrect-all", project_root.to_s] }
+        end
+      end
     end
   end
 end

data/lib/rubysmith/extensions/tocer.rb

@@ -8,7 +8,7 @@ module Rubysmith
   module Extensions
     # Ensures project skeleton documentation has table of content.
     class Tocer
-      include Import[:settings]
+      include Import[:settings, :logger]
 
       using Refinements::Pathname
 
@@ -18,15 +18,18 @@ module Rubysmith
       end
 
       def call
-        return false unless settings.build_readme
+        return false unless settings.build_readme && settings.markdown?
 
-        settings.project_root.change_dir { client.call }
+        logger.info { "Adding table of contents..." }
+        upsert
         true
       end
 
       private
 
       attr_reader :client
+
+      def upsert = settings.project_root.change_dir { client.call }
     end
   end
 end

data/rubysmith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "rubysmith"
-  spec.version = "7.3.0"
+  spec.version = "7.4.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/rubysmith"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysmith
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.4.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger