trmnl_preview 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 236a5502b02ab161fffc5330fc712c329810f877038c71baadc86b376e607157
-  data.tar.gz: 41400bbbe0b54639311ae928280277ee1717f58f1de74bd71ab92f213bbe92db
+  metadata.gz: c021076f55f8b5d150e65e2202c5bc978e8709684ee4d9bf27c0b7ec8e0b59b8
+  data.tar.gz: daa5e5734d9b1e3d755b789b0081916e53ce6c0a3cdd6d75e5276335ad2dae83
 SHA512:
-  metadata.gz: 604a7f74231c2e738dbf61995469a64e488cc1d69fa9eb84076fb9badfb2d83fd8c490fa261154471852e7c7effb6071e458d40e748bc70de7ea27455d5a8485
-  data.tar.gz: c4396159f68882180618578725f2e386e703a9d992a195a5ce2de463d8dab407d9b0a30655495963e0b1af35ee2ab0813fae75ed77633d616312fa64246ef753
+  metadata.gz: d422c11366ba16381be6765dfb36a25e2a662db4e9da3f3b08b780bbabbd94338d65f0f75bf6cbb82a0aa51fee8660886e5cd14203ccfbd2145539a617823559
+  data.tar.gz: 87b5bb57b023748ecc9412e13059801a755e6d0d03c82f27aaacc2077c119ed4386e28fba8a3a4f62ee47b783d4c92e49905d1a47fb29e2f8a93da7caddc563d

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 
 # Changelog
 
