trmnl_preview 0.23.1 → 0.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -0
- data/README.md +2 -0
- data/db/data/framework_classes.yml +1043 -0
- data/lib/trmnlp/lint/checks/author_contact_method.rb +28 -0
- data/lib/trmnlp/lint/checks/coordinates_use_lat_lon.rb +40 -0
- data/lib/trmnlp/lint/checks/framework_classes_exist.rb +42 -0
- data/lib/trmnlp/lint/checks/limited_inline_styles.rb +2 -1
- data/lib/trmnlp/lint/checks/no_external_qr_codes.rb +23 -0
- data/lib/trmnlp/lint/checks/no_nested_layouts.rb +25 -0
- data/lib/trmnlp/lint/checks/title_bar_outside_layout.rb +25 -0
- data/lib/trmnlp/lint/checks/yes_no_selects_are_boolean.rb +35 -0
- data/lib/trmnlp/lint/diagnostic.rb +4 -1
- data/lib/trmnlp/lint/source.rb +19 -0
- data/lib/trmnlp/lint.rb +15 -1
- data/lib/trmnlp/testing/publishable_recipe.rb +2 -1
- data/lib/trmnlp/testing/report.html.erb +7 -0
- data/lib/trmnlp/testing/report.rb +29 -3
- data/lib/trmnlp/version.rb +1 -1
- metadata +9 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 70b815c128b20e0573632c988b2b170eb1721c5715af5a590e294315b2b0ea53
|
|
4
|
+
data.tar.gz: 101648b396d697a8f19fcfc91b342bd008b982cc59467b9a051726cc0d320540
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: caa796947c50819b618aefc48602524691a541adbb39b56b588fc85f5b95ca2ea323310e85ab20af4d33911f781f582e218fab1e3d56a2717679cccd90311894
|
|
7
|
+
data.tar.gz: bc0a881a929cf6548518f21e05f6ca7264a114dd1db1de178d203cfe1c853e583b67b9fef53de8f9617ccff2e7e8784eb064b46354934ca7ee7654913331e3d5
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,19 @@
|
|
|
1
1
|
|
|
2
2
|
# Changelog
|
|
3
3
|
|
|
4
|
+
## 0.25.0
|
|
5
|
+
|
|
6
|
+
- `trmnlp lint` also reports a `content--` class that the plugin's Framework release does not have (`framework_classes_exist`), such as `content--xsmall`. Rich Text sizes stop at `content--small`, and a missing one leaves the text at the default size.
|
|
7
|
+
|
|
8
|
+
## 0.24.0
|
|
9
|
+
|
|
10
|
+
- `it_behaves_like 'a publishable recipe'` names a screen's palette and dark mode in its examples, so a group that draws the TRMNL X in color and in 1-bit, or in light and dark, can tell them apart.
|
|
11
|
+
- `trmnlp test --report` writes `og-vs-x.png`: the full view on TRMNL OG and TRMNL X side by side at the same height, first on the report page and as `og_vs_x` in `report.json`. It shows a recipe whose content is small on the X with a lot of empty space.
|
|
12
|
+
- `trmnlp lint` reports a `select` form field with only Yes and No options (`yes_no_selects_are_boolean`), which should be a `boolean` switch, and separate latitude and longitude fields (`coordinates_use_lat_lon`), which should be one `lat_lon` field.
|
|
13
|
+
- `trmnlp lint` reports a plugin whose `author_bio` custom field gives no email address, web link or GitHub link. TRMNL's recipe review asks for one, and a Discord link alone is not enough.
|
|
14
|
+
- `trmnlp lint` reports a `title_bar` inside a `layout` (`title_bar_outside_layout`), a `layout` inside another `layout` (`no_nested_layouts`), and a `value--`, `label--`, `title--`, `description--` or `text--` class that the plugin's Framework release does not have (`framework_classes_exist`), such as `value--medium`. TRMNL renders all three wrong or not at all and says nothing. The class lists come from each release's `plugins.css`; `rake framework:classes` refreshes them.
|
|
15
|
+
- `trmnlp lint` reports a QR code image loaded from an external service, such as api.qrserver.com or quickchart.io/qr, in an `<img>` src or a CSS `url()` (`no_external_qr_codes`). TRMNL asks recipes to use the built-in `qr_code` Liquid filter.
|
|
16
|
+
|
|
4
17
|
## 0.23.1
|
|
5
18
|
|
|
6
19
|
- A transform that prints more than about 64 KB no longer hangs until its timeout in `trmnlp test` and `trmnlp serve`; its output is read while it runs.
|
data/README.md
CHANGED
|
@@ -504,6 +504,8 @@ The `settings.yml` file is part of the plugin definition, and is uploaded and do
|
|
|
504
504
|
|
|
505
505
|
`recipe_overview:` is optional free text for a published recipe, with no length limit. TRMNL shows it on the public recipe page with its line breaks kept, and its first 120 characters feed the page's link preview. An overview of at least 100 words lets the recipe appear in Google and other search engines; `trmnlp lint` reports one that is shorter. Put credits and links in an About This Plugin field instead. Leave the key out to keep the overview already on TRMNL; an empty value clears it.
|
|
506
506
|
|
|
507
|
+
A recipe needs a custom field with `field_type: author_bio` that gives users a way to reach the author: an `email_address`, a `github_url`, a `learn_more_url`, or an email address or link in its `description`. `trmnlp lint` reports a recipe without one. A Discord link or handle alone is not enough, because not every user has access to Discord.
|
|
508
|
+
|
|
507
509
|
See [TRMNL documentation](https://help.trmnl.com/en/articles/10542599-importing-and-exporting-private-plugins#h_581fb988f0) for details on this file's contents.
|
|
508
510
|
|
|
509
511
|
|