nanoc-webpack.rb 0.5.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ee6ae13d75181d02e95948c6f00446a7f92effe96fcc87c8e017f95c707a3e
-  data.tar.gz: bccc782d822fe1b6f843204a45b6eff75f677979bc7f4c68c853a71351f649ce
+  metadata.gz: 6089712cbc312cd503ad06f0a1d54e27351901f86b870460f1c6d3c205566d4c
+  data.tar.gz: 8c932b943c81803365dcd2e9a7c46b5cfec2790fb05964c73b60e557fcf1461a
 SHA512:
-  metadata.gz: 6dc66a6c40e1cadcdd50de9acd480ec69d80364bcd1b61e31345fdf4ab817fa7bb51c31fdd0790971b6915cbcce80c372b600b932cb450fac4caf947aa113579
-  data.tar.gz: 6509714bfa75b8d55b7030736a94f8ea66226bd7a86ceecc958c1749d08abc58618940a4cb1c009924bc76a172dedab0ccb6956facfb9e77145c222c6de73211
+  metadata.gz: 9b9f6f1cc40ada346daac98c1b401dc613c327e41c5bf48b1bf4c6ecad8b50c267b3a46164336e677dd8c28415f2c7262b28cab9ff4ea897c7f6a96491cc3c2a
+  data.tar.gz: 62595779fdff296640fa1ddd0030ab3d97e580378f0129c5a5d9260fe13b92e9a08a006316c8ad5de420133557d7f9542a776f7d2c909c2e37642d1c788a8996

data/README.md

