jekyll_include_plugin 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7df480b45b3043abaccf469a338b5c4cf49184772edfcfe7857675949b7dcfa3
-  data.tar.gz: c14aa6edd200bb08a8f556676ea0594be2f74d07f8ea498987f57cab74e1e9c9
+  metadata.gz: bf5e2649753a79999e7dc654d94f74b2fb46bd3825d0724c045785fa67e12f2a
+  data.tar.gz: 516cc1d240386761f0ed7e315978d5c9280925732dcba575bfcc75cbd71e2f05
 SHA512:
-  metadata.gz: a509ff2ab17aeaef3007185c137dc0985b00fb4652b171ebdb88ab227148650a320d4aee8efb7b30932d05d53cf132dc7541de4c070427100524c857842c9363
-  data.tar.gz: b8926d41c0c06ff2aa5aa4bf55924da8a77e98cfcbba1bcbcd8de1b7b45614193858f6ff920da302ba50054f749f56ef4d5d2e0ad6f73ac152cce749aa111903
+  metadata.gz: ddc9154f479ac2f0592ac47e00599f4efe4057a58b5b5ca3d03ac3fb415cbc052354a77d3942ae685134c3f16351767fb0e5d0c658845833759e871263446d5a
+  data.tar.gz: f078a6a8c2f89fae4e3af7d620c6fe7aa2224b0d27144fa0ea25a267534e3c0532480a6901802ce3d8816e376fe61d661425b04af1319c6e4b76e95fe952fe9d

data/.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6.10, 2.7.6, 3.0.4, 3.1.2, 3.2.0-preview1]
+        ruby: [3.1.2, 3.2.0, 3.4.2]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.idea

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll_include_plugin (1.1.1)
+    jekyll_include_plugin (1.3.0)
       jekyll (>= 3.5, < 5.0)
       liquid (~> 4.0)
 
@@ -59,7 +59,8 @@ GEM
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rouge (3.26.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -79,6 +80,7 @@ GEM
       ffi (~> 1.9)
     sassc (2.4.0-x64-mingw32)
       ffi (~> 1.9)
+    strscan (3.1.0)
     terminal-table (2.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     unicode-display_width (1.7.0)
@@ -93,4 +95,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.2.20
+   2.6.6

data/README.md

@@ -60,6 +60,50 @@ Dynamic parameters:
 {% include_file "{{ $templatingAllowedHere }}/Dockerfile" snippet="{{ $hereToo }}" %}
 ```
 
+## Ignore a part of an included content
+
+The usage:
+```jsx
+const template = () => {
+  return (
+    // [<snippet example>]
+    <Provider
+      // [<ignore>]
+      propToIgnore={propToIgnore}
+      // [<endignore>]
+      component={() => <div>Data is loading...</div>}
+      errorComponent={({ message }) => <div>There was an error: {message}</div>}
+    >
+      ...
+    </Provider>
+    // [<endsnippet example>]
+  );
+};
+```
+
+The result:
+```jsx
+  <Provider
+    component={() => <div>Data is loading...</div>}
+    errorComponent={({ message }) => <div>There was an error: {message}</div>}
+  >
+    ...
+  </Provider>
+```
+
+## Plugin options in `_config.yml`
+
+Default options:
+```yml
+jekyll_include_plugin:
+  snippet_prefix: '...'
+```
+
+### `snippet_prefix`
+Type: `string` Default: `...`
+
+Prepends the prefix at the end of included snippet to differentiate whole file includes vs partial file includes (snippet)  
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/jekyll_include_plugin/jekyll_include_plugin.rb

@@ -10,20 +10,23 @@ module JekyllIncludePlugin
     def initialize(tag_name, raw_markup, tokens)
       super
       @raw_markup = raw_markup
+      @config = {}
       @params = {}
     end
 
     def render(context)
+      read_config(context)
       parse_params(context)
 
       file_contents = get_raw_file_contents(context)
 
       if @params["snippet"]
-        file_contents = pick_snippet(file_contents, @params["snippet"])
+        file_contents = pick_snippet(file_contents, @config['snippet_prefix'], @params["snippet"])
       else
         file_contents = remove_all_snippets(file_contents)
       end
 
+      file_contents = remove_ignored_lines(file_contents)
       file_contents = remove_excessive_newlines(file_contents)
       file_contents = remove_excessive_indentation(file_contents)
       file_contents = render_comments(file_contents, context.registers[:page]["lang"])
@@ -34,6 +37,13 @@ module JekyllIncludePlugin
 
     private
 
+    def read_config(context)
+      site = context.registers[:site]
+      plugin_config = site.config["jekyll_include_plugin"] || {}
+
+      @config["snippet_prefix"] = plugin_config['snippet_prefix'] || '...'
+    end
+
     def parse_params(context)
       rendered_markup = Liquid::Template
         .parse(@raw_markup)

data/lib/jekyll_include_plugin/utils.rb

@@ -16,7 +16,7 @@ module JekyllIncludePlugin
   module TextUtils
     include Utils
 
-    def pick_snippet(text, snippet_name)
+    def pick_snippet(text, snippet_prefix, snippet_name)
       snippet_content = ""
       snippet_start_found = false
       snippet_end_found = false
@@ -42,8 +42,25 @@ module JekyllIncludePlugin
       abort("End of the snippet '#{snippet_name}' has not been found.") unless snippet_end_found
       abort("Snippet '#{snippet_name}' appears to be empty. Fix and retry.") if snippet_content.empty?
 
+      return snippet_content if snippet_prefix.empty?
+
       first_line_indent = %r!^\s*!.match(snippet_content)[0]
-      return "#{first_line_indent}...\n#{snippet_content}"
+      return "#{first_line_indent}#{snippet_prefix}\n#{snippet_content}"
+    end
+
+    def remove_ignored_lines(text)
+      ignoring = false
+      text.each_line.reject do |line|
+        if line =~ /^\s*\/\/\s*\[<ignore>\]/
+          ignoring = true
+          true
+        elsif line =~ /^\s*\/\/\s*\[<endignore>\]/
+          ignoring = false
+          true
+        else
+          ignoring
+        end
+      end.join
     end
 
     def remove_all_snippets(text)

data/lib/jekyll_include_plugin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllIncludePlugin
-  VERSION = "1.1.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_include_plugin
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Ilya Lesikov
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -72,7 +71,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
 email:
 - ilya@lesikov.com
 executables: []
@@ -101,7 +99,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/flant/jekyll_include_plugin
   source_code_uri: https://github.com/flant/jekyll_include_plugin
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Plugin for including contents of local/remote plain text files (or parts
   of them) into your pages. Allows for multilang comments in the included files.