jetpacker 0.1.0 → 0.2.0

data/lib/webpacker/railtie.rb

@@ -0,0 +1,98 @@
+require "rails/railtie"
+
+require "webpacker/helper"
+require "webpacker/dev_server_proxy"
+
+class Webpacker::Engine < ::Rails::Engine
+  # Allows Webpacker config values to be set via Rails env config files
+  config.webpacker = ActiveSupport::OrderedOptions.new
+
+  initializer "webpacker.set_configs" do |app|
+    if app.config.webpacker.key?(:check_yarn_integrity)
+      Webpacker.config.check_yarn_integrity = app.config.webpacker.check_yarn_integrity
+    end
+  end
+
+  # ================================
+  # Check Yarn Integrity Initializer
+  # ================================
+  #
+  # development (on by default):
+  #
+  #    to turn off:
+  #     - edit config/environments/development.rb
+  #     - add `config.webpacker.check_yarn_integrity = false`
+  #
+  # production (off by default):
+  #
+  #    to turn on:
+  #     - edit config/environments/production.rb
+  #     - add `config.webpacker.check_yarn_integrity = true`
+  initializer "webpacker.yarn_check" do |app|
+    if File.exist?("yarn.lock") && Webpacker.config.config_path.exist? && Webpacker.config.check_yarn_integrity?
+      output = `yarn check --integrity && yarn check --verify-tree 2>&1`
+
+      unless $?.success?
+        $stderr.puts "\n\n"
+        $stderr.puts "========================================"
+        $stderr.puts "  Your Yarn packages are out of date!"
+        $stderr.puts "  Please run `yarn install --check-files` to update."
+        $stderr.puts "========================================"
+        $stderr.puts "\n\n"
+        $stderr.puts "To disable this check, please change `check_yarn_integrity`"
+        $stderr.puts "to `false` in your webpacker config file (config/webpacker.yml)."
+        $stderr.puts "\n\n"
+        $stderr.puts output
+        $stderr.puts "\n\n"
+
+        exit(1)
+      end
+    end
+  end
+
+  initializer "webpacker.proxy" do |app|
+    insert_middleware = Webpacker.config.dev_server.present? rescue nil
+    if insert_middleware
+      app.middleware.insert_before 0,
+        Rails::VERSION::MAJOR >= 5 ?
+          Webpacker::DevServerProxy : "Webpacker::DevServerProxy", ssl_verify_none: true
+    end
+  end
+
+  initializer "webpacker.helper" do
+    ActiveSupport.on_load :action_controller do
+      ActionController::Base.helper Webpacker::Helper
+    end
+
+    ActiveSupport.on_load :action_view do
+      include Webpacker::Helper
+    end
+  end
+
+  initializer "webpacker.logger" do
+    config.after_initialize do
+      if ::Rails.logger.respond_to?(:tagged)
+        Webpacker.logger = ::Rails.logger
+      else
+        Webpacker.logger = ActiveSupport::TaggedLogging.new(::Rails.logger)
+      end
+    end
+  end
+
+  initializer "webpacker.bootstrap" do
+    if defined?(Rails::Server) || defined?(Rails::Console)
+      Webpacker.bootstrap
+      if defined?(Spring)
+        require "spring/watcher"
+        Spring.after_fork { Webpacker.bootstrap }
+        Spring.watch(Webpacker.config.config_path)
+      end
+    end
+  end
+
+  initializer "webpacker.set_source" do |app|
+    if Webpacker.config.config_path.exist?
+      app.config.javascript_path = Webpacker.config.source_path.relative_path_from(Rails.root.join("app")).to_s
+    end
+  end
+end

data/lib/webpacker/rake_tasks.rb

@@ -0,0 +1,6 @@
+class Webpacker::RakeTasks
+  def self.load!
+    tasks_path = File.expand_path("../tasks", __dir__)
+    Dir.glob("#{tasks_path}/**/*.rake").sort.each { |ext| load ext }
+  end
+end

