trmnl_preview 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e1959e442066534a715efcc371a9c7d4cb41c7dda22727712b12b7b1eb90af
-  data.tar.gz: fbf07c5d835d4981b0380ce774fdfb74edab699c16772e187776ba58a1aee152
+  metadata.gz: fbe879abcadc7c6f7efceb9e54c88606aafd090a9538c9942f8cd3afef9596da
+  data.tar.gz: d9a123366e021a55b8bdc5b55016e38f1f1b4107163bc570a5112d89c8084270
 SHA512:
-  metadata.gz: 8caa7eeef62cb562df06f7e0b3e1fcbf025cabe1f98fcda83fc365a0ee0fa9d8ce70fca9a3c16514a8ce3c320296c234e96e358d45cf3481e2b0451772e8866a
-  data.tar.gz: 01b1248e629516ab0c1857138807a27066f7b4e97be26024dd5e3365152d399e3e301fefcb864eb8e355546a5d5d6149f7c9851a345a3c8f09819099cd54c5bc
+  metadata.gz: 0cd3eb90f4a2231a28dfe8e08097a90bc0d70d93861f9decd1946708b77c0ddf4b5ba3e3dd1acbae0b1daac7238cb88ea74d9f504880adeb1ee7c6ac6402c774
+  data.tar.gz: fbd799614df7d3c978ca2a67fb1b7916b446994bfbd15ce268f764ad0dbd62fed7a34f6c8e63621926490a3eabece74d44b089f3175bd0ad305de7958cf622a1

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 
 # Changelog
 
+## 0.14.1
+
+- `trmnlp lint` reports a `recipe_overview` under 100 words. Below that, TRMNL serves the public recipe page with `robots: noindex`, so the recipe never appears in Google or other search engines, and nothing said so: the page looked fine, and only its HTML gave it away. A blank overview still passes, since private plugins have none. (#144)
+
 ## 0.14.0
 
 - `trmnlp serve` and `build` print what the transform writes to stdout and stderr (`console.log`, `print`, `puts`), one `transform stdout:` / `transform stderr:` line each, so a transform can be debugged without returning its logs in the data. (#128)

data/README.md

@@ -434,7 +434,7 @@ The `settings.yml` file is part of the plugin definition, and is uploaded and do
 
 `description:` is an optional one-line summary of the plugin, up to 35 characters. `trmnlp lint` reports anything longer, and `trmnlp list` shows it next to each plugin name.
 
-`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. 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.
+`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.
 
 See [TRMNL documentation](https://help.trmnl.com/en/articles/10542599-importing-and-exporting-private-plugins#h_581fb988f0) for details on this file's contents.
 

data/lib/trmnlp/lint/checks/recipe_overview_length.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../check'
+
+module TRMNLP
+  module Lint
+    module Checks
+      # Below this many words the hosted service serves the public recipe page
+      # with `robots: noindex`, so search engines drop it. The overview is
+      # optional (private plugins never show one), so a blank value passes.
+      # Words are counted on whitespace; there is no upstream count to match.
+      class RecipeOverviewLength < Check
+        MIN_WORDS = 100
+        MESSAGE = "Recipe overview should be at least #{MIN_WORDS} words long " \
+                  'for the recipe page to appear in Google and other search engines.'.freeze
+
+        private
+
+        def pass?
+          words = source.recipe_overview.split.size
+          words.zero? || words >= MIN_WORDS
+        end
+      end
+    end
+  end
+end

data/lib/trmnlp/lint/source.rb

@@ -17,6 +17,7 @@ module TRMNLP
 
       def plugin_name = settings['name'].to_s
       def plugin_description = settings['description'].to_s
+      def recipe_overview = settings['recipe_overview'].to_s
       def settings = config.plugin.settings
       def custom_field_values = config.project.custom_fields
       def custom_field_definitions = config.plugin.custom_field_definitions

data/lib/trmnlp/lint.rb

@@ -5,6 +5,7 @@ require_relative 'lint/source'
 require_relative 'lint/checks/title_casing'
 require_relative 'lint/checks/title_length'
 require_relative 'lint/checks/description_length'
+require_relative 'lint/checks/recipe_overview_length'
 require_relative 'lint/checks/layouts_have_content'
 require_relative 'lint/checks/no_async_functions'
 require_relative 'lint/checks/waits_for_dom_load'
@@ -25,6 +26,7 @@ module TRMNLP
       Checks::TitleCasing,
       Checks::TitleLength,
       Checks::DescriptionLength,
+      Checks::RecipeOverviewLength,
       Checks::LayoutsHaveContent,
       Checks::NoAsyncFunctions,
       Checks::WaitsForDomLoad,

data/lib/trmnlp/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Rockwell Schrock
@@ -315,6 +315,7 @@ files:
 - lib/trmnlp/lint/checks/no_async_functions.rb
 - lib/trmnlp/lint/checks/no_opacity.rb
 - lib/trmnlp/lint/checks/no_size_classes.rb
+- lib/trmnlp/lint/checks/recipe_overview_length.rb
 - lib/trmnlp/lint/checks/title_casing.rb
 - lib/trmnlp/lint/checks/title_length.rb
 - lib/trmnlp/lint/checks/waits_for_dom_load.rb