jekyll-documents 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81bf5267fbf1af10ac172d0b7b0962ffefa222fadd47c7b6dbd1df100ff4ffa4
-  data.tar.gz: dc4c65b4b050e7a64883dc17183cfa02b65c69ccb668d6c56fbc213517f8e599
+  metadata.gz: f4997e7c9ae34ce7462c3fd52a46a1e97c74be3fe1871e489a14eff6c80427d0
+  data.tar.gz: f1df13ca930a08fa219b0871a300a67f3b1569ec1e24d0e6f817b713697ae53d
 SHA512:
-  metadata.gz: b06f57c4a2923181bb8d7612f77935177de32797ee2d7aff40442d13162d629875884a0fb4e9c647415ba60799574f1f92129a19541180c082222af65efed049
-  data.tar.gz: a3fa9c436896180548d9e7ced68ce624a195bdf79ca31951323590876b3b04f13939c7ad437f08f02f080b5644ac68d66e4ac560de0b7a9a7fdcf51e7d982992
+  metadata.gz: adfc57aed564575bd22d4ebe2446331cc3252b6644e0e886b50ebfecdc44a8afa8ba9c305dc95a965d29c3cfd442ba539066d7b05e4fbe7fee521903eb3b9723
+  data.tar.gz: 63336b909cfea4ba2d3fbcd10208e9315261c1b68e5b74fa8c534379b192c75a9dc9e43ef877a2caf3d1db4ae61b59d0c1e2be9a3c3acfe4de93c769cb84dbde

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## [Unreleased]
 
+## [0.7.7] - 2026-10-06
+
+### Added
+
+- `Jekyll::Documents::Interface.to_h` — the public tag/filter/config/enum
+  surface derived from the code constants and the Liquid tag registry,
+  serialized to a committed `interface.yml` by `rake interface` for
+  downstream tooling (e.g. the jekyll-imgflow-vscode parity spec).
+- `spec/interface_spec.rb` pins code ↔ manifest ↔ docs: a stale
+  `interface.yml`, an unmanifested tag/param/config key, or an
+  undocumented tag/param fails the suite.
+- README coverage for `document_icon alt:`, the `{% latest_documents %}`
+  tag options (`count:`/`category:`), and `documents.include_extensions`.
+
+### Security
+
+- Dev-tooling audit gate: `scripts/npm-audit.mjs` + `.audit-allow.json`
+  replace the bare `npm audit` CI step — patchable transitive deps are
+  forced to fixed versions via `overrides` (smol-toml, katex), and only
+  explicitly allowlisted unpatched advisories are tolerated (braces,
+  dev-only, no patched release).
+
 ## [0.7.6] - 2026-09-29
 
 ### Added

data/README.md