data/lib/webpacker/runner.rb

@@ -0,0 +1,22 @@
+module Webpacker
+  class Runner
+    def self.run(argv)
+      $stdout.sync = true
+
+      new(argv).run
+    end
+
+    def initialize(argv)
+      @argv = argv
+
+      @app_path              = File.expand_path(".", Dir.pwd)
+      @node_modules_bin_path = ENV["WEBPACKER_NODE_MODULES_BIN_PATH"] || `yarn bin`.chomp
+      @webpack_config        = File.join(@app_path, "config/webpack/#{ENV["NODE_ENV"]}.js")
+
+      unless File.exist?(@webpack_config)
+        $stderr.puts "webpack config #{@webpack_config} not found, please run 'bundle exec rails webpacker:install' to install Webpacker with default configs or add the missing config file for your custom environment."
+        exit!
+      end
+    end
+  end
+end

data/lib/webpacker/version.rb

@@ -0,0 +1,4 @@
+module Webpacker
+  # Change the version in package.json too, please!
+  VERSION = "4.2.2".freeze
+end

data/lib/webpacker/webpack_runner.rb

@@ -0,0 +1,32 @@
+require "shellwords"
+require "webpacker/runner"
+
+module Webpacker
+  class WebpackRunner < Webpacker::Runner
+    def run
+      env = Webpacker::Compiler.env
+
+      cmd = if node_modules_bin_exist?
+        ["#{@node_modules_bin_path}/webpack"]
+      else
+        ["yarn", "webpack"]
+      end
+
+      if ARGV.include?("--debug")
+        cmd = [ "node", "--inspect-brk"] + cmd
+        ARGV.delete("--debug")
+      end
+
+      cmd += ["--config", @webpack_config] + @argv
+
+      Dir.chdir(@app_path) do
+        Kernel.exec env, *cmd
+      end
+    end
+
+    private
+      def node_modules_bin_exist?
+        File.exist?("#{@node_modules_bin_path}/webpack")
+      end
+  end
+end

data/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@rails/webpacker",
+  "version": "4.2.2",
+  "description": "Use webpack to manage app-like JavaScript modules in Rails",
+  "main": "package/index.js",
+  "files": [
+    "package",
+    "lib/install/config/webpacker.yml"
+  ],
+  "engines": {
+    "node": ">=8.16.0",
+    "yarn": ">=1.0.0"
+  },
+  "dependencies": {
+    "@babel/core": "^7.7.2",
+    "@babel/plugin-proposal-class-properties": "^7.7.0",
+    "@babel/plugin-proposal-object-rest-spread": "^7.6.2",
+    "@babel/plugin-syntax-dynamic-import": "^7.2.0",
+    "@babel/plugin-transform-destructuring": "^7.6.0",
+    "@babel/plugin-transform-regenerator": "^7.7.0",
+    "@babel/plugin-transform-runtime": "^7.6.2",
+    "@babel/preset-env": "^7.7.1",
+    "@babel/runtime": "^7.7.2",
+    "babel-loader": "^8.0.6",
+    "babel-plugin-dynamic-import-node": "^2.3.0",
+    "babel-plugin-macros": "^2.6.1",
+    "case-sensitive-paths-webpack-plugin": "^2.2.0",
+    "compression-webpack-plugin": "^3.0.1",
+    "core-js": "^3.4.0",
+    "css-loader": "^3.2.0",
+    "file-loader": "^4.2.0",
+    "flatted": "^2.0.1",
+    "glob": "^7.1.6",
+    "js-yaml": "^3.13.1",
+    "mini-css-extract-plugin": "^0.8.0",
+    "node-sass": "^4.13.0",
+    "optimize-css-assets-webpack-plugin": "^5.0.3",
+    "path-complete-extname": "^1.0.0",
+    "pnp-webpack-plugin": "^1.5.0",
+    "postcss-flexbugs-fixes": "^4.1.0",
+    "postcss-import": "^12.0.1",
+    "postcss-loader": "^3.0.0",
+    "postcss-preset-env": "^6.7.0",
+    "postcss-safe-parser": "^4.0.1",
+    "regenerator-runtime": "^0.13.3",
+    "sass-loader": "7.3.1",
+    "style-loader": "^1.0.0",
+    "terser-webpack-plugin": "^2.3.1",
+    "webpack": "^4.41.3",
+    "webpack-assets-manifest": "^3.1.1",
+    "webpack-cli": "^3.3.10",
+    "webpack-sources": "^1.4.3"
+  },
+  "devDependencies": {
+    "eslint": "^6.6.0",
+    "eslint-config-airbnb": "^18.0.1",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-jsx-a11y": "^6.2.3",
+    "eslint-plugin-react": "^7.16.0",
+    "jest": "^24.9.0"
+  },
+  "jest": {
+    "testRegex": "(/__tests__/.*|(\\.|/))\\.jsx?$",
+    "roots": [
+      "<rootDir>/package"
+    ]
+  },
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint package/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rails/webpacker.git"
+  },
+  "author": "David Heinemeier Hansson <david@basecamp.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/rails/webpacker/issues"
+  },
+  "homepage": "https://github.com/rails/webpacker"
+}

