packs 0.0.45 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad12cf46cbfafc5f4b3b2d785f2ec2f3f67ed34cb8322bba6929a7ae584d06e1
-  data.tar.gz: 8712c08b31b3457b403d3814764496f3c4d46e53867f88760cadd10083e38a63
+  metadata.gz: 9a2fde399cc66508a90dac9a91d026179a732e2ff9675e6d385bf4981ae5fb45
+  data.tar.gz: 2aeb3c2b828d169a387755af328ad67b2e2133a482bed16f976e884d08e27ea8
 SHA512:
-  metadata.gz: bad96e8500d53692f4930cb08ae0ed1be99b8b0524283027d424a05094d23039b5ed9bd646d94db4e67de158ca5af480288c05e799af0a82e6c46cc2c4190fc0
-  data.tar.gz: ed7ebf9ed287b16336187500dc1ebfb833ce569039f7ad9775e9cf84fee53be47f6326fd8b7a4f3abc61d922080dc9ae2ab8e3049583bf8165871b7a4e763ffb
+  metadata.gz: 32accbb46babdc0cf1478cd905cd95cc144f6a53d184cfc56a97cf6368a009508dcb48e8218ae680f0dcd493b08134c16786550208aa96929c4aff83792f70f1
+  data.tar.gz: b9932164a175a19ea41762dd2743ba080fac999e0b4393e4f9265ed68c913f54a0bb9fa59b89269619eec6daef851196a72e737e5de106d62a323c731108a3fd

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/private.rb

@@ -69,7 +69,7 @@ module Packs
         team: team
       )
       add_public_directory(package) if package.enforce_privacy
-      add_readme_todo(package)
+      add_readme(package)
 
       Logging.section('Next steps') do
         next_steps = Packs.config.user_event_logger.after_create_pack(pack_name)
@@ -140,7 +140,7 @@ module Packs
         end
       end
 
-      add_readme_todo(package)
+      add_readme(package)
 
       per_file_processors.each do |processor|
         processor.after_move_files!(file_move_operations)
@@ -446,18 +446,22 @@ module Packs
 
       if public_directory.glob('**/**.rb').none?
         FileUtils.mkdir_p(public_directory)
-        todo_md = Packs.config.user_event_logger.on_create_public_directory_todo(package.name)
-        public_directory.join('TODO.md').write(todo_md)
+        package_name = package.directory.basename.to_s
+        FileUtils.mkdir_p(public_directory.join(package_name))
       end
     end
 
     sig { params(package: ParsePackwerk::Package).void }
-    def self.add_readme_todo(package)
+    def self.add_readme(package)
       pack_directory = package.directory
 
       if !pack_directory.join('README.md').exist?
-        readme_todo_md = Packs.config.user_event_logger.on_create_readme_todo(package.name)
-        pack_directory.join('README_TODO.md').write(readme_todo_md)
+        readme_md = Packs.config.user_event_logger.on_create_readme(package.name)
+        pack_directory.join('README.md').write(readme_md)
+
+        if pack_directory.join('README_TODO.md').exist?
+          pack_directory.join('README_TODO.md').delete
+        end
       end
     end
 

data/lib/packs/user_event_logger.rb

@@ -124,30 +124,12 @@ module Packs
     end
 
     sig { params(pack_name: String).returns(String) }
-    def on_create_public_directory_todo(pack_name)
-      <<~MSG
-        This directory holds your public API!
-
-        Any classes, constants, or modules that you want other packs to use and you intend to support should go in here.
-        Anything that is considered private should go in other folders.
-
-        If another pack uses classes, constants, or modules that are not in your public folder, it will be considered a "privacy violation" by packwerk.
-        You can prevent other packs from using private API by using packwerk.
-
-        Want to find how your private API is being used today?
-        Try running: `bin/packs list_top_violations privacy #{pack_name}`
-
-        Want to move something into this folder?
-        Try running: `bin/packs make_public #{pack_name}/path/to/file.rb`
+    def on_create_readme(pack_name)
+      readme_template_pathname = Packs.config.readme_template_pathname
+      readme_template = readme_template_pathname.read if readme_template_pathname.exist?
 
-        One more thing -- feel free to delete this file and replace it with a README.md describing your package in the main package directory.
+      return readme_template unless readme_template.nil?
 
-        See #{documentation_link} for more info!
-      MSG
-    end
-
-    sig { params(pack_name: String).returns(String) }
-    def on_create_readme_todo(pack_name)
       <<~MSG
         Welcome to `#{pack_name}`!
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.45
+  version: 0.2.0
 platform: ruby
 authors:
 - Gusto Engineers
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2025-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -329,7 +328,6 @@ metadata:
   source_code_uri: https://github.com/rubyatscale/packs
   changelog_uri: https://github.com/rubyatscale/packs/releases
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -344,8 +342,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Provides CLI tools for working with ruby packs.
 test_files: []