bridgetown-quick-search 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edcd790fbcac2d5d75f5f175df2ce441842690553e4bc5af167948e5aaedc68f
-  data.tar.gz: b31f224d49d765c284cdd0c69d86261696edadfe5ead4eee0b929776df3a5621
+  metadata.gz: 82f0598d813d41f5adf998da7b1215d26fba0f38a7e7a8cd2dc652585d61c561
+  data.tar.gz: 19cf61b695cf9b70db82ad90779b7471f3320bdd5b2f3c6c7b1df73f9b876c8e
 SHA512:
-  metadata.gz: e2080d0597d679be8792a25b92145bf0f6c081717f1ec8870f56a75d399994d6fe119176e8fde45a23321359b2758274fe5cec54307902f857203bc61df07eaf
-  data.tar.gz: be7099b617e6e8620db736ef2e2d18df2beace96c697f83bfb10d22ace83d3447a6d759132859237f0ca7182231d0032e23a8a1843e95b3cbbdbf1c65f9fa6ea
+  metadata.gz: b98df2b8a247dfad28afca8c73b2ca596754552c0fa27754cc8a791a1fae428a99877d546785ea9299e5508f32f593f5eaf33d80e4cd6a1ce7042f78c3f72039
+  data.tar.gz: e5b0940fff821ef9c5b7f52b93d8fdb515ae28fff609cbd2223a4f038b64fcc5914680d01397a53d24fcc2037cd0d90bc79611a66a6ba2fccce2b26832d86903

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_gem:
   rubocop-bridgetown: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
 
   Exclude:
     - Rakefile

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 3.0.0 / 2024-07-30
+
+* Add collection name to preview title [#26] @thimy
+* Add quick_search_content front matter overrides [#21] @copiousfreetime
+* Add support for Bridgetown 2.0
+* Switch to much improved esbuild build system for the repo
+
 ## 2.0.0 / 2022-10-08
 
 * Upgrade to new initializer system for Bridgetown 1.2

data/README.md

@@ -1,34 +1,29 @@
 # Bridgetown Quick Search plugin
 
-_Requires Bridgetown v0.15 or greater_
-
 This [Bridgetown](https://www.bridgetownrb.com) plugin provides a component you can add to your site (likely the top navbar) to allow fast, real-time search of your posts, pages, and other collection documents. It automatically generates a JSON index file which gets built along with the rest of the site, and then the component consumes that file and uses [Lunr.js](https://lunrjs.com) to construct the live search index and provide the search results as you type.
 
 ----
 
-## Installation
+## Installation for Bridgetown 1.2+
 
 Run this command to add this plugin to your site's Gemfile:
 
 ```shell
-$ bundle add bridgetown-quick-search -g bridgetown_plugins
+$ bundle add bridgetown-quick-search
 ```
 
-Next, add this line to the top of your frontend's Javascript index file:
-
-```js
-// frontend/javascript/index.js
+And then add the initializer to your configuration in `config/initializers.rb`:
 
-import "bridgetown-quick-search"
+```ruby
+init :"bridgetown-quick-search"
 ```
 
-Or if you need a precompiled version (without experimental decorators), you can instead
-add the following:
+Next, add this line to the top of your frontend's Javascript index file:
 
 ```js
 // frontend/javascript/index.js
 
-import "bridgetown-quick-search/dist"
+import "bridgetown-quick-search"
 ```
 
 Then add the Liquid component to one of your site templates, for example `src/_components/navbar.liquid`:
@@ -51,11 +46,12 @@ You can provide additional Liquid variables to the component to configure its ap
 * `input_class`: Add custom CSS class names to the input control
 * `theme`: The component's default theme is a "light" appearance, but you can also set it to use a "dark" appearance
 * `snippet_length`: The length of the text snippet for each search result. Defaults to 142.
+* `display_collection`: Will show collections to which belong search results if true. Defaults to false.
 
 Here's an example of using all variables at once:
 
 ```html
-{% render "bridgetown_quick_search/search", placeholder: "Search", input_class: "input", theme: "dark", snippet_length: 200 %}
+{% render "bridgetown_quick_search/search", placeholder: "Search", input_class: "input", theme: "dark", snippet_length: 200, display_collection: true %}
 ```
 
 ## Styling
@@ -88,7 +84,10 @@ bridgetown-search-results::part(inner-link) {
 
 ## Controlling the Search Index
 
-You can add `exclude_from_search: true` to the front matter of any page or document to exclude it from the search index JSON. To batch-exclude pages, collections, categories, etc., you could use front matter defaults to set the `exclude_from_search` variable.
+You can provide additional front matter variables to any page or document to control the search index. These are:
+
+* `exclude_from_search: true`: Setting this will exclude that item from the search index JSON. To batch-exclude pages, collections, categories, etc., you could use front matter defaults to set the `exclude_from_search` variable.
+* `quick_search_content: "content for the index"`: Setting this will override the content in the search index JSON. Normally the content in the search index JSON is the content of the page. Setting this front matter variable explicilty sets the content in the search index JSON.
 
 ## Testing
 

data/bridgetown-quick-search.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Bridgetown::QuickSearch::VERSION
   spec.author        = "Bridgetown Team"
   spec.email         = "maintainers@bridgetownrb.com"
-  spec.summary       = "A Liquid + Web Component for Bridgetown sites which performs search queries with Lunr.js."
+  spec.summary       = "A component for Bridgetown sites which performs search queries with Lunr.js."
   spec.homepage      = "https://github.com/bridgetownrb/bridgetown-quick-search"
   spec.license       = "MIT"
 
@@ -16,13 +16,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.metadata      = { "yarn-add" => "bridgetown-quick-search@#{Bridgetown::QuickSearch::VERSION}" }
 
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.1.0"
 
-  spec.add_dependency "bridgetown", ">= 1.2.0.beta2", "< 2.0"
+  spec.add_dependency "bridgetown", ">= 1.2.0.beta2", "< 3.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "nokogiri", "~> 1.6"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
 end

data/components/bridgetown_quick_search/search.liquid

@@ -4,8 +4,9 @@ variables:
   placeholder?: [string, Placeholder text for the search input control.]
   theme: [string, Dark or Light theme ("dark" or "light"). Defaults to light.]
   snippet_length?: [integer, Length of the result text snippet. Defaults to 142.] 
+  display_collection?: [boolean, Displays the collection name. Defaults to false.]
 {% endcomment %}
 <bridgetown-search-form>
   <input slot="input" type="search" class="{{ input_class }}" placeholder="{{ placeholder }}" />
-  <bridgetown-search-results {% if snippet_length %}snippetlength="{{ snippet_length }}" {% endif %}theme="{% if theme %}{{ theme }}{% endif %}"></bridgetown-search-results>
+  <bridgetown-search-results {% if snippet_length %}snippetlength="{{ snippet_length }}" {% endif %}theme="{% if theme %}{{ theme }} {% endif %}"{% if display_collection %} displayCollection="{{ display_collection }}"{% endif %}></bridgetown-search-results>
 </bridgetown-search-form>

data/content/bridgetown_quick_search/index.json

@@ -1,15 +1,17 @@
 ---
 template_engine: liquid
+layout: none
+exclude_from_search: true
 ---
 [
   {%- assign looped = false %}
-  {%- assign documents = site.documents %}
-  {%- if site.content_engine == "resource" %}{% assign documents = site.resources %}{% endif %}
+  {%- assign documents = site.resources %}
   {%- for document in documents %}
     {%- if document.title %}
       {%- unless document.exclude_from_search or document.id == "" %}
-        {%- assign url = document.url %}
-        {%- if site.content_engine == "resource" %}{% assign url = document.relative_url %}{% endif %}
+        {%- assign url = document.relative_url %}
+        {%- assign content = document.content %}
+        {%- if document.quick_search_content %}{% assign content = document.quick_search_content %}{% endif %}
         {%- if looped %},{% endif %}
         {
           "id": "{{ url | slugify }}",
@@ -23,7 +25,7 @@ template_engine: liquid
           "categories": {{ document.categories | join: ", " | jsonify }},
           "tags": {{ document.tags | join: ", " | jsonify }},
           "url": {{ url | jsonify }},
-          "content": {{ document.content | strip_html | replace_regex: "[\s/\n]+"," " | strip | jsonify }}
+          "content": {{ content | strip_html | replace_regex: "[\s/\n]+"," " | strip | jsonify }}
         }
         {%- assign looped = true %}
       {%- endunless %}
@@ -34,13 +36,15 @@ template_engine: liquid
       {%- if document.title %}
         {%- unless document.exclude_from_search %}
           {%- if looped %},{% endif %}
+          {%- assign content = document.content %}
+          {%- if document.quick_search_content %}{% assign content = document.quick_search_content %}{% endif %}
           {
             "id": "{{ document.url | slugify }}",
             "title": {{ document.title | jsonify }},
             "categories": {{ document.categories | join: ", " | jsonify }},
             "tags": {{ document.tags | join: ", " | jsonify }},
             "url": {{ document.url | jsonify }},
-            "content": {{ document.content | strip_html | replace_regex: "[\s/\n]+"," " | strip | jsonify }}
+            "content": {{ content | strip_html | replace_regex: "[\s/\n]+"," " | strip | jsonify }}
           }
         {%- endunless %}
       {%- endif %}

data/lib/bridgetown-quick-search/version.rb

@@ -2,6 +2,6 @@
 
 module Bridgetown
   module QuickSearch
-    VERSION = "2.0.0"
+    VERSION = "3.0.0"
   end
 end

data/package.json

@@ -1,10 +1,13 @@
 {
   "name": "bridgetown-quick-search",
-  "version": "2.0.0",
-  "main": "frontend/javascript/index.js",
-  "module": "frontend/javascript/index.js",
+  "version": "3.0.0",
+  "main": "frontend/dist/index.js",
   "exports": {
-    ".": "./frontend/javascript/index.js",
+    ".": "./frontend/dist/index.js",
+    "./javascript": {
+      "browser": "./frontend/javascript/index.js",
+      "import": "./frontend/javascript/index.js"
+    },
     "./dist": {
       "browser": "./frontend/dist/index.js",
       "import": "./frontend/dist/index.js"
@@ -22,17 +25,13 @@
     "frontend"
   ],
   "scripts": {
-    "build": "babel ./frontend/javascript --out-dir ./frontend/dist"
+    "build": "esbuild frontend/javascript/index.js --bundle --outdir=frontend/dist --format=esm"
   },
   "dependencies": {
-    "@babel/runtime": "^7.10.1",
-    "lit": "^2.0.0",
+    "lit": "^3.1.0",
     "lunr": "^2.3.8"
   },
   "devDependencies": {
-    "@babel/cli": "^7.12.1",
-    "@babel/core": "^7.12.3",
-    "@babel/plugin-proposal-class-properties": "^7.12.1",
-    "@babel/plugin-proposal-decorators": "^7.12.1"
+    "esbuild": "^0.23.0"
   }
 }