data/package/__tests__/config.js

@@ -0,0 +1,55 @@
+/* global test expect, describe */
+
+const { chdirCwd, chdirTestApp, resetEnv } = require('../utils/helpers')
+
+chdirTestApp()
+
+const config = require('../config')
+
+describe('Config', () => {
+  beforeEach(() => jest.resetModules() && resetEnv())
+  afterAll(chdirCwd)
+
+  test('public path', () => {
+    process.env.RAILS_ENV = 'development'
+    const config = require('../config')
+    expect(config.publicPath).toEqual('/packs/')
+  })
+
+  test('public path with asset host', () => {
+    process.env.RAILS_ENV = 'development'
+    process.env.WEBPACKER_ASSET_HOST = 'http://foo.com/'
+    const config = require('../config')
+    expect(config.publicPath).toEqual('http://foo.com/packs/')
+  })
+
+  test('should return extensions as listed in app config', () => {
+    expect(config.extensions).toEqual([
+      '.mjs',
+      '.js',
+      '.sass',
+      '.scss',
+      '.css',
+      '.module.sass',
+      '.module.scss',
+      '.module.css',
+      '.png',
+      '.svg',
+      '.gif',
+      '.jpeg',
+      '.jpg'
+    ])
+  })
+
+  test('should return static assets extensions as listed in app config', () => {
+    expect(config.static_assets_extensions).toEqual([
+      '.jpg',
+      '.jpeg',
+      '.png',
+      '.gif',
+      '.tiff',
+      '.ico',
+      '.svg',
+    ])
+  })
+})

data/package/__tests__/dev_server.js

@@ -0,0 +1,43 @@
+/* global test expect, describe */
+
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('DevServer', () => {
+  beforeEach(() => jest.resetModules())
+  afterAll(chdirCwd)
+
+  test('with NODE_ENV and RAILS_ENV set to development', () => {
+    process.env.NODE_ENV = 'development'
+    process.env.RAILS_ENV = 'development'
+    process.env.WEBPACKER_DEV_SERVER_HOST = '0.0.0.0'
+    process.env.WEBPACKER_DEV_SERVER_PORT = 5000
+
+    const devServer = require('../dev_server')
+    expect(devServer).toBeDefined()
+    expect(devServer.host).toEqual('0.0.0.0')
+    expect(devServer.port).toEqual('5000')
+  })
+
+  test('with custom env prefix', () => {
+    const config = require('../config')
+    config.dev_server.env_prefix = 'TEST_WEBPACKER_DEV_SERVER'
+
+    process.env.NODE_ENV = 'development'
+    process.env.RAILS_ENV = 'development'
+    process.env.TEST_WEBPACKER_DEV_SERVER_HOST = '0.0.0.0'
+    process.env.TEST_WEBPACKER_DEV_SERVER_PORT = 5000
+
+    const devServer = require('../dev_server')
+    expect(devServer).toBeDefined()
+    expect(devServer.host).toEqual('0.0.0.0')
+    expect(devServer.port).toEqual('5000')
+  })
+
+  test('with NODE_ENV and RAILS_ENV set to production', () => {
+    process.env.RAILS_ENV = 'production'
+    process.env.NODE_ENV = 'production'
+    expect(require('../dev_server')).toEqual({})
+  })
+})

