Rename a ton of "organization" stuff to "empty typescript react project"

azimux · azimux · commit 1e3fcd731504 · 2024-03-17T11:52:04.000-07:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -36,7 +36,7 @@ jobs:
         env:
           cache-name: cache-foobara
         with:
-          path: ~/work/organization-generator/foobara
+          path: ~/work/empty-typescript-react-project-generator/foobara
           key: ${{ env.cache-name }}-${{ env.foobara_branch }}-${{ env.foobara_sha1 }}
           restore-keys: |
             ${{ env.cache-name }}-${{ env.foobara_branch }}-
@@ -67,9 +67,9 @@ jobs:
         run: |
           set -e
           mkdir -p .bundle
-          echo -e "---\nBUNDLE_LOCAL__FOOBARA: '/home/runner/work/organization-generator/foobara'" > .bundle/config
+          echo -e "---\nBUNDLE_LOCAL__FOOBARA: '/home/runner/work/empty-typescript-react-project-generator/foobara'" > .bundle/config
           mkdir ../../foobara
-          ln -s  ../../organization-generator/foobara ../../foobara/foobara
+          ln -s  ../../empty-typescript-react-project-generator/foobara ../../foobara/foobara
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,6 +1,6 @@
 GIT
   remote: foobara
-  revision: f97443e06569b022bae15c2b8c1b0c136fc3edf0
+  revision: 9d507ed411aca4dcc747c0f61501c9b14cde3b13
   branch: main
   specs:
     foobara (0.0.1)
@@ -34,7 +34,7 @@ GIT
 PATH
   remote: .
   specs:
-    foobara-organization-generator (0.0.1)
+    foobara-empty-typescript-react-project-generator (0.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -144,8 +144,8 @@ PLATFORMS
 
 DEPENDENCIES
   foobara!
+  foobara-empty-typescript-react-project-generator!
   foobara-files-generator!
-  foobara-organization-generator!
   foobara-rubocop-rules!
   foobara-spec-helpers!
   foobara-util!
diff --git a/README.md b/README.md
@@ -3,7 +3,8 @@
 TODO: Delete this and the text below, and describe your gem
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library
-into a gem. Put your Ruby code in the file `lib/foobara/organization_generator`. To experiment with that code,
+into a gem. Put your Ruby code in the file `lib/foobara/empty_typescript_react_project_generator`. To experiment with
+that code,
 run `bin/console` for an interactive prompt.
 
 ## Installation
@@ -43,7 +44,7 @@ push git commits and the created tag, and push the `.gem` file to [rubygems.org]
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub
-at https://github.com/[USERNAME]/foobara-organization-generator.
+at https://github.com/[USERNAME]/foobara-empty-typescript-react-project-generator.
 
 ## License
 
diff --git a/bin/console b/bin/console
@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "foobara/organization_generator"
+require "foobara/empty_typescript_react_project_generator"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
diff --git a/foobara-empty-typescript-react-project-generator.gemspec b/foobara-empty-typescript-react-project-generator.gemspec
@@ -1,13 +1,13 @@
 require_relative "src/version"
 
 Gem::Specification.new do |spec|
-  spec.name = "foobara-organization-generator"
-  spec.version = Foobara::Generators::OrganizationGenerator::VERSION
+  spec.name = "foobara-empty-typescript-react-project-generator"
+  spec.version = Foobara::Generators::EmptyTypescriptReactProjectGenerator::VERSION
   spec.authors = ["Miles Georgi"]
   spec.email = ["azimux@gmail.com"]
 
-  spec.summary = "Generates Foobara organizations"
-  spec.homepage = "https://github.com/foobara/generators-organization-generator"
+  spec.summary = "Generates empty typescript react projects"
+  spec.homepage = "https://github.com/foobara/generators-empty-typescript-react-project-generator"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.2.2"
 
diff --git a/spec/foobara/generators/generate_empty_typescript_react_project_spec.rb b/spec/foobara/generators/generate_empty_typescript_react_project_spec.rb
@@ -1,21 +1,21 @@
-RSpec.describe Foobara::Generators::OrganizationGenerator::GenerateOrganization do
-  let(:organization_name) { "SomePrefix::SomeOrg" }
+RSpec.describe Foobara::Generators::EmptyTypescriptReactProjectGenerator::GenerateEmptyTypescriptReactProject do
+  let(:project_dir) { "SomePrefix::SomeOrg" }
 
   let(:inputs) do
     {
-      organization_name:,
+      project_dir:,
       description: "whatever"
     }
   end
-  let(:organization) { described_class.new(inputs) }
-  let(:outcome) { organization.run }
+  let(:empty_typescript_react_project) { described_class.new(inputs) }
+  let(:outcome) { empty_typescript_react_project.run }
   let(:result) { outcome.result }
 
-  it "generates a organization" do
+  it "generates a empty_typescript_react_project" do
     expect(outcome).to be_success
 
-    organization_file = result["src/some_prefix/some_org.rb"]
-    expect(organization_file).to include("module SomeOrg")
-    expect(organization_file).to include("module SomePrefix")
+    empty_typescript_react_project_file = result["src/some_prefix/some_org.rb"]
+    expect(empty_typescript_react_project_file).to include("module SomeOrg")
+    expect(empty_typescript_react_project_file).to include("module SomePrefix")
   end
 end
diff --git a/spec/foobara/generators/write_empty_typescript_react_project_to_disk_spec.rb b/spec/foobara/generators/write_empty_typescript_react_project_to_disk_spec.rb
@@ -1,22 +1,22 @@
-RSpec.describe Foobara::Generators::OrganizationGenerator::WriteOrganizationToDisk do
-  let(:organization) { described_class.new(inputs) }
-  let(:outcome) { organization.run }
+RSpec.describe Foobara::Generators::EmptyTypescriptReactProjectGenerator::WriteEmptyTypescriptReactProjectToDisk do
+  let(:command) { described_class.new(inputs) }
+  let(:outcome) { empty_typescript_react_project.run }
   let(:result) { outcome.result }
   let(:errors) { outcome.errors }
   let(:inputs) do
     {
-      organization_config:,
+      empty_typescript_react_project_config:,
       output_directory:
     }
   end
-  let(:organization_config) do
+  let(:empty_typescript_react_project_config) do
     {
-      organization_name:,
+      project_dir:,
       description: "whatever"
     }
   end
-  let(:organization_name) { "SomeOrg" }
-  let(:output_directory) { "#{__dir__}/../../../tmp/organization_test_suite_output" }
+  let(:project_dir) { "SomeOrg" }
+  let(:output_directory) { "#{__dir__}/../../../tmp/empty_typescript_react_project_test_suite_output" }
 
   before do
     # rubocop:disable RSpec/AnyInstance
@@ -30,21 +30,21 @@
     it "contains base files" do
       expect(outcome).to be_success
 
-      expect(organization.paths_to_source_code.keys).to include("src/some_org.rb")
+      expect(command.paths_to_source_code.keys).to include("src/some_org.rb")
     end
   end
 
   describe "#output_directory" do
     context "with no output directory" do
       let(:inputs) do
         {
-          organization_config:
+          empty_typescript_react_project_config:
         }
       end
 
       it "writes files to the current directory" do
-        organization.cast_and_validate_inputs
-        expect(organization.output_directory).to eq(".")
+        command.cast_and_validate_inputs
+        expect(command.output_directory).to eq(".")
       end
     end
   end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -33,4 +33,4 @@
 end
 
 require "foobara/spec_helpers/all"
-require "foobara/organization_generator"
+require "foobara/empty_typescript_react_project_generator"
diff --git a/src/empty_typescript_react_project_config.rb b/src/empty_typescript_react_project_config.rb
@@ -2,24 +2,24 @@
 
 module Foobara
   module Generators
-    module OrganizationGenerator
-      class OrganizationConfig < Foobara::Model
+    module EmptyTypescriptReactProjectGenerator
+      class EmptyTypescriptReactProjectConfig < Foobara::Model
         attributes do
-          organization_name :string, :required
+          project_dir :string, :required
           description :string, :allow_nil
         end
 
         attr_accessor :module_path
 
         def initialize(attributes = nil, options = {})
-          organization_name = attributes[:organization_name]
+          project_dir = attributes[:project_dir]
           description = attributes[:description]
 
-          module_path = organization_name.split("::")
+          module_path = project_dir.split("::")
 
           super(
             {
-              organization_name:,
+              project_dir:,
               description:
             },
             options
diff --git a/src/empty_typescript_react_project_generator.rb b/src/empty_typescript_react_project_generator.rb
@@ -1,14 +1,14 @@
 module Foobara
   module Generators
-    module OrganizationGenerator
+    module EmptyTypescriptReactProjectGenerator
       module Generators
-        class OrganizationGenerator < Foobara::FilesGenerator
+        class EmptyTypescriptReactProjectGenerator < Foobara::FilesGenerator
           class << self
             def manifest_to_generator_classes(manifest)
               case manifest
-              when OrganizationConfig
+              when EmptyTypescriptReactProjectConfig
                 [
-                  Generators::OrganizationGenerator
+                  Generators::EmptyTypescriptReactProjectGenerator
                 ]
               else
                 # :nocov:
@@ -30,7 +30,7 @@ def target_path
             ["src", *path, file]
           end
 
-          alias organization_config relevant_manifest
+          alias empty_typescript_react_project_config relevant_manifest
 
           def templates_dir
             "#{__dir__}/../templates"
diff --git a/src/generate_empty_typescript_react_project.rb b/src/generate_empty_typescript_react_project.rb
@@ -1,16 +1,16 @@
 require "pathname"
 
-require_relative "organization_config"
+require_relative "empty_typescript_react_project_config"
 
 module Foobara
   module Generators
-    module OrganizationGenerator
-      class GenerateOrganization < Foobara::Generators::Generate
+    module EmptyTypescriptReactProjectGenerator
+      class GenerateEmptyTypescriptReactProject < Foobara::Generators::Generate
         class MissingManifestError < RuntimeError; end
 
         possible_error MissingManifestError
 
-        inputs OrganizationConfig
+        inputs EmptyTypescriptReactProjectConfig
 
         def execute
           add_initial_elements_to_generate
@@ -25,7 +25,7 @@ def execute
         attr_accessor :manifest_data
 
         def base_generator
-          Generators::OrganizationGenerator
+          Generators::EmptyTypescriptReactProjectGenerator
         end
 
         # TODO: delegate this to base_generator
@@ -37,11 +37,11 @@ def templates_dir
         end
 
         def add_initial_elements_to_generate
-          elements_to_generate << organization_config
+          elements_to_generate << empty_typescript_react_project_config
         end
 
-        def organization_config
-          @organization_config ||= OrganizationConfig.new(inputs)
+        def empty_typescript_react_project_config
+          @empty_typescript_react_project_config ||= EmptyTypescriptReactProjectConfig.new(inputs)
         end
       end
     end
diff --git a/src/version.rb b/src/version.rb
@@ -1,6 +1,6 @@
 module Foobara
   module Generators
-    module OrganizationGenerator
+    module EmptyTypescriptReactProjectGenerator
       VERSION = "0.0.1".freeze
     end
   end
diff --git a/src/write_empty_typescript_react_project_to_disk.rb b/src/write_empty_typescript_react_project_to_disk.rb
@@ -1,24 +1,25 @@
-require_relative "generate_organization"
+require_relative "generate_empty_typescript_react_project"
 
 module Foobara
   module Generators
-    module OrganizationGenerator
-      class WriteOrganizationToDisk < Foobara::Generators::WriteGeneratedFilesToDisk
+    module EmptyTypescriptReactProjectGenerator
+      class WriteEmptyTypescriptReactProjectToDisk < Foobara::Generators::WriteGeneratedFilesToDisk
         class << self
           def generator_key
-            "organization"
+            "empty_typescript_react_project"
           end
         end
 
-        depends_on GenerateOrganization
+        depends_on GenerateEmptyTypescriptReactProject
 
         inputs do
-          organization_config OrganizationConfig, :required
+          empty_typescript_react_project_config EmptyTypescriptReactProjectConfig, :required
           # TODO: should be able to delete this and inherit it
           output_directory :string
         end
 
         def execute
+          run_pre_generation_tasks
           generate_file_contents
           write_all_files_to_disk
           run_post_generation_tasks
@@ -35,25 +36,47 @@ def default_output_directory
         end
 
         def generate_file_contents
-          # TODO: just pass this in as the inputs instead of the organization??
-          self.paths_to_source_code = run_subcommand!(GenerateOrganization, organization_config.attributes)
+          self.paths_to_source_code = run_subcommand!(GenerateEmptyTypescriptReactProject,
+                                                      empty_typescript_react_project_config.attributes)
         end
 
-        def run_post_generation_tasks
+        def run_pre_generation_tasks
+          run_npx_create_react_app
+          add_necessary_dev_dependencies_for_eslint
+        end
+
+        def run_npx_create_react_app
+          puts "created empty project with create-react-app..."
+
           Dir.chdir output_directory do
-            rubocop_autocorrect
+            cmd = "npx create-react-app --template typescript whatever-frontend"
+            run_cmd_and_write_output(cmd)
           end
         end
 
-        def rubocop_autocorrect
-          # :nocov:
-          Open3.popen3("bundle exec rubocop --no-server -A") do |_stdin, _stdout, stderr, wait_thr|
-            exit_status = wait_thr.value
-            unless exit_status.success?
-              raise "could not rubocop -A. #{stderr.read}"
-            end
+        def add_necessary_dev_dependencies_for_eslint
+          puts "adding dependencies needed for linter to actually work..."
+
+          cmd = "npm install --save-dev " \
+                "@babel/plugin-proposal-private-property-in-object@^7.21.11 " \
+                "@eslint/create-config@^0.4.6 " \
+                "eslint-config-standard-with-typescript@^37.0.0 " \
+                "eslint-plugin-n@^16.5.0 " \
+                "eslint-plugin-promise@^6.1.1 " \
+                "typescript@^4.0.0 "
+
+          run_cmd_and_write_output(cmd)
+        end
+
+        def run_post_generation_tasks
+          Dir.chdir output_directory do
+            eslint_fix
           end
-          # :nocov:
+        end
+
+        def eslint_fix
+          cmd = "npx eslint 'src/**/*.{js,jsx,ts,tsx}' --fix"
+          run_cmd_and_write_output(cmd)
         end
       end
     end
