k_builder-webpack5 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4682a17f13ff61ff94239586ea635ff201da05f3809d2f23686e27324800ae5a
-  data.tar.gz: 38c8e4f2792f2673b2a2897d1b372c0de92a73a9ffd129e01a13f4b305247384
+  metadata.gz: 485fc9474b23acbed4ca9ad076605b6f840d3a506e2d245a319e2d20f000b4e5
+  data.tar.gz: 4f6b1946cbb2edf5b18ea56f2f25c28de090d833c47e2ddaaa0be33c24080500
 SHA512:
-  metadata.gz: 63362e1a4f2250b2a9490dbafac327a5d0106ff28b826bc93f1c2fc658ce6fb3535f83bef62a2c69623bea5141d501b14d23a3cf1041111ca0f78662742b1490
-  data.tar.gz: 174af5d711c1064152ed2447a97c2d3bdb84de9f7c61cdb43ab85288bc76e34c32ac59494beea10bef80f1d047eb2ef600dea16b0daa22eeb6fae268d94e60ea
+  metadata.gz: 2b7dfede2543af409fe5291361604672d7b4dae981225dec4d6f421c2200a4b2274c5b4a051342e39e6fe4ae1228dcb4923820110a556842006b1c0b58e45458
+  data.tar.gz: ef02d378bdbeb933daba71d37dd511783e651726c79aa91f3cf4eef59a93593e81008550d76b1b6ed680ed70039105097d7e72c438fa52f596084aa0209cad17

data/.templates/sample.txt

@@ -0,0 +1,2 @@
+{{camel name}}
+{{dasherize name}}

data/.templates/web-project/.gitignore

@@ -0,0 +1,16 @@
+/bin/
+/bin/runonce/
+
+node_modules
+dist
+.cache
+_
+/.history/
+/coverage/
+/log/
+!/log/.keep
+/tmp/
+!/tmp/.keep
+
+# Environment File
+.env

data/.templates/webpack.config.js.txt