+## 0.8.3
+
+- `trmnlp init` and `trmnlp clone` now scaffold a `.github/workflows/trmnl.yml` CI workflow and a `.gitignore`, and run `git init -b main`, so a cloned plugin is ready to push to GitHub and deploy on every commit to `main`
+- Added `--skip-git` to `trmnlp init` and `trmnlp clone` for projects that manage Git themselves
+- The Docker image now ships `git` so the `docker run trmnl/trmnlp clone` flow leaves a ready-to-push project on the host
+- View templates now ship canonical `layout` + `title_bar` markup that passes `trmnlp lint`
+
 ## 0.8.2
 
 - Fixed `framework_version: latest` rendering against the auto-upgrading `/latest/` asset path instead of the current concrete release, matching the hosted service (#99)

data/README.md

@@ -28,6 +28,10 @@ This is the structure of a plugin project:
 
 ```
 .
+├── .github
+│   └── workflows
+│       └── trmnl.yml
+├── .gitignore
 ├── .trmnlp.yml
 ├── bin
 │   └── trmnlp
@@ -42,6 +46,8 @@ This is the structure of a plugin project:
 
 | File | Purpose |
 |---|---|
+| `.github/workflows/trmnl.yml` | GitHub Actions workflow — lints every PR, deploys to TRMNL on `main` |
+| `.gitignore` | Keeps `trmnlp build` output out of version control |
 | `.trmnlp.yml` | Local dev-server config — not uploaded to TRMNL |
 | `src/full.liquid` | Markup for the full screen |
 | `src/half_horizontal.liquid` | Top or bottom half of a stacked mashup |
@@ -123,9 +129,12 @@ If an environment variable is more convenient (for example in a CI/CD pipeline),
 
 ## Continuous Integration
 
-`trmnlp` runs in GitHub Actions without `trmnlp login` — set the `TRMNL_API_KEY`
-environment variable and it's used in place of the saved config. Add it as a
-repository secret, then drop this into `.github/workflows/trmnl.yml`:
+`trmnlp init` and `trmnlp clone` scaffold a `.github/workflows/trmnl.yml`
+workflow and initialize a Git repository, so a fresh project is ready to push
+to GitHub. The workflow runs in GitHub Actions without `trmnlp login` — set the
+`TRMNL_API_KEY` environment variable and it's used in place of the saved
+config. Add it as a repository secret to activate the workflow; it looks like
+this:
 
 ```yaml
 name: TRMNL

data/lib/trmnlp/cli.rb

@@ -34,11 +34,13 @@ module TRMNLP
 
     desc 'init NAME', 'Start a new plugin project'
     method_option :skip_liquid, type: :boolean, default: false, desc: 'Skip generating liquid templates'
+    method_option :skip_git, type: :boolean, default: false, desc: 'Skip initializing a git repository'
     def init(name)
       Commands::Init.run(options, name)
     end
 
     desc 'clone NAME ID', 'Copy a plugin project from TRMNL server'
+    method_option :skip_git, type: :boolean, default: false, desc: 'Skip initializing a git repository'
     def clone(name, id)
       Commands::Clone.run(options, name, id)
     end

data/lib/trmnlp/commands/clone.rb

@@ -7,7 +7,7 @@ require_relative 'pull'
 module TRMNLP
   module Commands
     class Clone < Base
-      Options = Data.define(:dir, :quiet)
+      Options = Data.define(:dir, :quiet, :skip_git)
 
       def call(directory_name, id)
         authenticate!
@@ -15,7 +15,7 @@ module TRMNLP
         destination_path = Pathname.new(options.dir).join(directory_name)
         raise DirectoryExists, "directory #{destination_path} already exists, aborting" if destination_path.exist?
 
-        Init.run({ dir: options.dir, skip_liquid: true, quiet: true }, directory_name)
+        Init.run({ dir: options.dir, skip_liquid: true, quiet: true, skip_git: options.skip_git }, directory_name)
 
         Pull.run({ dir: destination_path.to_s, force: true, id: id })
 

data/lib/trmnlp/commands/init.rb

@@ -7,7 +7,7 @@ require_relative 'base'
 module TRMNLP
   module Commands
     class Init < Base
-      Options = Data.define(:dir, :quiet, :skip_liquid)
+      Options = Data.define(:dir, :quiet, :skip_liquid, :skip_git)
 
       def call(name)
         destination_dir = Pathname.new(options.dir).join(name)
@@ -17,7 +17,9 @@ module TRMNLP
           destination_dir.mkpath
         end
 
-        template_dir.glob('**/{*,.*}').each do |source_pathname|
+        # NOTE: FNM_DOTMATCH so the glob descends into hidden template
+        # directories (e.g. .github/); without it those files are skipped.
+        template_dir.glob('**/{*,.*}', File::FNM_DOTMATCH).each do |source_pathname|
           next if source_pathname.directory?
           next if options.skip_liquid && source_pathname.extname == '.liquid'
 
@@ -41,6 +43,8 @@ module TRMNLP
           destination_pathname.chmod(destination_pathname.stat.mode | 0o200)
         end
 
+        init_git_repo(destination_dir) unless options.skip_git
+
         reporter.info <<~HEREDOC
 
           To start the local server:
@@ -58,6 +62,13 @@ module TRMNLP
       private
 
       def template_dir = paths.templates_dir.join('init')
+
+      # Make the scaffold a Git repository on `main` so it's ready to push
+      # to GitHub (the workflow's `branches: [main]` trigger requires it,
+      # regardless of the host's init.defaultBranch).
+      # Does nothing when git is unavailable — `system` returns nil rather
+      # than raising, so the scaffold itself still succeeds.
+      def init_git_repo(dir) = system('git', 'init', '-q', '-b', 'main', dir.to_s)
     end
   end
 end

data/lib/trmnlp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TRMNLP
-  VERSION = '0.8.2'
+  VERSION = '0.8.3'
 end

data/templates/init/.github/workflows/trmnl.yml

@@ -0,0 +1,30 @@
+name: TRMNL
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "4.0"
+      - run: gem install trmnl_preview
+      - run: trmnlp lint
+
+  push:
+    needs: lint
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "4.0"
+      - run: gem install trmnl_preview
+      - run: trmnlp push --force
+        env:
+          TRMNL_API_KEY: ${{ secrets.TRMNL_API_KEY }}

data/templates/init/.gitignore

@@ -0,0 +1,2 @@
+# trmnlp build output
+_build/

data/templates/init/src/full.liquid

@@ -1 +1,7 @@
-full!
+<div class="layout layout--col layout--center">
+  <span class="title title--large">Hello, TRMNL!</span>
+</div>
+
+<div class="title_bar">
+  <span class="title">My Plugin</span>
+</div>

data/templates/init/src/half_horizontal.liquid

@@ -1 +1,7 @@
-half horizontal!
+<div class="layout layout--col layout--center">
+  <span class="title title--large">Half horizontal</span>
+</div>
+
+<div class="title_bar">
+  <span class="title">My Plugin</span>
+</div>

data/templates/init/src/half_vertical.liquid

@@ -1 +1,7 @@
-half vertical!
+<div class="layout layout--col layout--center">
+  <span class="title title--large">Half vertical</span>
+</div>
+
+<div class="title_bar">
+  <span class="title">My Plugin</span>
+</div>

data/templates/init/src/quadrant.liquid

@@ -1 +1,7 @@
-quadrant!
+<div class="layout layout--col layout--center">
+  <span class="title title--large">Quadrant</span>
+</div>
+
+<div class="title_bar">
+  <span class="title">My Plugin</span>
+</div>

data/trmnl_preview.gemspec

@@ -21,17 +21,20 @@ Gem::Specification.new do |spec|
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files = Dir.chdir(__dir__) do
-    [
+    files = [
       'bin/**/*',
       'db/**/*',
       'lib/**/*',
-      'templates/**/{*,.*}',
       'web/**/*',
       'CHANGELOG.md',
       'LICENSE.txt',
       'README.md',
       'trmnl_preview.gemspec'
     ].flat_map { |glob| Dir[glob] }
+
+    # FNM_DOTMATCH so the glob descends into the templates' hidden directories
+    # (e.g. .github/) — a plain Dir[] skips them and drops the file from the gem.
+    files + Dir.glob('templates/**/{*,.*}', File::FNM_DOTMATCH)
   end
   spec.bindir = 'bin'
   spec.executables = ['trmnlp']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Rockwell Schrock
@@ -319,6 +319,8 @@ files:
 - lib/trmnlp/user_data_assembler.rb
 - lib/trmnlp/version.rb
 - lib/trmnlp/watcher.rb
+- templates/init/.github/workflows/trmnl.yml
+- templates/init/.gitignore
 - templates/init/.trmnlp.yml
 - templates/init/bin/trmnlp
 - templates/init/src/full.liquid