change add readme todo to add readme

Author: ashleywillard

lib/packs/private.rb

@@ -69,7 +69,7 @@ def self.create_pack!(pack_name:, enforce_dependencies:, enforce_privacy:, enfor
         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 @@ def self.move_to_pack!(pack_name:, paths_relative_to_root:, per_file_processors:
         end
       end
 
-      add_readme_todo(package)
+      add_readme(package)
 
       per_file_processors.each do |processor|
         processor.after_move_files!(file_move_operations)
@@ -452,12 +452,16 @@ def self.add_public_directory(package)
     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
 

lib/packs/user_event_logger.rb

@@ -147,7 +147,7 @@ def on_create_public_directory_todo(pack_name)
     end
 
     sig { params(pack_name: String).returns(String) }
-    def on_create_readme_todo(pack_name)
+    def on_create_readme(pack_name)
       <<~MSG
         Welcome to `#{pack_name}`!
 

spec/packs_spec.rb

@@ -286,7 +286,7 @@ def write_codeownership_config
     end
 
     describe 'setting the README' do
-      let(:expected_readme_todo) do
+      let(:expected_readme) do
         <<~EXPECTED
           Welcome to `packs/organisms`!
 
@@ -306,31 +306,34 @@ def write_codeownership_config
         EXPECTED
       end
 
-      it 'adds a README_TODO.md file as a placeholder' do
+      it 'adds a README.md file as a placeholder' do
         Packs.create_pack!(pack_name: 'packs/organisms')
         ParsePackwerk.bust_cache!
-        actual_readme_todo = ParsePackwerk.find('packs/organisms').directory.join('README_TODO.md')
-        expect(actual_readme_todo.read).to eq expected_readme_todo
+        actual_readme = ParsePackwerk.find('packs/organisms').directory.join('README.md')
+        expect(actual_readme.read).to eq expected_readme
       end
 
       context 'app has one pack with an outdated README_TODO.md' do
         it 'overwrites the README_TODO.md' do
           write_file('packs/organisms/README_TODO.md', 'This is outdated')
           write_package_yml('packs/organisms')
-          actual_readme_todo = ParsePackwerk.find('packs/organisms').directory.join('README_TODO.md')
-          expect(actual_readme_todo.read).to eq 'This is outdated'
+          readme_todo = ParsePackwerk.find('packs/organisms').directory.join('README_TODO.md')
+          expect(readme_todo.read).to eq 'This is outdated'
+
           Packs.create_pack!(pack_name: 'packs/organisms')
-          expect(actual_readme_todo.read).to eq expected_readme_todo
+          actual_readme = ParsePackwerk.find('packs/organisms').directory.join('README.md')
+          expect(actual_readme.read).to eq expected_readme
+          expect(readme_todo.exist?).to eq false
         end
       end
 
       context 'app has one pack with a README.md' do
-        it 'does not add a README_TODO.md file' do
+        it 'does not change the README.md file' do
           write_package_yml('packs/organisms')
-          write_file('packs/organisms/README.md')
-          actual_readme_todo = ParsePackwerk.find('packs/organisms').directory.join('README_TODO.md')
+          write_file('packs/organisms/README.md', 'This is the original README.md')
+          actual_readme = ParsePackwerk.find('packs/organisms').directory.join('README.md')
           Packs.create_pack!(pack_name: 'packs/organisms')
-          expect(actual_readme_todo.exist?).to eq false
+          expect(actual_readme.read).to eq 'This is the original README.md'
         end
       end
     end
@@ -830,7 +833,7 @@ def write_codeownership_config
     end
 
     describe 'setting the README' do
-      let(:expected_readme_todo) do
+      let(:expected_readme) do
         <<~EXPECTED
           Welcome to `packs/organisms`!
 
@@ -850,44 +853,46 @@ def write_codeownership_config
         EXPECTED
       end
 
-      it 'adds a README_TODO.md file as a placeholder' do
+      it 'adds a README.md file as a placeholder' do
         write_file('app/services/foo.rb')
         write_package_yml('packs/organisms')
         Packs.move_to_pack!(
           pack_name: 'packs/organisms',
           paths_relative_to_root: ['app/services/foo.rb']
         )
 
-        actual_readme_todo = ParsePackwerk.find('packs/organisms').directory.join('README_TODO.md')
-        expect(actual_readme_todo.read).to eq expected_readme_todo
+        actual_readme = ParsePackwerk.find('packs/organisms').directory.join('README.md')
+        expect(actual_readme.read).to eq expected_readme
       end
 
       context 'app has one pack with an outdated README_TODO.md' do
         it 'overwrites the README_TODO.md' do
           write_file('app/services/foo.rb')
           write_package_yml('packs/organisms')
           write_file('packs/organisms/README_TODO.md', 'This is outdated')
-          actual_readme_todo = ParsePackwerk.find('packs/organisms').directory.join('README_TODO.md')
-          expect(actual_readme_todo.read).to eq 'This is outdated'
+          readme_todo = ParsePackwerk.find('packs/organisms').directory.join('README_TODO.md')
+          expect(readme_todo.read).to eq 'This is outdated'
           Packs.move_to_pack!(
             pack_name: 'packs/organisms',
             paths_relative_to_root: ['app/services/foo.rb']
           )
-          expect(actual_readme_todo.read).to eq expected_readme_todo
+          actual_readme = ParsePackwerk.find('packs/organisms').directory.join('README.md')
+          expect(actual_readme.read).to eq expected_readme
+          expect(readme_todo.exist?).to eq false
         end
       end
 
       context 'app has one pack with a README.md' do
-        it 'does not add a README_TODO.md file' do
+        it 'does not change the README.md file' do
           write_file('app/services/foo.rb')
           write_package_yml('packs/organisms')
-          write_file('packs/organisms/README.md')
-          actual_readme_todo = ParsePackwerk.find('packs/organisms').directory.join('README_TODO.md')
+          write_file('packs/organisms/README.md', 'This is the original README.md')
+          actual_readme = ParsePackwerk.find('packs/organisms').directory.join('README.md')
           Packs.move_to_pack!(
             pack_name: 'packs/organisms',
             paths_relative_to_root: ['app/services/foo.rb']
           )
-          expect(actual_readme_todo.exist?).to eq false
+          expect(actual_readme.read).to eq 'This is the original README.md'
         end
       end
     end