screenkit 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e33c3c018a611a86e9ece01bf1cac931c8df89868c515eeaf8208c11888c946
-  data.tar.gz: 6b8c37eb2dc866aec21660cd4bb58e5641f67e6eff27cc1e5d44304c590bf699
+  metadata.gz: b46db7b67fdb83851578e20864e338d1317eb0c86b2d9498cbde1163742ad0bc
+  data.tar.gz: 7216d1335b3031308fffb8d65f9cb64aed60736248f1028bb1dbe802d9ca6e41
 SHA512:
-  metadata.gz: 3329f278b4fce62ca42bb9d9fec7ad8ec93b62fae9f0fa949a9444e9be45b68ddf755ea6c5b536176c2031d2a9ae24fc8ed0e99c4fa8918377a319af14772c1f
-  data.tar.gz: 8e6a1089e6b396874e60d58b84140726b45b78532cddb54871eda524fd11382e383aebd4eed00a371d14d46b9db524854a89981619eb8bf066fe1f9aadeedc6a
+  metadata.gz: 66c8b5c9cca753d9096af780a12f95e5ac30fd46bd978e6070505565c780493eded3e6bad4bc6d300f69a20cee2c2dca94ab73f8690c02572b826befa8714139
+  data.tar.gz: 85951fb67485665ce3898d3e1130d8363467f896474e5ed901c3b177e7cfd059fd4ed5b47043a0c598f48b4a64d627abc1179ab2cf68d865a9fd7422a009ab6c

data/CHANGELOG.md

@@ -11,6 +11,11 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## v0.0.11
+
+- [Added] Add support for playwright scripts, so you can have browser-based
+  videos.
+
 ## v0.0.10
 
 - [Added] Add `--overwrite-content` and `--overwrite-voiceover` to individually

data/DOCUMENTATION.md

@@ -3,8 +3,10 @@
 **Terminal to screencast, simplified**
 
 ScreenKit is a Ruby-based tool for creating professional screencasts from
-terminal recordings. It automates the process of combining intro/outro scenes,
-terminal recordings (via [demotapes](https://github.com/fnando/demotape)),
+terminal and browser recordings. It automates the process of combining
+intro/outro scenes, terminal recordings (via
+[demotapes](https://github.com/fnando/demotape)), browser recordings (via
+[@fnando/playwright-video](https://github.com/fnando/playwright-video)),
 voiceovers, background music, callouts (lower thirds), and watermarks into
 polished video content.
 
@@ -141,7 +143,8 @@ screenkit episode new --title "My First Episode"
 This creates an episode directory with:
 
 - `config.yml` - Episode configuration
-- `content/` - Terminal recording files (`.tape` files)
+- `content/` - Content files (`.tape` files for terminal,
+  `.playwright.js`/`.playwright.mjs` for browser)
 - `scripts/` - Voiceover scripts (`.txt` files)
 - `voiceovers/` - Generated voiceover audio
 - `resources/` - Episode-specific resources
@@ -258,6 +261,18 @@ resources_dir:
   - /usr/share/fonts
 ```
 
+### Playwright Configuration
+
+Configure options for Playwright-based browser recordings:
+
+```yaml
+playwright:
+  color_scheme: dark # Color scheme: "light" or "dark"
+```
+
+For more options, see
+[@fnando/playwright-video documentation](https://github.com/fnando/playwright-video).
+
 ### Background Music
 
 ```yaml
@@ -524,7 +539,7 @@ callout_styles:
 
 ##### Usage in episode
 
-ScreenKit comes with some presets where you don't need to set up anything, but 
+ScreenKit comes with some presets where you don't need to set up anything, but
 you can also create custom callouts.
 
 Available presets:
@@ -1001,9 +1016,9 @@ episodes/001-episode-name/
 │   ├── 001.yml             # Callouts that will appear on segment 001
 │   ├── 002.yml
 │   └── ...
-├── content/                # Terminal recordings
+├── content/                # Content files (recordings/scripts)
 │   ├── 001.tape            # Demo Tape files
-│   ├── 002.tape
+│   ├── 002.playwright.js   # Playwright scripts
 │   └── ...
 ├── scripts/                # Voiceover scripts
 │   ├── 001.txt            # Text for TTS
@@ -1019,7 +1034,11 @@ episodes/001-episode-name/
     └── fonts/
 ```
 
-### Demo Tape Files
+### Content Files
+
+ScreenKit supports multiple content formats for creating screencast segments:
+
+#### Demo Tape Files
 
 ScreenKit uses [Demo Tape](https://github.com/fnando/demotape) tape files for
 terminal recordings:
@@ -1038,6 +1057,38 @@ paths accordingly. For instance, `episodes/001-episode-name/content/001.tape`
 would need to reference `../../resources/some-file` to access
 `resources/some-file` in the project's directory.
 
+#### Playwright Scripts
+
+For browser-based recordings, ScreenKit supports Playwright scripts via
+[@fnando/playwright-video](https://github.com/fnando/playwright-video):
+
+```javascript
+// content/001.playwright.js
+export default async function ({ page }) {
+  await page.goto("https://example.com");
+  await page.click("#button");
+  await page.waitForTimeout(2000);
+}
+```
+
+**Requirements:**
+
+- Install the npm package: `npm install -D @fnando/playwright-video`
+- Use `.playwright.js` or `.playwright.mjs` file extension
+
+**Configuration:**
+
+Add Playwright options to your project configuration:
+
+```yaml
+# screenkit.yml
+playwright:
+  color_scheme: dark # or "light"
+```
+
+When running Playwright scripts, the working directory will be the episode
+directory, similar to Demo Tape files.
+
 ### Script Files
 
 Plain text files for voiceover generation:
@@ -1053,8 +1104,11 @@ Today we'll learn how to create amazing screencasts.
 Files are matched by number:
 
 - `content/001.tape` → `scripts/001.txt` → `voiceovers/001.:ext`
+- `content/002.playwright.js` → `scripts/002.txt` → `voiceovers/002.:ext`
 - Segments are processed in numerical order
 - Missing scripts create silent segments
+- Content files can be `.tape` (Demo Tape), `.playwright.js`/`.playwright.mjs`
+  (Playwright), or media files (video/image)
 
 ---
 
@@ -1186,8 +1240,13 @@ When exporting an episode, ScreenKit:
 
 1. **Validates** project and episode configurations
 2. **Generates voiceovers** from script files (if TTS enabled)
-3. **Renders terminal recordings** from tape files using
-   [Demo Tape](https://github.com/fnando/demotape)
+3. **Renders content** from:
+   - Terminal recordings via [Demo Tape](https://github.com/fnando/demotape)
+     (`.tape` files)
+   - Browser recordings via
+     [@fnando/playwright-video](https://github.com/fnando/playwright-video)
+     (`.playwright.js`/`.playwright.mjs` files)
+   - Media files (video/image)
 4. **Combines segments** with crossfade transitions
 5. **Adds intro/outro** scenes
 6. **Overlays callouts** with animations
@@ -1265,6 +1324,13 @@ bundle exec screenkit ...
 - For macOS `say`: Verify voice name with `say -v ?`
 - For `espeak`: Ensure `espeak` is installed and in PATH
 
+#### Playwright scripts not working
+
+- Install the required npm package: `npm install -D @fnando/playwright-video`
+- Ensure `playwright-video` command is available in PATH
+- Check file extension is `.playwright.js` or `.playwright.mjs`
+- Verify Playwright browsers are installed: `npx playwright install`
+
 ---
 
 ## Contributing

data/lib/screenkit/callout/styles/base.rb

@@ -10,6 +10,7 @@ module ScreenKit
         attr_accessor :options
 
         extend SchemaValidator
+        include ImageMagick
 
         def initialize(source:, output_path:, log_path: nil, **options)
           @source = source
@@ -18,111 +19,11 @@ module ScreenKit
           @options = options
         end
 
-        # Wrap text to fit within the specified maximum width.
-        # @param text [String] The text to wrap.
-        # @param max_width [Integer] The maximum width in pixels.
-        # @param font_size [Integer] The font size in points.
-        # @return [Array<String>] The wrapped lines of text.
-        def text_wrap(text, max_width:, font_size:)
-          words = text.to_s.split(/\s+/)
-          width_factor = 0.6
-
-          [].tap do |lines|
-            words.each do |word|
-              line = lines.pop.to_s
-              word_width = word.size * (font_size * width_factor)
-              line_width = line.size * (font_size * width_factor)
-
-              if line_width + word_width <= max_width
-                line = [(line unless line.empty?), word].compact.join(" ")
-                lines << line
-              else
-                lines << line
-                lines << word
-              end
-            end
-          end
-        end
-
-        # Escape text for use in ImageMagick caption.
-        def escape_text(text)
-          text.gsub("'", "\\\\'")
-        end
-
         # Remove a file if it exists.
         # @param path [String] The file path to remove.
         def remove_file(path)
           File.unlink(path) if path && File.exist?(path)
         end
-
-        # Render text into an image using MiniMagick.
-        # @param text [String] The text to render.
-        # @param style [TextStyle] The text style to apply.
-        # @param width [Integer] The width of the text image.
-        # @param type [String] The ImageMagick text type (e.g., "caption").
-        # @return [Array] The path to the generated text image, width, and
-        # height.
-        def render_text_image(text:, style:, width:, type:)
-          return [nil, 0, 0] if text.to_s.empty?
-
-          image = MiniMagick::Image.open(
-            create_text_image(text:, style:, width:, type:)
-          )
-
-          [image.path, image.width, image.height]
-        end
-
-        # Convert values to high resolution (2x).
-        # @param value [Object] The value to convert.
-        # @return [Object] The converted value.
-        def hi_res(value)
-          case value
-          when Array
-            value.map { hi_res(it) }
-          when Hash
-            value.transform_values { hi_res(it) }
-          when Numeric
-            value * 2
-          else
-            value
-          end
-        end
-
-        # Create a text image using MiniMagick.
-        # @param text [String] The text to render.
-        # @param style [TextStyle] The text style to apply.
-        # @param width [Integer] The width of the text image.
-        # @param type [String] The ImageMagick text type (e.g., "caption").
-        # @return [Array] The path to the generated text image, and the actual
-        #                 `Tempfile` instance.
-        def create_text_image(text:, style:, width:, type:)
-          hash = SecureRandom.hex(10)
-          tmp_path = File.join(Dir.tmpdir, "callout-text-#{hash}.png")
-          FileUtils.mkdir_p(File.dirname(tmp_path))
-
-          MiniMagick.convert do |image|
-            unless type == "label"
-              image << "-size"
-              image << "#{width}x"
-            end
-
-            image << "-background"
-            image << "none"
-            image << "-fill"
-            image << style.color
-            image << "-font"
-            image << style.font_path.to_s
-            image << "-pointsize"
-            image << style.size.to_s
-            image << "#{type}:#{escape_text(text)}"
-            image << "PNG:#{tmp_path}"
-          end
-
-          tmp_path
-        rescue MiniMagick::Error => error
-          retry if error.message.include?("No such file or directory")
-          raise
-        end
       end
     end
   end

data/lib/screenkit/cli/base.rb

@@ -16,7 +16,7 @@ module ScreenKit
 
       no_commands do
         def config
-          @config ||= Config::Project.load_file(options.config)
+          @config ||= Config.load_file(options.config)
         end
       end
     end

data/lib/screenkit/cli/episode.rb

@@ -69,10 +69,15 @@ module ScreenKit
       def export
         puts Banner.banner if options.banner
 
-        episode_config = File.join(options.dir, "config.yml")
+        project_config = if File.file?(options.config)
+                           Config.load_yaml_file(options.config)
+                         else
+                           {}
+                         end
 
+        episode_config = File.join(options.dir, "config.yml")
         episode_config = if File.file?(episode_config)
-                           Config::Episode.load_file(episode_config)
+                           Config.load_yaml_file(episode_config)
                          else
                            {}
                          end
@@ -85,8 +90,7 @@ module ScreenKit
                               !options.overwrite_voiceover
 
         exporter = ScreenKit::Exporter::Episode.new(
-          project_config: config,
-          config: episode_config,
+          config: Config.load(**project_config.deep_merge(**episode_config)),
           options:
         )
 

data/lib/screenkit/config.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Config
+    using CoreExt
+    extend SchemaValidator
+
+    # The episode title.
+    attr_reader :title
+
+    # The directory where episode source files are stored.
+    attr_reader :episode_dir
+
+    # The directory where resources files are stored.
+    attr_reader :resources_dir
+
+    # The output directory for exported files.
+    attr_reader :output_dir
+
+    # Callout styles
+    attr_reader :callout_styles
+
+    # Scene configurations
+    attr_reader :scenes
+
+    # TTS configuration
+    attr_reader :tts
+
+    # The backtrack music configuration.
+    attr_reader :backtrack
+
+    # The watermark configuration.
+    attr_reader :watermark
+
+    # The demotape configuration.
+    attr_reader :demotape
+
+    # The Playwright configuration.
+    attr_reader :playwright
+
+    def self.schema_path
+      @schema_path ||=
+        ScreenKit.root_dir.join("schemas/config.json")
+    end
+
+    def self.load_yaml_file(path)
+      unless File.file?(path)
+        raise FileNotFoundError, "Config file not found: #{path}"
+      end
+
+      template = File.read(path)
+      contents = ERB.new(template).result
+
+      YAML.load(contents, symbolize_names: true)
+    end
+
+    def self.load_file(path)
+      load(load_yaml_file(path))
+    end
+
+    def self.load(config)
+      validate!(config)
+
+      new(**config)
+    end
+
+    def initialize(**kwargs)
+      kwargs.each do |key, value|
+        value = process(key, value)
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    def to_h
+      instance_variables.each_with_object({}) do |var, hash|
+        key = var.to_s.delete_prefix("@").to_sym
+        hash[key] = instance_variable_get(var).as_json
+      end
+    end
+
+    def process(key, value)
+      case key.to_sym
+      when :resources_dir
+        Array(value)
+      when /_(dir|path)$/
+        Pathname(value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/screenkit/content_type.rb

@@ -6,7 +6,8 @@ module ScreenKit
     def self.audio = %w[mp3 wav m4a aac aiff]
     def self.image = %w[gif jpg jpeg png tiff]
     def self.demotape = %w[tape]
+    def self.playwright = %w[playwright.js playwright.mjs]
 
-    def self.all = video + image + demotape
+    def self.all = video + image + demotape + playwright
   end
 end

data/lib/screenkit/core_ext/hash.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module CoreExt
+    refine NilClass do
+      def deep_merge(other)
+        {}.deep_merge(other)
+      end
+    end
+
+    refine Hash do
+      def deep_merge(other)
+        other = {} if other.nil?
+
+        merger = lambda do |_key, v1, v2|
+          if v1.is_a?(Hash) && v2.is_a?(Hash)
+            v1.merge(v2, &merger)
+          else
+            v2
+          end
+        end
+
+        merge(other, &merger)
+      end
+    end
+  end
+end

data/lib/screenkit/core_ext/json.rb

@@ -4,6 +4,12 @@ require "json"
 
 module ScreenKit
   module CoreExt
+    refine Pathname do
+      def as_json(*)
+        to_s
+      end
+    end
+
     refine JSON.singleton_class do
       def pretty_generate(target, *)
         super(target.as_json, *)

data/lib/screenkit/core_ext.rb

@@ -2,3 +2,4 @@
 
 require_relative "core_ext/string"
 require_relative "core_ext/json"
+require_relative "core_ext/hash"

data/lib/screenkit/exporter/episode.rb

@@ -11,12 +11,8 @@ module ScreenKit
       # Each file will be used as a segment in the episode.
       CONTENT_PATTERN = "content/**/*.{#{ContentType.all.join(',')}}".freeze
 
-      # The project configuration, usually the root's screenkit.yml file.
-      # @return [ScreenKit::Config::Project]
-      attr_reader :project_config
-
-      # The episode configuration, usually the episode's config.yml file.
-      # @return [ScreenKit::Config::Episode]
+      # The merged result of project and episode configurations.
+      # @return [Hash]
       attr_reader :config
 
       # The export options.
@@ -29,8 +25,7 @@ module ScreenKit
       # The logfile for logging export details.
       attr_reader :logfile
 
-      def initialize(project_config:, config:, options:)
-        @project_config = project_config
+      def initialize(config:, options:)
         @config = config
         @options = options
         @mutex = Mutex.new
@@ -44,33 +39,23 @@ module ScreenKit
       end
 
       def demotape_options
-        (config.demotape || {}).merge(project_config.demotape || {})
+        config.demotape
+      end
+
+      def playwright_options
+        config.playwright
       end
 
       def tts_engine
         tts_engines.first
       end
 
-      def tts_config
-        @tts_config ||= begin
-          project_tts = if project_config.tts.is_a?(Hash)
-                          [project_config.tts]
-                        else
-                          Array(project_config.tts)
-                        end
-
-          episode_tts = if config.tts.is_a?(Hash)
-                          [config.tts]
-                        else
-                          Array(config.tts)
-                        end
-
-          episode_tts + project_tts
-        end
+      def tts_options
+        config.tts
       end
 
       def tts_engines
-        @tts_engines ||= tts_config.filter_map do |opts|
+        @tts_engines ||= tts_options.filter_map do |opts|
           next unless opts[:enabled]
 
           api_key = options.tts_api_key
@@ -197,7 +182,7 @@ module ScreenKit
         crossfade_duration = Duration.parse(
           scenes.dig(:segment, :crossfade_duration) || 0.5
         )
-        watermark = Watermark.new(config.watermark || project_config.watermark)
+        watermark = Watermark.new(config.watermark)
 
         watermark_path = if watermark.path
                            source.search(watermark.path)
@@ -418,11 +403,7 @@ module ScreenKit
       def prelude
         logfile.json_log(
           :config,
-          options.merge(
-            pwd: Dir.pwd,
-            episode_config: config.to_h,
-            project_config: project_config.to_h
-          )
+          options.merge(pwd: Dir.pwd, config:)
         )
 
         log(
@@ -485,7 +466,7 @@ module ScreenKit
       def output_dir
         @output_dir ||= Pathname(
           format(
-            options.output_dir || project_config.output_dir.to_s,
+            options.output_dir || config.output_dir.to_s,
             episode_dirname: root_dir.basename
           )
         ).expand_path
@@ -504,11 +485,11 @@ module ScreenKit
           spinner.update("Exporting intro…")
 
           intro_config = scenes.fetch(:intro)
+          intro_config[:title][:text] = config.title
+
           log_path = logfile.create(:intro)
 
-          Intro
-            .new(config: intro_config, text: config.title, source:, log_path:)
-            .export(intro_path)
+          Intro.new(config: intro_config, source:, log_path:).export(intro_path)
 
           spinner.stop
         end
@@ -542,7 +523,7 @@ module ScreenKit
       end
 
       def scenes
-        @scenes ||= project_config.scenes.merge(config.scenes)
+        config.scenes
       end
 
       def project_root_dir
@@ -554,7 +535,7 @@ module ScreenKit
       end
 
       def resources_dir
-        @resources_dir ||= project_config.resources_dir.map do |dir|
+        @resources_dir ||= config.resources_dir.map do |dir|
           path = dir
           path = File.expand_path(dir) if dir.start_with?("~")
           path = Pathname(format(path, episode_dir: root_dir))
@@ -564,7 +545,8 @@ module ScreenKit
       end
 
       def callout_styles
-        (project_config.callout_styles || {}).merge(config.callout_styles || {})
+        @callout_styles ||= project_config.callout_styles
+                                          .deep_merge(config.callout_styles)
       end
 
       def output_video_path
@@ -578,14 +560,11 @@ module ScreenKit
       end
 
       def backtrack
-        @backtrack ||=
-          if config.backtrack
-            Sound.new(input: config.backtrack, source:)
-          elsif project_config.backtrack
-            Sound.new(input: project_config.backtrack, source:)
-          else
-            Sound.new(input: mute_sound_path, source:)
-          end
+        @backtrack ||= if config.backtrack
+                         Sound.new(input: config.backtrack, source:)
+                       else
+                         Sound.new(input: mute_sound_path, source:)
+                       end
       end
 
       def segments