@@ -2,50 +2,44 @@
 
 nanoc-webpack.rb is a
 [nanoc](https://nanoc.app)
-filter
-that integrates
+filter that integrates
 [webpack](https://webpack.js.org/)
-into nanoc-powered websites. The filter provides a bridge that
-connects nanoc, and the JavaScript, TypeScript, and nodejs ecosystems.
+into nanoc. <br>
+The filter acts as a  bridge that connects nanoc,
+and the JavaScript, TypeScript, and nodejs ecosystems.
 
 ## Examples
 
-### Defaults
+**Defaults**
 
-#### /js/main/App.tsx
-
-The following example forwards the entry point `/js/main/App.tsx` to webpack,
-and then writes the result to `/js/app.js`. This example and all the other
-examples assume that the files `webpack.config.js`, `tsconfig.json`, and
-`package.json` already exist at the root of the project:
+The following example forwards the entry point `/js/main/App.tsx`
+to webpack. <br> The result is then written to `/js/main/app.js`:
 
 ``` ruby
 # Rules
 require "nanoc-webpack"
 compile "/js/main/App.tsx" do
   filter(:webpack)
-  write("/js/app.js")
+  write("/js/main/app.js")
 end
 ```
 
-### Options
-
-#### Option: "depend_on"
+**Option: depend_on**
 
-The `depend_on` option tells nanoc what files an entry point imports or requires.
-When a file being tracked by the `depend_on` option undergoes a change, nanoc
-will initiate a recompilation of the entry point:
+When a file or directory tracked by the `depend_on` option
+is observed to have changed, nanoc will initiate a recompilation
+of the entry point:
 
 ```ruby
 # Rules
 require "nanoc-webpack"
 compile "/js/main/App.tsx" do
   filter(:webpack, depend_on: ["/js/lib", "/js/components", "/js/hooks"])
-  write("/js/app.js")
+  write("/js/main/app.js")
 end
 ```
 
-#### Option: "reject"
+**Option: reject**
 
 The `depend_on` option can be combined with the `reject` option to exclude
 certain files or directories from being tracked. For example, maybe you want
@@ -58,63 +52,40 @@ compile "/js/main/App.tsx" do
   filter :webpack,
          depend_on: ["/js/lib", "/js/components", "/js/hooks"],
          reject: proc { |path| path.start_with?("/js/lib/foo/") }
-  write("/js/app.js")
+  write("/js/main/app.js")
 end
 ```
 
-#### Option: "args"
+**Option: cli**
 
-The `args` option can be used to forward command-line options directly
-to the webpack executable.
-<br>
-`$ webpack build --help verbose` provides a list of all available options,
-and
+The `cli` option forwards command-line options directly
+to the webpack executable. <br>
 [Nanoc::Webpack.default_options](https://0x1eef.github.io/x/nanoc-webpack.rb/Nanoc/Webpack.html#default_options-class_method)
-returns the default options nanoc-webpack.rb will forward to webpack:
+returns the default options nanoc-webpack.rb will
+forward to webpack:
 
 ```ruby
 # Rules
 require "nanoc-webpack"
 compile "/js/main/App.tsx" do
-  filter :webpack, args: {"--no-stats" => true}
-  write("/js/app.js")
+  filter(:webpack, cli: {"--no-stats" => true})
+  write("/js/main/app.js")
 end
 ```
 
-
-## Requirements
-
-nanoc-webpack.rb assumes that:
-
-* A "node" executable is available in $PATH.
-* "webpack" / "webpack-cli" exist as dependencies in package.json.
-
-## Sources
-
-* [Source code (GitHub)](https://github.com/0x1eef/nanoc-webpack.rb)
-* [Source code (GitLab)](https://gitlab.com/0x1eef/nanoc-webpack.rb)
-
 ## <a id='install'>Install</a>
 
-**Git**
-
-nanoc-webpack.rb is distributed as a RubyGem through its git repositories. <br>
-[GitHub](https://github.com/0x1eef/nanoc-webpack.rb),
-and
-[GitLab](https://gitlab.com/0x1eef/nanoc-webpack.rb)
-are available as sources.
-
-```ruby
-# Gemfile
-gem "nanoc-webpack.rb", github: "0x1eef/nanoc-webpack.rb", tag: "v0.5.6"
-```
-
 **Rubygems.org**
 
 nanoc-webpack.rb can also be installed via rubygems.org.
 
     gem install nanoc-webpack.rb
 
+## Sources
+
+* [GitHub](https://github.com/0x1eef/nanoc-webpack.rb#readme)
+* [GitLab](https://gitlab.com/0x1eef/nanoc-webpack.rb#about)
+
 ## License
 
 [BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).

data/lib/nanoc/webpack/filter.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 ##
-# Compiles a textual nanoc item with webpack.
+# Compiles a nanoc item with webpack.
 class Nanoc::Webpack::Filter < Nanoc::Filter
   require_relative "filter/dependable"
-  Error = Class.new(RuntimeError)
   include FileUtils
   include Dependable
+  Error = Class.new(RuntimeError)
 
   identifier :webpack
   type :text
@@ -18,28 +18,36 @@ class Nanoc::Webpack::Filter < Nanoc::Filter
   #   )
   #
   # @return [Hash]
-  #  Returns the default command-line options given to webpack.
+  #  Returns the default command-line options forwarded to webpack.
   def self.default_options
     @default_options ||= {"--cache-type" => "filesystem"}
   end
 
+  ##
+  # @param [String] content
+  #  The contents of a file.
+  #
+  # @param [Hash] options
+  #  A hash of options.
+  #
+  # @return [void]
   def run(content, options = {})
-    args = options[:args] || options["args"] || {}
-    depend_on dependable(paths: options[:depend_on], reject: options[:reject])
+    options = Ryo.from(options)
+    depend_on dependable(paths: options.depend_on, reject: options.reject)
               .map { items[_1] }
-    webpack temporary_file_for(content),
-            args: self.class.default_options.merge(args)
+    webpack temporary_file(content),
+            cli: self.class.default_options.merge(options.cli || {})
   end
 
   private
 
-  def webpack(file, args: {})
+  def webpack(file, cli:)
     sh "node",
        "./node_modules/webpack/bin/webpack.js",
        "--entry", File.join(Dir.getwd, item.attributes[:content_filename]),
        "--output-path", File.dirname(file.path),
        "--output-filename", File.basename(file.path),
-       *webpack_args(args)
+       *webpack_args(cli)
     if $?.success?
       File.read(file.path).tap { file.tap(&:unlink).close }
     else
@@ -59,7 +67,7 @@ class Nanoc::Webpack::Filter < Nanoc::Filter
     end
   end
 
-  def temporary_file_for(content)
+  def temporary_file(content)
     dir = File.join(Dir.getwd, "tmp", "nanoc-webpack.rb")
     mkdir_p(dir) unless Dir.exist?(dir)
     file = Tempfile.new(File.basename(@item.identifier.to_s), dir)

data/lib/nanoc/webpack/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Webpack
-    VERSION = "0.5.6"
+    VERSION = "0.7.0"
   end
 end

data/nanoc-webpack.rb.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.summary = "nanoc-webpack.rb integrates webpack into nanoc."
   gem.description = gem.summary
-  gem.add_runtime_dependency "ryo.rb", "~> 0.4"
+  gem.add_runtime_dependency "ryo.rb", "~> 0.5"
   gem.add_development_dependency "yard", "~> 0.9"
   gem.add_development_dependency "redcarpet", "~> 3.5"
   gem.add_development_dependency "rspec", "~> 3.10"

data/spec/filter_spec.rb

@@ -146,7 +146,7 @@ RSpec.describe Nanoc::Webpack::Filter do
 
       it "executes nodejs with an argument" do
         expect(filter).to receive(:system).with(*cmdline)
-        filter.run(item, args: {"--no-cache" => true})
+        filter.run(item, cli: {"--no-cache" => true})
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-webpack.rb
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.7.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ryo.rb
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement