Note some TODOs

rangerscience · Sep 24, 2024 · d5d7c76 · d5d7c76
1 parent f4a422c
commit d5d7c76
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/lib/generators/storybook/install_generator.rb b/lib/generators/storybook/install_generator.rb
@@ -30,6 +30,7 @@ def mount_previews
   def update_storybook
     # Main.js
     insert_into_file ".storybook/main.js", "\n    \"@storybook/server\",", after: "addons: ["
+    # TODO: Switch to YAML from JSON for stories (should be supported by Storybook)
     gsub_file ".storybook/main.js", "*.stories.@(js|jsx|mjs|ts|tsx)", "*.stories.json"
     gsub_file ".storybook/main.js", "@storybook/react-webpack5", "@storybook/server-webpack5"
 

diff --git a/lib/storybook/tasks/stories.rake b/lib/storybook/tasks/stories.rake
@@ -2,6 +2,7 @@ namespace :storybook do
   desc "Write CSF JSON stories for all Stories"
   task stories: :environment do
     stories_dir = "stories"
+    # TODO: Also needs to *remove* stale stories
     Rails::Previews::Preview.all.map do |preview|
       filename = Rails.root.join("#{stories_dir}/#{preview.preview_name}.stories.json")
       stories_json = JSON.pretty_generate(preview.to_csf)