@@ -0,0 +1,40 @@
+{{> requirePath}}
+{{> requireWebpack}}
+{{> requireMiniCssExtractPlugin}}
+
+{{#if (or mode entry entries dev_server plugins)~}}
+module.exports = {
+  {{#if mode}}{{as_javascript mode 'exclude_root'}},{{/if~}}
+  {{#if entry}}{{as_javascript entry 'exclude_root'}},{{/if~}}
+  {{#if entries}}entry: {{as_javascript entries}},{{/if~}}
+  {{#if dev_server}}devServer: {{as_javascript dev_server}},{{/if~}}
+  {{#if (or plugins.mini_css_extract)~}}
+  plugins: [
+  {{#if plugins.mini_css_extract}}new MiniCssExtractPlugin({ filename:'{{plugins.mini_css_extract.filename}}' }),{{/if}}
+  ],
+  {{/if}}
+}
+{{/if}}
+
+{{#*inline "requirePath"}}
+{{#if root_scope.require_path}}
+const path = require("path");
+{{/if}}
+{{/inline}}
+{{#*inline "requireWebpack"}}
+{{#if root_scope.require_webpack}}
+const webpack = require('webpack');
+{{/if}}
+{{/inline}}
+{{#*inline "requireMiniCssExtractPlugin"}}
+{{#if root_scope.require_mini_css_extract_plugin}}
+/*
+ * MiniCssExtractPlugin enabled. This allows your app to use css modules that will be
+ # moved into a separate CSS file instead of inside one of your module entries!
+ *
+ * https://github.com/webpack-contrib/mini-css-extract-plugin
+ */
+
+const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+{{/if}}
+{{/inline}}

data/k_builder-webpack5.gemspec

@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
 
   # spec.add_dependency 'tty-box',         '~> 0.5.0'
   spec.add_dependency 'k_builder', '~> 0.0'
+  spec.add_dependency 'k_builder-package_json', '~> 0.0'
 end

data/lib/k_builder/webpack5.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require 'json'
+require 'k_builder'
+require 'k_builder/package_json'
+require 'k_builder/webpack5/json_data'
+require 'k_builder/webpack5/webpack_builder'
+require 'k_builder/webpack5/webpack_json_factory'
 require 'k_builder/webpack5/version'
 
 module KBuilder

data/lib/k_builder/webpack5/json_data.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KBuilder
+  module Webpack5
+    # Represents a node in a JSON object
+    class JsonData < OpenStruct
+      def self.parse_json(json)
+        json = json.to_json if json.is_a?(Hash)
+        JSON.parse(json, object_class: JsonData)
+      end
+
+      def as_json
+        KBuilder.data.struct_to_hash(self)
+      end
+    end
+  end
+end

data/lib/k_builder/webpack5/version.rb

@@ -2,6 +2,6 @@
 
 module KBuilder
   module Webpack5
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/lib/k_builder/webpack5/webpack_builder.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module KBuilder
+  module Webpack5
+    # Configuration currently comes from KBuilder and stores template folders and target folders if configured
+    class WebpackBuilder < KBuilder::Builder
+      # In memory representation of .webpack-rc.json and generator for webpack.config.js
+      # attr_writer :webpack_config
+      attr_writer :webpack_rc
+
+      def initialize(configuration = nil)
+        super(configuration)
+
+        @factory = KBuilder::Webpack5::WebpackJsonFactory
+      end
+
+      # -----------------------------------
+      # Builder Attributes
+      # -----------------------------------
+
+      # def webpack_config
+      #   return @webpack_config if defined? @webpack_config
+
+      #   load
+
+      #   @webpack_config
+      # end
+
+      # def webpack_config_file
+      #   # Output Path may not be enough, I may need a webpack output path
+      #   @webpack_config_file ||= File.join(target_folder, 'webpack.config.js')
+      # end
+
+      def webpack_rc
+        return @webpack_rc if defined? @webpack_rc
+
+        load_webpack_rc
+
+        @webpack_rc
+      end
+
+      def webpack_rc_file
+        @webpack_rc_file ||= File.join(target_folder, '.webpack-rc.json')
+      end
+
+      # -----------------------------------
+      # Fluent Builder Methods
+      # -----------------------------------
+
+      # Webpack init will create .webconfig-rc.json
+      def webpack_init
+        File.delete(webpack_rc_file) if File.exist?(webpack_rc_file)
+
+        @webpack_rc = @factory.webpack
+        write_webpack_rc
+
+        self
+      end
+
+      def webpack_dev_server(**dev_server_opts, &block)
+        if @webpack_rc.dev_server.nil?
+          @webpack_rc.dev_server = if block
+                                     @factory.dev_server(&block)
+                                   else
+                                     dev_server_opts = { opinion: @factory.opinion_dev_server } if dev_server_opts.empty?
+                                     @factory.dev_server(**dev_server_opts)
+                                   end
+        end
+        write_webpack_rc
+
+        self
+      end
+
+      def mode(**mode_opts, &block)
+        if @webpack_rc.mode.nil?
+          @webpack_rc.mode = if block
+                               @factory.mode(&block)
+                             else
+                               mode_opts = { opinion: @factory.opinion_mode } if mode_opts.empty?
+                               @factory.mode(**mode_opts)
+                             end
+        end
+        write_webpack_rc
+
+        self
+      end
+
+      def entry(**entry_opts, &block)
+        if @webpack_rc.entry.nil?
+          @webpack_rc.entry = if block
+                                @factory.entry(&block)
+                              else
+                                entry_opts = { opinion: @factory.opinion_entry } if entry_opts.empty?
+                                @factory.entry(**entry_opts)
+                              end
+        end
+        write_webpack_rc
+
+        self
+      end
+
+      def entries(&block)
+        if @webpack_rc.entries.nil?
+          @webpack_rc.entries = if block
+                                  @factory.entries(&block)
+                                else
+                                  entries_opts = { opinion: @factory.opinion_entries }
+                                  @factory.entries(**entries_opts)
+                                end
+        end
+        write_webpack_rc
+
+        self
+      end
+
+      # Plugins
+
+      def plugin_mini_css_extract(**mini_css_extract_opts, &block)
+        ensure_plugins
+
+        if @webpack_rc.plugins.mini_css_extract.nil?
+          @webpack_rc.plugins.mini_css_extract = if block
+                                                   @factory.mini_css_extract(&block)
+                                                 else
+                                                   mini_css_extract_opts = { opinion: @factory.opinion_mini_css_extract } if mini_css_extract_opts.empty?
+                                                   @factory.mini_css_extract(**mini_css_extract_opts)
+                                                 end
+
+          @webpack_rc.root_scope.require_mini_css_extract_plugin = true
+        end
+
+        write_webpack_rc
+
+        self
+      end
+      alias plugin_split_css plugin_mini_css_extract
+
+      # # Set a property value in the webpack_config
+      # def set(key, value)
+      #   load
+
+      #   @webpack_config[key] = value
+
+      #   write
+
+      #   self
+      # end
+
+      # -----------------------------------
+      # Helpers
+      # -----------------------------------
+
+      # Debug method to open the webpack_config file in vscode
+      # ToDo: Maybe remove
+      def vscode
+        puts "cd #{target_folder}"
+        puts webpack_rc_file
+        rc "code #{webpack_rc_file}"
+
+        self
+      end
+
+      def pause(seconds = 1)
+        sleep(seconds)
+
+        self
+      end
+
+      private
+
+      # Load the existing .webpack-rc.json into memory
+      def load_webpack_rc
+        raise KBuilder::Webpack5::Error, '.webpack-rc.json does not exist' unless File.exist?(webpack_rc_file)
+
+        content = File.read(webpack_rc_file)
+        @webpack_rc = JSON.parse(content, object_class: KBuilder::Webpack5::JsonData)
+
+        self
+      end
+
+      def write_webpack_rc
+        content = JSON.pretty_generate(@webpack_rc.as_json)
+
+        FileUtils.mkdir_p(File.dirname(webpack_rc_file))
+
+        File.write(webpack_rc_file, content)
+
+        self
+      end
+
+      def ensure_plugins
+        @webpack_rc.plugins = OpenStruct.new if @webpack_rc.plugins.nil?
+      end
+    end
+  end
+end

data/lib/k_builder/webpack5/webpack_json_factory.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module KBuilder
+  module Webpack5
+    # Factory helps give shape to the JSON structure.
+    #
+    # Helps: Because the underlying structure is a typeless and contractless
+    #        OpenStruct, the developer could put any values they like in here.
+    #        This factory helps to articulate the JSON contract
+    class WebpackJsonFactory
+      def self.build_from_json(json)
+        # ToDo, build up the WebStruct by applying each JSON structure
+      end
+
+      # rubocop:disable Metrics/ParameterLists
+      def self.webpack(
+        settings: WebpackJsonFactory.settings,
+        root_scope: WebpackJsonFactory.root_scope,
+        entry: nil,
+        entries: nil,
+        plugins: nil,
+        dev_server: nil
+      )
+        obj = KBuilder::Webpack5::JsonData.new
+
+        obj.root_scope  = root_scope
+        obj.entry       = entry unless entry.nil?
+        obj.entries     = entries unless entries.nil?
+        obj.dev_server  = dev_server unless dev_server.nil?
+        obj.plugins     = plugins unless plugins.nil?
+        obj.settings    = settings
+
+        yield obj if block_given?
+
+        obj
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def self.root_scope
+        obj = KBuilder::Webpack5::JsonData.new
+
+        obj.require_path = false
+        obj.require_webpack = false
+        obj.require_mini_css_extract_plugin = false
+        obj.require_html_webpack_plugin = false
+        obj.require_workbox_webpack_plugin = false
+        obj.require_autoprefixer = false
+        obj.require_precss = false
+
+        yield obj if block_given?
+
+        obj
+      end
+
+      def self.opinion_mode
+        lambda { |json|
+          json.mode = 'development'
+        }
+      end
+
+      # https://webpack.js.org/configuration/mode/
+      def self.mode(opinion: nil, **opts)
+        obj = KBuilder::Webpack5::JsonData.new
+
+        # Let the software lead/architect's opinion decide default configuration
+        opinion&.call(obj)
+
+        obj.mode = opts[:mode] unless opts[:mode].nil?
+
+        yield obj if block_given?
+
+        obj
+      end
+
+      def self.opinion_entry
+        lambda { |json|
+          json.entry = './src'
+        }
+      end
+
+      # https://webpack.js.org/concepts/entry-points/
+      def self.entry(opinion: nil, **opts)
+        obj = KBuilder::Webpack5::JsonData.new
+
+        # Let the software lead/architect's opinion decide default configuration
+        opinion&.call(obj)
+
+        # https://webpack.js.org/configuration/
+        obj.entry = opts[:entry] unless opts[:entry].nil?
+
+        yield obj if block_given?
+
+        obj
+      end
+
+      def self.opinion_entries
+        lambda { |json|
+          json.home = './src/home.js'
+          json.about = './src/about.js'
+        }
+      end
+
+      # https://webpack.js.org/concepts/entry-points/
+      def self.entries(opinion: nil)
+        obj = KBuilder::Webpack5::JsonData.new
+
+        # Let the software lead/architect's opinion decide default configuration
+        opinion&.call(obj)
+
+        yield obj if block_given?
+
+        obj
+      end
+
+      def self.settings
+        obj = KBuilder::Webpack5::JsonData.new
+
+        # Render the TIPS
+
+        obj.tips = false
+
+        yield obj if block_given?
+
+        obj
+      end
+
+      def self.opinion_dev_server
+        lambda { |json|
+          json.open      = true
+          json.localhost = 'localhost'
+        }
+      end
+
+      # https://webpack.js.org/configuration/dev-server/
+      # https://github.com/webpack/webpack-dev-server
+      # rubocop:disable Metrics/AbcSize
+      def self.dev_server(opinion: nil, **opts)
+        obj = KBuilder::Webpack5::JsonData.new
+
+        # Let the software lead/architect's opinion decide default configuration
+        opinion&.call(obj)
+
+        # https://github.com/webpack/webpack-dev-server/tree/master/examples/cli/public
+        obj.open      = opts[:open]            unless opts[:open].nil?         # true
+        obj.localhost = opts[:localhost]       unless opts[:localhost].nil?    # localhost
+
+        # https://github.com/webpack/webpack-dev-server/tree/master/examples/cli/watch-static
+        obj.static = opts[:static]             unless opts[:static].nil? # static: ['assets', 'css']
+
+        yield obj if block_given?
+
+        # Samples
+        # devServer: {
+        #   open: true,
+        #   host: 'localhost'
+        # }
+        #
+        # devServer: {
+        #   contentBase: path.join(__dirname, 'dist'),
+        #   compress: true,
+        #   port: 9000,
+        # },
+
+        # TIPS
+        # - If you're having trouble, navigating to the /webpack-dev-server route will show where files are served. For example, http://localhost:9000/webpack-dev-server.
+        # - If you want to manually recompile the bundle, navigating to the /invalidate route will invalidate the current compilation of the bundle and recompile it for you via webpack-dev-middleware.
+        #   Depending on your configuration, URL may look like http://localhost:9000/invalidate.
+        # - HTML template is required to serve the bundle, usually it is an index.html file. Make sure that script references are added into HTML, webpack-dev-server doesn't inject them automatically.
+
+        obj
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def self.opinion_mini_css_extract
+        lambda { |json|
+          json.filename = 'main.[contenthash].css'
+        }
+      end
+
+      # https://webpack.js.org/plugins/mini-css-extract-plugin/
+      def self.mini_css_extract(opinion: nil, **opts)
+        obj = KBuilder::Webpack5::JsonData.new
+
+        # Let the software lead/architect's opinion decide default configuration
+        opinion&.call(obj)
+
+        obj.filename = opts[:filename] unless opts[:filename].nil?
+
+        yield obj if block_given?
+
+        obj
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: k_builder-webpack5
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - David Cruwys
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: k_builder-package_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 description: "    KBuilder-Webpack5 provides various fluent builders for building
   webpack configuration file\n"
 email:
@@ -36,6 +50,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".templates/sample.txt"
+- ".templates/web-project/.gitignore"
+- ".templates/webpack.config.js.txt"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -53,7 +70,10 @@ files:
 - hooks/update-version
 - k_builder-webpack5.gemspec
 - lib/k_builder/webpack5.rb
+- lib/k_builder/webpack5/json_data.rb
 - lib/k_builder/webpack5/version.rb
+- lib/k_builder/webpack5/webpack_builder.rb
+- lib/k_builder/webpack5/webpack_json_factory.rb
 homepage: http://appydave.com/gems/k-builder-webpack5
 licenses:
 - MIT