packs 0.0.45 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad12cf46cbfafc5f4b3b2d785f2ec2f3f67ed34cb8322bba6929a7ae584d06e1
-  data.tar.gz: 8712c08b31b3457b403d3814764496f3c4d46e53867f88760cadd10083e38a63
+  metadata.gz: cedac59e21e3cfabcc0e70369a37f099d917c6092c75a9415e4935a9bec705af
+  data.tar.gz: 36307b5c6d741d2145e73b827ea66ace06cffa0123101443f4b0d2b30e09a5e9
 SHA512:
-  metadata.gz: bad96e8500d53692f4930cb08ae0ed1be99b8b0524283027d424a05094d23039b5ed9bd646d94db4e67de158ca5af480288c05e799af0a82e6c46cc2c4190fc0
-  data.tar.gz: ed7ebf9ed287b16336187500dc1ebfb833ce569039f7ad9775e9cf84fee53be47f6326fd8b7a4f3abc61d922080dc9ae2ab8e3049583bf8165871b7a4e763ffb
+  metadata.gz: 9478f4344cdb4dc234abb52da988b9e63033234a78289d9bdcbdacb738f911c6fb98050b0c699d19157f100df7a0139ff0a4be453776bdefc0aafd140a71d9e8
+  data.tar.gz: 718c24457bc7b6f5d0b471f2954dbff83ebbbbb0602a32295fb8ffc6d0e9cfea44a8e49c3a9d26c938b78e34d1d67d774502b8db1b659e5a3f88cd3f7071802d

data/README.md

@@ -15,6 +15,11 @@ pack_paths:
   - gems/* # gems can be packs too!
 ```
 
+To customize the README template, include a `README_TEMPLATE.md` file in the root of your project. If you want to use a custom path for your README template, you can specify it in the `packs.yml` file in the root of your project:
+```yml
+readme_template_path: my_folder/README_STUFF.md
+```
+
 # Ecosystem
 The rest of the [rubyatscale](https://github.com/rubyatscale) ecosystem is intended to help make using packs and improving the boundaries between them more clear.
 

data/lib/packs/configuration.rb

@@ -7,6 +7,9 @@ module Packs
   class Configuration
     extend T::Sig
 
+    CONFIGURATION_PATHNAME = T.let(Pathname.new('packs.yml'), Pathname)
+    DEFAULT_README_TEMPLATE_PATHNAME = T.let(Pathname.new('README_TEMPLATE.md'), Pathname)
+
     sig { params(enforce_dependencies: T::Boolean).void }
     attr_writer :enforce_dependencies
 
@@ -45,6 +48,18 @@ module Packs
     def default_enforce_dependencies
       true
     end
+
+    sig { returns(Pathname) }
+    def readme_template_pathname
+      config_hash = CONFIGURATION_PATHNAME.exist? ? YAML.load_file(CONFIGURATION_PATHNAME) : {}
+
+      specified_readme_template_path = config_hash['readme_template_path']
+      if specified_readme_template_path.nil?
+        DEFAULT_README_TEMPLATE_PATHNAME
+      else
+        Pathname.new(specified_readme_template_path)
+      end
+    end
   end
 
   class << self

data/lib/packs/user_event_logger.rb

@@ -148,6 +148,11 @@ module Packs
 
     sig { params(pack_name: String).returns(String) }
     def on_create_readme_todo(pack_name)
+      readme_template_pathname = Packs.config.readme_template_pathname
+      readme_template = readme_template_pathname.read if readme_template_pathname.exist?
+
+      return readme_template unless readme_template.nil?
+
       <<~MSG
         Welcome to `#{pack_name}`!
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.45
+  version: 0.1.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -344,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Provides CLI tools for working with ruby packs.