bridgetown_markdown_lazylinks 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86e6cb9298548d242ddb0b0019dd56e9ee5a8289ee887537d8c32fd3dd9d6d33
-  data.tar.gz: 4b182e8ef852ed145a3d15a6de43c929e42d9eca32497d5476b22d300efb31d4
+  metadata.gz: bfb7aabefee9a49f88a7c2969723a72700aa7faf9418384aefe0e9cdeda8f0ce
+  data.tar.gz: a365c1dfe8b03f391be738437d8a04ac9e3b3f6b6659db57b3a6b22ff83620fb
 SHA512:
-  metadata.gz: 1055b153830c96dfdfe461e1742c28ff5291c1feaa0b3f60cc69f036e45dda52435717c7e4a2fa255d8a8db28428523068b1870149e1ada525ec7f7cf0ef23b2
-  data.tar.gz: a84e40e426ff56b0446c3841cf7070d1d8691bddfb65863d06798639a9838e6ef5fa52e2f5857879e233b6b8f2ca4a0c370a49e52cfdabe18332a37e1a76d0d7
+  metadata.gz: 2fec30ccdadb994e07aa840fddcbb6c13079c1dcf4987f6058a1288f6e40117c4481be0976f70dfa3e21085f3cc0ac877c7ff581707564a0aeeb4a2164c2b6fc
+  data.tar.gz: 8cce949321493052945ff333827add6046e57eb4ccf59b03c09aaa8d0920b9a449ba62a3634ab16740042ae4cb1db73727049ee8318a36310206d2388e0bc712

data/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2023-06-26
+
+- distinguish between basic & external placeholders
+
+## [0.2.2] - 2023-06-26
+
+- allow placeholder customization
+
 ## [0.2.1] - 2023-06-19
 
 - add a plugin initializer
@@ -23,3 +31,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.1.0]: https://github.com/akarzim/bridgetown_markdown_lazylinks/releases/tag/v0.1.0
 [0.2.0]: https://github.com/akarzim/bridgetown_markdown_lazylinks/releases/tag/v0.2.0
 [0.2.1]: https://github.com/akarzim/bridgetown_markdown_lazylinks/releases/tag/v0.2.1
+[0.2.2]: https://github.com/akarzim/bridgetown_markdown_lazylinks/releases/tag/v0.2.2
+[0.3.0]: https://github.com/akarzim/bridgetown_markdown_lazylinks/releases/tag/v0.3.0

data/README.md

@@ -22,6 +22,18 @@ Or if there's a `bridgetown.automation.rb` automation script, you can run that i
 bin/bridgetown apply https://github.com/akarzim/bridgetown_markdown_lazylinks
 ```
 
+### Customization
+
+You can customize the lazylinks placeholder in this way to use `+` instead of `*`:
+
+```ruby
+init :bridgetown_markdown_lazylinks do
+  basic_placeholder "-"
+  external_placeholder "@"
+end
+```
+
+
 ## Usage
 
 The plugin will allow you to use `*` as link references in your markdown
@@ -41,6 +53,10 @@ and then just define them in order below it.
 [*]: http://blog.bignerdranch.com/4044-rock-heads/
 ```
 
+Since version 0.3.0, we can use `+` as an external link reference, in the same
+way as `*`, but this will add `target="_blank" rel="external"` to the resulting
+links.
+
 ## Testing
 
 * Run `bundle exec rake test` to run the test suite

data/lib/bridgetown_markdown_lazylinks/converter.rb

@@ -21,20 +21,36 @@ module BridgetownMarkdownLazylinks
   class Converter < Bridgetown::Converter
     priority :high
 
-    LAZY_LINKS_REGEX = %r!(?<link>\[[^\]]+\]\s*\[)\*(?<url>\].*?^\[)\*\]:!m.freeze
+    DEFAULT_BASIC_PLACEHOLDER = :*
+    DEFAULT_EXTERNAL_PLACEHOLDER = :+
 
     def initialize(config = {})
       super
 
       self.class.input @config["markdown_ext"].split(",")
       @counter = 0
+      @basic_placeholder = config.bridgetown_markdown_lazylinks.basic_placeholder
+      @basic_placeholder ||= DEFAULT_BASIC_PLACEHOLDER
+      @external_placeholder = config.bridgetown_markdown_lazylinks.external_placeholder
+      @external_placeholder ||= DEFAULT_EXTERNAL_PLACEHOLDER
     end
 
     def convert(content)
+      # rubocop:disable Layout/LineLength
+      basic_regex = %r!(\[[^\]]+\]\s*\[)#{basic_placeholder}(\].*?^\[)#{basic_placeholder}\]:!m.freeze
+      external_regex = %r!(\[[^\]]+\]\s*\[)#{external_placeholder}\](.*?^\[)#{external_placeholder}\]:!m.freeze
+      # rubocop:enable Layout/LineLength
+
       cache.getset(content) do
-        while content =~ LAZY_LINKS_REGEX
+        while content =~ basic_regex
+          self.counter += 1
+          content.sub!(basic_regex, "\\1#{counter}\\2#{counter}]:")
+        end
+
+        while content =~ external_regex
           self.counter += 1
-          content.sub!(LAZY_LINKS_REGEX, "\\k<link>#{counter}\\k<url>#{counter}]:")
+          attrs = '{:target="_blank"}{:rel="external"}'
+          content.sub!(external_regex, %(\\1#{counter}]#{attrs}\\2#{counter}]:))
         end
 
         content
@@ -45,6 +61,14 @@ module BridgetownMarkdownLazylinks
 
     attr_accessor :counter
 
+    def basic_placeholder
+      Regexp.quote(@basic_placeholder)
+    end
+
+    def external_placeholder
+      Regexp.quote(@external_placeholder)
+    end
+
     def cache
       @cache ||= Bridgetown::Cache.new("BridgetownMarkdownLazylinks")
     end

data/lib/bridgetown_markdown_lazylinks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownMarkdownLazylinks
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/bridgetown_markdown_lazylinks.rb

@@ -8,6 +8,14 @@ require "bridgetown_markdown_lazylinks/converter"
 # @see https://github.com/bridgetownrb/bridgetown/issues/769#issuecomment-1596520674
 #
 # @param config [Bridgetown::Configuration::ConfigurationDSL]
-Bridgetown.initializer :bridgetown_markdown_lazylinks do |_|
-  # noop
+# @param [Hash<String, String>] opts custom configuration
+# @option opts [String] :placeholder ('*') the basic placeholder
+# @option opts [String] :external_placeholder ('+') the external placeholder
+#
+# rubocop:disable Metrics/LineLength
+Bridgetown.initializer :bridgetown_markdown_lazylinks do |config, placeholder: "*", external_placeholder: "+"|
+  config.bridgetown_markdown_lazylinks ||= {}
+  config.bridgetown_markdown_lazylinks.basic_placeholder = placeholder
+  config.bridgetown_markdown_lazylinks.external_placeholder = external_placeholder
 end
+# rubocop:enable Metrics/LineLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown_markdown_lazylinks
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - François Vantomme
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown