trmnl_preview 0.14.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dabcf8ddd9b11d8ce8fc76e389820c7cd4f2d3b48db7aa7848896f9dfb6ec59
-  data.tar.gz: 467322fc910fdfed1ed5c37bb9773a7256d3d8f1f44683e2c9e4f3882b4ab7df
+  metadata.gz: 2460473710692cd80df450f411bdf811e44a9da068600b45db871c9e00ce0651
+  data.tar.gz: b34619a0fccac692176089ae44fe45c4c040a04bb2ca7035031750f768adc73d
 SHA512:
-  metadata.gz: 75747b93b8aa45ac964b1ae87ef0dd50134c836bf5bc4bef19e47f166132b1dfca6edf8744f967702be6ffdc4c80c7b9b725646443053708f2d74df37a8537e9
-  data.tar.gz: b6fa8f755ab31f3dae9a3c2773ced039f646c7363288ae27512d0e3a95e72143093ca2869cb26a402084dd1b66c6c2dfc29a022ef8fed84bbb6e18fa5ffed347
+  metadata.gz: 8de469fd1f6f81023ac8b3ad25168dce59f68a731a5814fc845e8a6155996e0800a7d5871e0d89fbd009bc910ad6b497f5a4dc6186025f60a79f758df31aaab1
+  data.tar.gz: b0bf8c9737e32bb67b3489de471c29ce78b03a4a40fcef69916834477d5daa0d3a4a89dcdaca68e411f20a1cafb5e91142216ae85c2e3d3a6e42a94f5fe944cf

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 
 # Changelog
 