data/package/__tests__/development.js

@@ -0,0 +1,30 @@
+/* test expect, describe, afterAll, beforeEach */
+
+const { resolve } = require('path')
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('Development environment', () => {
+  afterAll(chdirCwd)
+
+  describe('toWebpackConfig', () => {
+    beforeEach(() => jest.resetModules())
+
+    test('should use development config and environment', () => {
+      process.env.RAILS_ENV = 'development'
+      process.env.NODE_ENV = 'development'
+      const { environment } = require('../index')
+
+      const config = environment.toWebpackConfig()
+      expect(config.output.path).toEqual(resolve('public', 'packs'))
+      expect(config.output.publicPath).toEqual('/packs/')
+      expect(config).toMatchObject({
+        devServer: {
+          host: 'localhost',
+          port: 3035
+        }
+      })
+    })
+  })
+})

data/package/__tests__/env.js

@@ -0,0 +1,46 @@
+/* global test expect, describe */
+
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('Env', () => {
+  beforeEach(() => jest.resetModules())
+  afterAll(chdirCwd)
+
+  test('with NODE_ENV and RAILS_ENV set to development', () => {
+    process.env.RAILS_ENV = 'development'
+    process.env.NODE_ENV = 'development'
+    expect(require('../env')).toEqual({
+      railsEnv: 'development',
+      nodeEnv: 'development'
+    })
+  })
+
+  test('with undefined NODE_ENV and RAILS_ENV set to development', () => {
+    process.env.RAILS_ENV = 'development'
+    delete process.env.NODE_ENV
+    expect(require('../env')).toEqual({
+      railsEnv: 'development',
+      nodeEnv: 'production'
+    })
+  })
+
+  test('with undefined NODE_ENV and RAILS_ENV', () => {
+    delete process.env.NODE_ENV
+    delete process.env.RAILS_ENV
+    expect(require('../env')).toEqual({
+      railsEnv: 'production',
+      nodeEnv: 'production'
+    })
+  })
+
+  test('with a non-standard environment', () => {
+    process.env.RAILS_ENV = 'staging'
+    process.env.NODE_ENV = 'staging'
+    expect(require('../env')).toEqual({
+      railsEnv: 'staging',
+      nodeEnv: 'production'
+    })
+  })
+})

data/package/__tests__/production.js

@@ -0,0 +1,29 @@
+/* test expect, describe, afterAll, beforeEach */
+
+const { resolve } = require('path')
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('Production environment', () => {
+  afterAll(chdirCwd)
+
+  describe('toWebpackConfig', () => {
+    beforeEach(() => jest.resetModules())
+
+    test('should use production config and environment', () => {
+      process.env.RAILS_ENV = 'production'
+      process.env.NODE_ENV = 'production'
+
+      const { environment } = require('../index')
+      const config = environment.toWebpackConfig()
+
+      expect(config.output.path).toEqual(resolve('public', 'packs'))
+      expect(config.output.publicPath).toEqual('/packs/')
+      expect(config).toMatchObject({
+        devtool: 'source-map',
+        stats: 'normal'
+      })
+    })
+  })
+})