@@ -1,7 +1,7 @@
 # jekyll-documents
 
 [![Status: Active](https://img.shields.io/badge/status-active-success)](https://github.com/gundestrup/jekyll-documents)
-[![Tests](https://github.com/gundestrup/jekyll-documents/actions/workflows/test.yml/badge.svg)](https://github.com/gundestrup/jekyll-documents/actions/workflows/test.yml)
+[![Tests](https://github.com/gundestrup/jekyll-documents/actions/workflows/ci.yml/badge.svg)](https://github.com/gundestrup/jekyll-documents/actions/workflows/ci.yml)
 [![Codecov](https://codecov.io/gh/gundestrup/jekyll-documents/graph/badge.svg)](https://codecov.io/gh/gundestrup/jekyll-documents)
 [![Gem Version](https://img.shields.io/gem/v/jekyll-documents)](https://rubygems.org/gems/jekyll-documents)
 [![Gem Downloads](https://img.shields.io/gem/dt/jekyll-documents)](https://rubygems.org/gems/jekyll-documents)
@@ -116,6 +116,17 @@ Link mode renders an `<a>` tag to the category page. List mode renders a `<ul>`
 Use `path:` for an exact, case-sensitive category path, `limit:N` to cap the list, and
 `aggregate:true list:true` to explicitly combine repeated short category names.
 
+**List the most recent documents**:
+
+```liquid
+{% latest_documents %}
+{% latest_documents count:3 %}
+{% latest_documents count:3 category:"minutes" %}
+```
+
+`count:` defaults to `latest_default_count` (5); `category:` filters to a single category.
+Unlike `{% include latest_documents.html %}`, the tag reads its defaults from site config.
+
 ## Document template customization
 
 The document layout provides two optional include hooks. Both are empty by default, and the
@@ -152,7 +163,9 @@ Those remain optional site-level analytics behavior.
 documents:
   root: "assets/documents"
   icon_set: "color"
+  include_extensions: [".pdf", ".docx", ".pptx", ".xlsx", ".odt", ".ods", ".odp"]
   strict_filename: true
+  strict_extensions: true
   resolution_mode: "warn"
 ```
 
@@ -204,6 +217,7 @@ Usage with the `document_icon` tag:
 
 ```liquid
 {% document_icon page class:"document-file-icon icon-x2" %}
+{% document_icon doc alt:"Board minutes" %}
 ```
 
 Or with any `<img>`:

data/interface.yml

@@ -0,0 +1,61 @@
+# Generated by `rake interface` — do not edit.
+# Public tag/filter/config surface for tooling (editor extensions, doc linters).
+---
+gem: jekyll-documents
+version: 0.7.7
+tags:
+  doc_link:
+    params:
+    - icon
+    - path
+    - size
+    - text
+  doc_category:
+    params:
+    - aggregate
+    - limit
+    - list
+    - path
+    - text
+  document_icon:
+    params:
+    - alt
+    - class
+  latest_documents:
+    params:
+    - category
+    - count
+filters:
+- documents_slugify
+- documents_title_from_filename
+- file_type_icon
+- file_type_icon_tag
+config:
+  documents:
+  - categories_from_path
+  - category_map
+  - extract_text
+  - icon_set
+  - include_extensions
+  - json_index
+  - json_index_path
+  - latest_default_count
+  - layout
+  - permalink
+  - resolution_mode
+  - root
+  - slug_danish_map
+  - slug_downcase
+  - strict_extensions
+  - strict_filename
+  - text_cache_dir
+  - text_max_bytes
+enums:
+  icon_set:
+  - color
+  - lines
+  - minimal
+  - ultra-minimal
+  resolution_mode:
+  - strict
+  - warn

data/jekyll-documents.gemspec

@@ -31,7 +31,8 @@ Gem::Specification.new do |spec|
     ">= #{File.read(File.expand_path('.ruby-version', __dir__)).strip[/\d+\.\d+/]}"
 
   spec.files         = Dir.glob("{lib,assets,_includes,_layouts}/**/*") +
-                       ["README.md", "CHANGELOG.md", "LICENSE", "jekyll-documents.gemspec"]
+                       ["README.md", "CHANGELOG.md", "LICENSE", "interface.yml",
+                        "jekyll-documents.gemspec"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "jekyll", ">= 4.4", "< 5.0"

data/lib/jekyll/documents/configuration.rb

@@ -13,7 +13,6 @@ module Jekyll
 
     class Configuration
       RESOLUTION_MODES = %w[warn strict].freeze
-      private_constant :RESOLUTION_MODES
 
       DEFAULTS = {
         "root" => "assets/documents",

data/lib/jekyll/documents/interface.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Documents
+    # Machine-readable description of the plugin's public interface:
+    # Liquid tags + their options, filters, config keys, and enum values.
+    # `rake interface` writes this as interface.yml (shipped in the gem) so
+    # tooling like editor extensions can consume it without parsing Ruby.
+    module Interface
+      TAG_OPTIONS = {
+        "doc_link" => %w[icon path size text],
+        "doc_category" => %w[aggregate limit list path text],
+        "document_icon" => %w[alt class],
+        "latest_documents" => %w[category count]
+      }.freeze
+
+      FILTERS = %w[
+        documents_slugify
+        documents_title_from_filename
+        file_type_icon
+        file_type_icon_tag
+      ].freeze
+
+      def self.to_h
+        {
+          "gem" => "jekyll-documents",
+          "version" => VERSION,
+          "tags" => TAG_OPTIONS.transform_values { |params| { "params" => params } },
+          "filters" => FILTERS,
+          "config" => { "documents" => Configuration::DEFAULTS.keys.sort },
+          "enums" => {
+            "icon_set" => FileTypeIcons::ICON_MAP.keys.sort,
+            "resolution_mode" => Configuration::RESOLUTION_MODES.sort
+          }
+        }
+      end
+    end
+  end
+end

data/lib/jekyll/documents/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Documents
-    VERSION = "0.7.6"
+    VERSION = "0.7.7"
   end
 end

data/lib/jekyll-documents.rb

@@ -20,6 +20,8 @@ require_relative "jekyll/documents/tags/document_icon"
 require_relative "jekyll/documents/tags/doc_link"
 require_relative "jekyll/documents/tags/doc_category"
 
+require_relative "jekyll/documents/interface"
+
 module Jekyll
   module Documents
     # Namespace module for the plugin.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-documents
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - Svend Gundestrup
@@ -147,6 +147,7 @@ files:
 - assets/icons/ultra-minimal/xls.svg
 - assets/icons/ultra-minimal/zip.svg
 - assets/js/documents-search.js
+- interface.yml
 - jekyll-documents.gemspec
 - lib/jekyll-documents.rb
 - lib/jekyll/documents/assets_generator.rb
@@ -154,6 +155,7 @@ files:
 - lib/jekyll/documents/file_type_icons.rb
 - lib/jekyll/documents/filters.rb
 - lib/jekyll/documents/generator.rb
+- lib/jekyll/documents/interface.rb
 - lib/jekyll/documents/json_index_generator.rb
 - lib/jekyll/documents/layout_registrar.rb
 - lib/jekyll/documents/options_parser.rb