+## 0.16.0
+
+- Webhook posts must wrap their data in `merge_variables`, as TRMNL requires, and `merge_strategy` (`replace`, `deep_merge`, or `stream` with `stream_limit`) works from the body or the query string. A post without the wrapper is refused with TRMNL's message and a 422; a body that is not JSON gets a 400. Before, trmnlp stored the raw body and always answered 200, so a correct post rendered its data under `merge_variables.*`. A post over 5 kB is stored with a warning, since trmnlp cannot know your plan's limit. (#155)
+- Polled and posted data is cached per project, so two plugins no longer share one `data.json`. Data cached by an older trmnlp is not read: a polling plugin polls again on start, and a webhook plugin needs one new post. (#155)
+- A webhook plugin with a transform runs it once, when a post arrives, and stores the result, as TRMNL does; renders no longer run it. A transform's `trmnl_state` comes back as `trmnl.state` on its next run and in the markup, and `trmnl.previous_merge_variables` carries what the last run stored. (#155)
+- `trmnl.plugin_settings` carries the plugin's name as `instance_name`, plus `no_screen_padding` and `data_fetched_utc`; `polling_url` appears only for a polling plugin and is the unrendered url; `polling_headers` is gone. `trmnl.device` carries `orientation` from the picker. The `trmnl` namespace now wins over a `trmnl` key in fetched data, as on TRMNL. (#155, #158)
+- `dark_mode: 'yes'` darkens every render, `trmnlp build` and PNGs included, and a dark render gets the bare `dark-mode` class Framework 1.x inverts on. The default font class is `screen--fonts-trmnl`, the picker's `screen--1x` is dropped, and a theme select adds `screen--theme-*` with the theme's stylesheet on Framework 3.2.0 and later. `window.I18n.andXMore` uses the user's locale. (#155)
+- A select custom field saves what TRMNL saves: "New York" as `new_york`, a `{ Label: value }` option as its value. The editor saved the label, so `{% if units == "metric" %}` matched only on TRMNL. A label already in `.trmnlp.yml` is read as its value. (#158)
+- A custom field's `default` fills a blank value, in the markup and in the polling url, headers and body, and a custom field set to `{{ env.X }}` in `.trmnlp.yml` reaches the markup filled in, as it already did for polling. Polling is skipped with TRMNL's "Plugin is not configured" message while a field the url needs is blank. (#158)
+- Polling follows TRMNL: the url, headers and body render with the `trmnl` namespace; urls split on CR or LF and drop blank lines; a GET sends the polling body as its query string; up to 5 redirects are followed, dropping `Authorization` when the host changes; reads time out after 10 s with one retry; a 429 or 5xx is a failed fetch while a 4xx body still renders; CSV, markdown, a byte order mark and an unlisted content type parse as on TRMNL. A url that resolves to a private address gets a warning, since TRMNL refuses it, but is still fetched. Logs and warnings leave out the query string, which often holds an api key. (#158)
+- Merge variables over 100 kB fail the render with TRMNL's message. A transform stops after 5 s, gets `trmnl.oauth` when an account is connected, keeps the last good output when it fails, and renders nothing from an output that is not an object. (#158)
+- `l_word`, `l_date`, `pluralize` and `number_to_currency` render as on TRMNL in its 29 locales: `pluralize` gave "3 persons", `number_to_currency: "de"` gave `de1,234.50`, and any non-English `l_word` or `l_date` raised. The locale data is copied from trmnl-i18n and rails-i18n into `db/data/locales` by `rake i18n:sync`, so trmnlp needs no Rails gems. (#156)
+- PNG renders follow TRMNL's renderer: a page dithers only when it asks for it with `image-dither`, otherwise it is posterized with TRMNL's ImageMagick steps, and the capture waits for the Framework's ready signals (up to 5 s, 12 s with a map). Highcharts charts rendered blank, since the unversioned CDN url refuses a page with no Referer; they now load TRMNL's 12.3.0 copy. Text is no longer drawn with antialiasing turned off, which brings it closer to TRMNL's own PNGs. (#157)
+- The `async_polling` strategy works locally: `{{ callback_url }}` points at the preview server, and the callback answers as TRMNL does, 410 for a stale or expired request. The `plugin_merge` strategy works too: list each referenced plugin as `<keyname>_<id>: <path to its trmnlp project>` under `merged_plugins` in `.trmnlp.yml`, and the markup gets TRMNL's merged data. (#160)
+- `trmnlp lint` reports a filter that only `custom_filters` in `.trmnlp.yml` defines (`no_custom_filters`). TRMNL does not load those modules and outputs the value unfiltered. (#159)
+
+## 0.15.0
+
+- `trmnlp lint` names where each finding is: a rule ID such as `[no_opacity]`, then the file, line and column with the source line. Before, it printed only the message, so you had to search every view and Shared for the cause. `trmnlp lint --format json` writes the same report as one JSON object (`version`, `passed`, `issues`) for CI. Exit statuses are unchanged, and the values of unused custom fields in `.trmnlp.yml` are never printed. (#153)
+- The inline-style check counts real CSS declarations in `style` attributes, still with a limit of six. It counted eight property names anywhere in the markup, so `font-size` in an HTML comment or a `<style>` block failed while seven `style="color:red"` passed. Comments, scripts, text and `<style>` blocks no longer count, and declarations inside Liquid `{% if %}` branches all count. (#152)
+
 ## 0.14.2
 
 - A failed transform prints its stderr once. The `transform failed:` line repeated the whole stack trace that the `transform stderr:` line had just printed; it now names only the exit code. The preview page still shows the full error. (#148)

data/README.md

@@ -99,6 +99,30 @@ trmnlp push                    # upload
 
 `trmnlp lint` exits non-zero when it finds issues, so you can gate CI on it. Run `trmnlp help` for all flags.
 
+Lint findings include a stable snake_case rule ID, severity and source locations.
+Locations use project-relative paths and one-based line/column numbers, followed
+by a source excerpt (up to 240 characters). Aggregate checks show their contributing
+locations; checks for a missing chart setting show the related Highcharts usage.
+Unused project custom-field values are omitted from excerpts because they can
+contain credentials.
+
+For CI integrations, use `trmnlp lint --format json`. It writes one JSON object
+with `version: 1`, `passed` and an `issues` array. Each issue has `rule_id`,
+`severity`, `message`, `locations` and, when available, `learn_more`. Each location
+has `path`, `line`, `column` and `snippet`. A clean report has `passed: true` and
+`issues: []`. All existing checks retain severity `error` and the same exit status:
+zero when clean, nonzero when findings exist. `--quiet` suppresses either format.
+
+The inline-style check counts CSS declarations in actual HTML `style` attributes,
+with a limit of six across the view templates and Shared. All property names count,
+including custom properties. HTML/Liquid comments, script strings, text,
+`data-*` attributes and `<style>` blocks are excluded from this inline check.
+Liquid in declaration values is counted without rendering the plugin, every branch included.
+
+Filters from `custom_filters` in `.trmnlp.yml` exist only in trmnlp. TRMNL does not load them
+and outputs the value unfiltered, so `no_custom_filters` reports each place the markup uses one.
+Filters that trmnl-liquid also provides are not reported.
+
 ## Building Static Files
 
 `trmnlp build` renders every view to a static file under `_build/` — handy for exporting a snapshot or feeding the output into another pipeline. Run it from inside a plugin project:
@@ -314,8 +338,15 @@ variables:
     plugin_settings:
       instance_name: Kevin Bacon Facts
 
+# plugin_merge strategy: the plugins this one reads, as "<keyname>_<id>" on TRMNL,
+# each mapped to the trmnlp project whose last fetched data stands in for it
+merged_plugins:
+  private_plugin_42: ../weather
 ```
 
+An `async_polling` plugin gets `{{ callback_url }}` in its polling url. It points at
+`trmnlp serve`'s `/callback` route, where the API posts `merge_variables` after answering 202.
+
 ## OAuth2
 
 This feature is in beta. Please report incorrect behaviour at https://github.com/usetrmnl/trmnlp/issues.

data/db/data/and_x_more.yml

@@ -0,0 +1,86 @@
+# Mirrored from trmnl-i18n renders.and_x_more_* (window.I18n.andXMore).
+# Refresh with `rake i18n:sync[trmnl_i18n_path,rails_i18n_path]` — do not edit manually.
+cs:
+- A
+- více
+da:
+- Og
+- mere
+de-AT:
+- und
+- weitere
+de:
+- und
+- weitere
+en:
+- And
+- more
+es-ES:
+- "y"
+- más
+fr:
+- Et
+- de plus
+he:
+- And
+- more
+hu:
+- És
+- további
+id:
+- And
+- more
+is:
+- Og
+- fleiri
+it:
+- e
+- più
+ja:
+- And
+- more
+ko:
+- And
+- 개 더
+lt:
+- Ir dar
+- daugiau
+nl:
+- En nog
+- more
+'no':
+- And
+- more
+pl:
+- i
+- więcej
+pt-BR:
+- E
+- mais
+raw:
+- renders.and_x_more_prefix
+- renders.and_x_more_suffix
+ro:
+- Și
+- mai mult
+ru:
+- И
+- ещё
+sk:
+- A
+- ďalšie
+sl:
+- in še
+- ''
+sv:
+- And
+- more
+uk:
+- And
+- more
+zh-CN:
+- 及其他
+- 项
+zh-HK:
+- 還有
+- 個

data/db/data/locales/cs.yml

@@ -0,0 +1,339 @@
+# Mirrored from trmnl-i18n custom_plugins and rails-i18n date, time, number.
+# Refresh with `rake i18n:sync[trmnl_i18n_path,rails_i18n_path]` — do not edit manually.
+cs:
+  custom_plugins:
+    today: dnes
+    tomorrow: zítra
+    updated: Aktualizováno
+    activity: Aktivita
+    done: Hotovo
+    due: Termín
+    deutsche_bahn_departures:
+      departures: Odjezdy
+      time: Čas
+      line: Linka
+      destination: Cíl
+      platform: Nástupiště
+      delay: Zpoždění
+      train: Vlak
+      on_time: Na čas
+      cancelled: Zrušeno
+      minutes: min
+      refreshed: Obnoveno
+    simple_calendar:
+      title: Kalendář
+      ym_format: "%B %Y"
+      chinese_korean:
+        leap_format: Přestupný %{month_label}
+        leap_format_short: PM%{alt_month}
+        ym_format: ", %{leap_month_label} %{heavenly_stem} %{earthly_branch}"
+        month_labels:
+        -
+        - M1
+        - M2
+        - M3
+        - M4
+        - M5
+        - M6
+        - M7
+        - M8
+        - M9
+        - M10
+        - M11
+        - M12
+        date_labels:
+        -
+        - '1'
+        - '2'
+        - '3'
+        - '4'
+        - '5'
+        - '6'
+        - '7'
+        - '8'
+        - '9'
+        - '10'
+        - '11'
+        - '12'
+        - '13'
+        - '14'
+        - '15'
+        - '16'
+        - '17'
+        - '18'
+        - '19'
+        - '20'
+        - '21'
+        - '22'
+        - '23'
+        - '24'
+        - '25'
+        - '26'
+        - '27'
+        - '28'
+        - '29'
+        - '30'
+        heavenly_stems:
+        - Dřevo
+        - Dřevo
+        - Oheň
+        - Oheň
+        - Země
+        - Země
+        - Kov
+        - Kov
+        - Voda
+        - Voda
+        earthly_branches:
+        - Krysa
+        - Vůl
+        - Tygr
+        - Králík
+        - Drak
+        - Had
+        - Kůň
+        - Koza
+        - Opice
+        - Kohout
+        - Pes
+        - Vepř
+        zodiac_animals:
+        - Rat
+        - Ox
+        - Tiger
+        - Rabbit
+        - Dragon
+        - Snake
+        - Horse
+        - Goat
+        - Monkey
+        - Rooster
+        - Dog
+        - Pig
+        solar_terms:
+        - Minor Cold
+        - Major Cold
+        - Start of Spring
+        - Rain Water
+        - Awakening of Insects
+        - Spring Equinox
+        - Pure Brightness
+        - Grain Rain
+        - Start of Summer
+        - Grain Buds
+        - Grain in Ear
+        - Summer Solstice
+        - Minor Heat
+        - Major Heat
+        - Start of Autumn
+        - End of Heat
+        - White Dew
+        - Autumn Equinox
+        - Cold Dew
+        - Frost's Descent
+        - Start of Winter
+        - Minor Snow
+        - Major Snow
+        - Winter Solstice
+      japanese:
+        rokuyo_terms:
+        - 先勝
+        - 友引
+        - 先負
+        - 仏滅
+        - 大安
+        - 赤口
+        nengo:
+          reiwa: Reiwa
+        ym_format: "%B %Y (%{nengo} %{alt_year})"
+        year_1: '1'
+      hebrew:
+        ym_format: ", %{month_label} %{alt_year}"
+        month_labels:
+        - Nisan
+        - Ijar
+        - Sivan
+        - Tamuz
+        - Av
+        - Elul
+        - Tišri
+        - Chešvan
+        - Kislev
+        - Tevet
+        - Ševat
+        - Adar
+        - Adar I
+        - Adar II
+        month_labels_abbr:
+        - Nis
+        - Ija
+        - Siv
+        - Tam
+        - Av
+        - Elu
+        - Tiš
+        - Che
+        - Kis
+        - Tev
+        - Šev
+        - Ada
+        - Ad1
+        - Ad2
+      hijri:
+        ym_format: ", %{month_label} %{alt_year}"
+        month_labels:
+        -
+        - Muharram
+        - Safar
+        - Rabíʻ I
+        - Rabíʻ II
+        - Džumádá I
+        - Džumádá II
+        - Radžab
+        - Šaʻbán
+        - Ramadán
+        - Šawwál
+        - Dhú al-ki'da
+        - Dhú al-hidždža
+      bengali:
+        ym_format: ", %{month_label} %{alt_year}"
+        month_labels:
+        -
+        - Boishakh
+        - Joishtho
+        - Asharh
+        - Srabon
+        - Bhadro
+        - Ashwin
+        - Kartika
+        - Ogrohayon
+        - Poush
+        - Magh
+        - Falgun
+        - Choitro
+      indian:
+        ym_format: ", %{month_label} %{alt_year}"
+        month_labels:
+        -
+        - Chaitra
+        - Vaisakha
+        - Jyaistha
+        - Asadha
+        - Sravana
+        - Bhadra
+        - Asvina
+        - Kartika
+        - Agrahayana
+        - Pausa
+        - Magha
+        - Phalguna
+    public_recipe_stats:
+      connections: ".input {$value :number} .match $value zero {{Žádná připojení}}
+        one {{{$value :number} připojení}} * {{{$value :number} připojení}}"
+      forks: ".input {$value :number} .match $value zero {{Žádný fork}} one {{{$value
+        :number} fork}} * {{{$value :number} forků}}"
+      installs: ".input {$value :number} .match $value zero {{Žádná instalace}} one
+        {{{$value :number} instalace}} * {{{$value :number} instalací}}"
+      and_more: a {$value :number} dalších
+      error_keyword_title: "“{$keyword}” neodpovídá žádnému výsledku."
+      error_keyword_subtitle: Zkuste vyhledat něco jiného.
+      error_new_title: Nebyl nalezen žádný nový recept.
+      error_new_subtitle: To by se nemělo stávat.
+      error_self_title: Nepublikovali jste žádný recept.
+      error_self_subtitle: Jak publikovat svůj první recept, se dozvíte na https://help.trmnl.com/en/articles/9510536-private-plugins
+      error_author_id_title: 'Uživatel #{$authorId} nepublikoval žádný recept.'
+      error_author_id_subtitle: S tímto ID nebyl nalezen žádný recept.
+      error_recipe_ids_title: Nebylo nalezeno žádné ID receptu.
+      error_recipe_ids_subtitle: Chcete-li začít, přidejte ID receptu.
+    horizontal_world_clock:
+      name: Světové hodiny
+    language_learning_sentences:
+      from_to: Z jazyka {$from :langName} do {$to :langNameList}
+    custom_next_holiday:
+      next_holiday: Příští svátek
+      today_and_next: ".input {$nextDays :number} .match $nextDays one {{ {#mainLabel}Dnes
+        je{/mainLabel}{#br/}{#mainValue}{$name}{/mainValue}{#br/}{#subLabel}Zítra
+        je {$nextName}.{/subLabel} }}* {{ {#mainLabel}Dnes je{/mainLabel}{#br/}{#mainValue}{$name}{/mainValue}{#br/}{#subLabel}Příští
+        svátek je {$nextName} za {$nextDays} dní.{/subLabel} }}"
+      today_only: "{#mainLabel}Dnes je{/mainLabel}{#br/}{#mainValue}{$name}{/mainValue}"
+      next_only: ".input {$nextDays :number} .match $nextDays one {{ {#mainLabel}Zítra
+        je{/mainLabel}{#br/}{#mainValue}{$nextName}{/mainValue} }}* {{ {#mainValue}{$nextDays}{/mainValue}{#mainLabel}
+        dní do{/mainLabel}{#br/}{#mainValue}{$nextName}{/mainValue} }}"
+      no_holidays: "{#subLabel}Konec přidaných svátků.{/subLabel}"
+    sun_chart: Sun Chart
+  date:
+    abbr_day_names:
+    - Ne
+    - Po
+    - Út
+    - St
+    - Čt
+    - Pá
+    - So
+    abbr_month_names:
+    -
+    - Led
+    - Úno
+    - Bře
+    - Dub
+    - Kvě
+    - Čvn
+    - Čvc
+    - Srp
+    - Zář
+    - Říj
+    - Lis
+    - Pro
+    day_names:
+    - Neděle
+    - Pondělí
+    - Úterý
+    - Středa
+    - Čtvrtek
+    - Pátek
+    - Sobota
+    formats:
+      default: "%d. %m. %Y"
+      long: "%d. %B %Y"
+      short: "%d %b"
+    month_names:
+    -
+    - Leden
+    - Únor
+    - Březen
+    - Duben
+    - Květen
+    - Červen
+    - Červenec
+    - Srpen
+    - Září
+    - Říjen
+    - Listopad
+    - Prosinec
+    order:
+    - :day
+    - :month
+    - :year
+  time:
+    am: dopoledne
+    formats:
+      default: "%a %e. %B %Y %H:%M %z"
+      long: "%A %e. %B %Y %H:%M"
+      short: "%e. %-m. %H:%M"
+    pm: odpoledne
+  number:
+    currency:
+      format:
+        delimiter: " "
+        format: "%n %u"
+        precision: 2
+        separator: ","
+        significant: false
+        strip_insignificant_zeros: false
+        unit: Kč
+    format:
+      delimiter: "."
+      precision: 3
+      separator: ","
+      significant: false
+      strip_insignificant_zeros: false