shakapacker 9.0.0.beta.4 → 9.0.0.beta.6

data/package/webpack-types.d.ts

@@ -0,0 +1,33 @@
+// @ts-ignore: webpack is an optional peer dependency (using type-only import)
+import type { Configuration, RuleSetRule, RuleSetUseItem } from 'webpack'
+
+export interface ShakapackerWebpackConfig extends Configuration {
+  module?: Configuration['module'] & {
+    rules?: RuleSetRule[]
+  }
+}
+
+export interface ShakapackerRule extends RuleSetRule {
+  test: RegExp
+  use: RuleSetUseItem[]
+}
+
+export interface ShakapackerLoaderOptions {
+  [key: string]: any
+}
+
+export interface ShakapackerLoader {
+  loader: string
+  options?: ShakapackerLoaderOptions
+}
+
+export type LoaderType = string | ShakapackerLoader
+
+export interface LoaderUtils {
+  resolveLoader(name: string): string
+  createRule(test: RegExp, loaders: LoaderType[]): ShakapackerRule
+  getStyleLoader(extract?: boolean): LoaderType
+  getCssLoader(modules?: boolean): LoaderType
+  getPostCssLoader(): LoaderType
+  getSassLoader(): LoaderType
+}

data/package/webpackDevServerConfig.ts

@@ -0,0 +1,117 @@
+import { DevServerConfig } from "./types"
+const snakeToCamelCase = require("./utils/snakeToCamelCase")
+
+const shakapackerDevServerYamlConfig = require("./dev_server") as DevServerConfig
+const { outputPath: contentBase, publicPath } = require("./config") as {
+  outputPath: string
+  publicPath: string
+}
+
+interface WebpackDevServerConfig {
+  devMiddleware?: {
+    publicPath?: string
+  }
+  hot?: boolean | string
+  liveReload?: boolean
+  historyApiFallback?: boolean | {
+    disableDotRule?: boolean
+  }
+  static?: {
+    publicPath?: string
+    [key: string]: unknown
+  }
+  client?: Record<string, unknown>
+  allowedHosts?: "all" | "auto" | string | string[]
+  bonjour?: boolean | Record<string, unknown>
+  compress?: boolean
+  headers?: Record<string, unknown> | (() => Record<string, unknown>)
+  host?: "local-ip" | "local-ipv4" | "local-ipv6" | string
+  http2?: boolean
+  https?: boolean | Record<string, unknown>
+  ipc?: boolean | string
+  magicHtml?: boolean
+  onAfterSetupMiddleware?: (devServer: unknown) => void
+  onBeforeSetupMiddleware?: (devServer: unknown) => void
+  open?: boolean | string | string[] | Record<string, unknown> | Record<string, unknown>[]
+  port?: "auto" | string | number
+  proxy?: unknown
+  server?: string | boolean | Record<string, unknown>
+  setupExitSignals?: boolean
+  setupMiddlewares?: (middlewares: unknown[], devServer: unknown) => unknown[]
+  watchFiles?: string | string[] | unknown
+  webSocketServer?: string | boolean | Record<string, unknown>
+  [key: string]: unknown
+}
+
+const webpackDevServerMappedKeys = new Set([
+  // client, server, liveReload, devMiddleware are handled separately
+  "allowedHosts",
+  "bonjour",
+  "compress",
+  "headers",
+  "historyApiFallback",
+  "host",
+  "hot",
+  "http2",
+  "https",
+  "ipc",
+  "magicHtml",
+  "onAfterSetupMiddleware",
+  "onBeforeSetupMiddleware",
+  "open",
+  "port",
+  "proxy",
+  "server",
+  "setupExitSignals",
+  "setupMiddlewares",
+  "watchFiles",
+  "webSocketServer"
+])
+
+function createDevServerConfig(): WebpackDevServerConfig {
+  const devServerYamlConfig = { ...shakapackerDevServerYamlConfig } as DevServerConfig & Record<string, unknown>
+  const liveReload =
+    devServerYamlConfig.live_reload !== undefined
+      ? devServerYamlConfig.live_reload
+      : !devServerYamlConfig.hmr
+  delete devServerYamlConfig.live_reload
+
+  const config: WebpackDevServerConfig = {
+    devMiddleware: {
+      publicPath
+    },
+    hot: devServerYamlConfig.hmr,
+    liveReload,
+    historyApiFallback: {
+      disableDotRule: true
+    },
+    static: {
+      publicPath: contentBase
+    }
+  }
+  delete devServerYamlConfig.hmr
+
+  if (devServerYamlConfig.static) {
+    config.static = { 
+      ...config.static, 
+      ...(typeof devServerYamlConfig.static === 'object' ? devServerYamlConfig.static as Record<string, unknown> : {})
+    }
+    delete devServerYamlConfig.static
+  }
+
+  if (devServerYamlConfig.client) {
+    config.client = devServerYamlConfig.client
+    delete devServerYamlConfig.client
+  }
+
+  Object.keys(devServerYamlConfig).forEach((yamlKey) => {
+    const camelYamlKey = snakeToCamelCase(yamlKey)
+    if (webpackDevServerMappedKeys.has(camelYamlKey)) {
+      config[camelYamlKey] = devServerYamlConfig[yamlKey]
+    }
+  })
+
+  return config
+}
+
+export = createDevServerConfig

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "9.0.0-beta.4",
+  "version": "9.0.0-beta.6",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "homepage": "https://github.com/shakacode/shakapacker",
   "bugs": {
@@ -29,12 +29,17 @@
     "lib/install/config/shakapacker.yml"
   ],
   "scripts": {
+    "clean:ts": "find package -name '*.ts' -not -name '*.d.ts' | sed 's/\\.ts$//' | xargs -I {} rm -f {}.js {}.d.ts {}.d.ts.map {}.js.map",
+    "build": "tsc",
+    "build:types": "tsc",
     "lint": "eslint .",
-    "test": "jest"
+    "test": "jest",
+    "type-check": "tsc --noEmit"
   },
   "dependencies": {
     "js-yaml": "^4.1.0",
-    "path-complete-extname": "^1.0.0"
+    "path-complete-extname": "^1.0.0",
+    "webpack-merge": "^5.8.0"
   },
   "devDependencies": {
     "@rspack/cli": "^1.4.11",
@@ -69,9 +74,112 @@
     "typescript": "^5.9.2",
     "webpack": "5.93.0",
     "webpack-assets-manifest": "^5.0.6",
-    "webpack-merge": "^5.8.0",
     "webpack-subresource-integrity": "^5.1.0"
   },
+  "peerDependencies": {
+    "@babel/core": "^7.17.9",
+    "@babel/plugin-transform-runtime": "^7.17.0",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/runtime": "^7.17.9",
+    "@rspack/core": "^1.0.0",
+    "@rspack/cli": "^1.0.0",
+    "@rspack/plugin-react-refresh": "^1.0.0",
+    "@types/babel__core": "^7.0.0",
+    "@types/webpack": "^5.0.0",
+    "babel-loader": "^8.2.4 || ^9.0.0 || ^10.0.0",
+    "compression-webpack-plugin": "^9.0.0 || ^10.0.0 || ^11.0.0",
+    "css-loader": "^6.8.1 || ^7.0.0",
+    "esbuild": "^0.14.0 || ^0.15.0 || ^0.16.0 || ^0.17.0 || ^0.18.0 || ^0.19.0 || ^0.20.0 || ^0.21.0 || ^0.22.0 || ^0.23.0 || ^0.24.0",
+    "esbuild-loader": "^2.0.0 || ^3.0.0 || ^4.0.0",
+    "mini-css-extract-plugin": "^2.0.0",
+    "rspack-manifest-plugin": "^5.0.0",
+    "sass": "^1.50.0",
+    "sass-loader": "^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
+    "swc-loader": "^0.1.15 || ^0.2.0",
+    "terser-webpack-plugin": "^5.3.1",
+    "webpack": "^5.76.0",
+    "webpack-assets-manifest": "^5.0.6 || ^6.0.0",
+    "webpack-cli": "^4.9.2 || ^5.0.0 || ^6.0.0",
+    "webpack-dev-server": "^4.15.2 || ^5.2.2",
+    "webpack-subresource-integrity": "^5.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@babel/core": {
+      "optional": true
+    },
+    "@babel/plugin-transform-runtime": {
+      "optional": true
+    },
+    "@babel/preset-env": {
+      "optional": true
+    },
+    "@babel/runtime": {
+      "optional": true
+    },
+    "@rspack/core": {
+      "optional": true
+    },
+    "@rspack/cli": {
+      "optional": true
+    },
+    "@rspack/plugin-react-refresh": {
+      "optional": true
+    },
+    "@types/babel__core": {
+      "optional": true
+    },
+    "@types/webpack": {
+      "optional": true
+    },
+    "babel-loader": {
+      "optional": true
+    },
+    "compression-webpack-plugin": {
+      "optional": true
+    },
+    "css-loader": {
+      "optional": true
+    },
+    "esbuild": {
+      "optional": true
+    },
+    "esbuild-loader": {
+      "optional": true
+    },
+    "mini-css-extract-plugin": {
+      "optional": true
+    },
+    "rspack-manifest-plugin": {
+      "optional": true
+    },
+    "sass": {
+      "optional": true
+    },
+    "sass-loader": {
+      "optional": true
+    },
+    "swc-loader": {
+      "optional": true
+    },
+    "terser-webpack-plugin": {
+      "optional": true
+    },
+    "webpack": {
+      "optional": true
+    },
+    "webpack-assets-manifest": {
+      "optional": true
+    },
+    "webpack-cli": {
+      "optional": true
+    },
+    "webpack-dev-server": {
+      "optional": true
+    },
+    "webpack-subresource-integrity": {
+      "optional": true
+    }
+  },
   "packageManager": "yarn@1.22.22",
   "engines": {
     "node": ">= 14",

data/test/peer-dependencies.sh

@@ -0,0 +1,85 @@
+#!/bin/bash
+
+# Test script for verifying optional peer dependencies work correctly
+# This ensures no warnings are shown during installation with different package managers
+
+set -e
+
+echo "Testing optional peer dependencies installation..."
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+NC='\033[0m' # No Color
+
+# Get the current directory (shakapacker root)
+SHAKAPACKER_PATH=$(pwd)
+
+# Create a temporary directory for tests
+TEST_DIR=$(mktemp -d)
+echo "Testing in: $TEST_DIR"
+
+# Function to check for peer dependency warnings
+check_warnings() {
+    local output=$1
+    local pkg_manager=$2
+
+    # Check for common peer dependency warning patterns
+    if echo "$output" | grep -i "peer" | grep -i "warn" > /dev/null 2>&1; then
+        echo -e "${RED}✗ $pkg_manager shows peer dependency warnings${NC}"
+        return 1
+    else
+        echo -e "${GREEN}✓ $pkg_manager installation clean (no warnings)${NC}"
+        return 0
+    fi
+}
+
+# Test with npm
+echo ""
+echo "Testing with npm..."
+mkdir -p "$TEST_DIR/npm-test"
+cd "$TEST_DIR/npm-test"
+npm init -y > /dev/null 2>&1
+NPM_OUTPUT=$(npm install "$SHAKAPACKER_PATH" 2>&1)
+check_warnings "$NPM_OUTPUT" "npm"
+NPM_RESULT=$?
+
+# Test with yarn
+echo ""
+echo "Testing with yarn..."
+mkdir -p "$TEST_DIR/yarn-test"
+cd "$TEST_DIR/yarn-test"
+yarn init -y > /dev/null 2>&1
+YARN_OUTPUT=$(yarn add "$SHAKAPACKER_PATH" 2>&1)
+check_warnings "$YARN_OUTPUT" "yarn"
+YARN_RESULT=$?
+
+# Test with pnpm (if available)
+if command -v pnpm &> /dev/null; then
+    echo ""
+    echo "Testing with pnpm..."
+    mkdir -p "$TEST_DIR/pnpm-test"
+    cd "$TEST_DIR/pnpm-test"
+    pnpm init > /dev/null 2>&1
+    PNPM_OUTPUT=$(pnpm add "$SHAKAPACKER_PATH" 2>&1)
+    check_warnings "$PNPM_OUTPUT" "pnpm"
+    PNPM_RESULT=$?
+else
+    echo ""
+    echo "Skipping pnpm test (not installed)"
+    PNPM_RESULT=0
+fi
+
+# Cleanup
+rm -rf "$TEST_DIR"
+
+# Summary
+echo ""
+echo "===== Test Summary ====="
+if [ $NPM_RESULT -eq 0 ] && [ $YARN_RESULT -eq 0 ] && [ $PNPM_RESULT -eq 0 ]; then
+    echo -e "${GREEN}All tests passed! No peer dependency warnings detected.${NC}"
+    exit 0
+else
+    echo -e "${RED}Some tests failed. Peer dependency warnings were detected.${NC}"
+    exit 1
+fi

data/test/typescript/build.test.js

@@ -0,0 +1,117 @@
+/* eslint-env jest */
+const { execSync } = require("child_process")
+const { existsSync, readFileSync } = require("fs")
+const { join } = require("path")
+
+describe("typescript build", () => {
+  const rootPath = join(__dirname, "..", "..")
+
+  describe("typescript compilation", () => {
+    it("should compile TypeScript files without errors", () => {
+      expect(() => {
+        execSync("npx tsc --noEmit", { cwd: rootPath, stdio: "pipe" })
+      }).not.toThrow()
+    })
+
+    it("should generate JavaScript files from TypeScript", () => {
+      // Check that key TypeScript files compile to JavaScript
+      const tsFiles = ["config", "env", "index", "dev_server"]
+
+      tsFiles.forEach((file) => {
+        const jsPath = join(rootPath, "package", `${file}.js`)
+        const tsPath = join(rootPath, "package", `${file}.ts`)
+
+        expect(existsSync(tsPath)).toBe(true)
+        expect(existsSync(jsPath)).toBe(true)
+
+        // Verify JS file is newer than TS file (has been compiled)
+        const jsContent = readFileSync(jsPath, "utf8")
+        expect(jsContent).toContain("use strict")
+      })
+    })
+
+    it("should generate type definition files", () => {
+      const dtsFiles = ["config", "env", "index", "types", "dev_server"]
+
+      dtsFiles.forEach((file) => {
+        const dtsPath = join(rootPath, "package", `${file}.d.ts`)
+        expect(existsSync(dtsPath)).toBe(true)
+      })
+    })
+  })
+
+  describe("commonJS compatibility", () => {
+    it("should export modules using CommonJS format", () => {
+      const config = require("../../package/config")
+      const env = require("../../package/env")
+      const helpers = require("../../package/utils/helpers")
+
+      expect(config).toBeDefined()
+      expect(env.railsEnv).toBeDefined()
+      expect(helpers.moduleExists).toBeDefined()
+    })
+
+    it("should maintain backward compatibility", () => {
+      const index = require("../../package/index")
+
+      // Check all expected exports are present
+      expect(index.config).toBeDefined()
+      expect(index.env).toBeDefined()
+      expect(index.generateWebpackConfig).toBeInstanceOf(Function)
+      expect(index.moduleExists).toBeInstanceOf(Function)
+      expect(index.canProcess).toBeInstanceOf(Function)
+    })
+  })
+
+  describe("type guards", () => {
+    it("should have runtime type validation functions", () => {
+      const typeGuards = require("../../package/utils/typeGuards")
+
+      expect(typeGuards.isValidConfig).toBeInstanceOf(Function)
+      expect(typeGuards.isValidDevServerConfig).toBeInstanceOf(Function)
+      expect(typeGuards.isValidYamlConfig).toBeInstanceOf(Function)
+      expect(typeGuards.isPartialConfig).toBeInstanceOf(Function)
+    })
+
+    it("should validate config objects correctly", () => {
+      const { isPartialConfig } = require("../../package/utils/typeGuards")
+
+      const validPartial = {
+        source_path: "app/javascript",
+        nested_entries: true
+      }
+
+      const invalidPartial = {
+        source_path: 123, // Should be string
+        nested_entries: "yes" // Should be boolean
+      }
+
+      expect(isPartialConfig(validPartial)).toBe(true)
+      expect(isPartialConfig(invalidPartial)).toBe(false)
+    })
+  })
+
+  describe("error helpers", () => {
+    it("should have error handling utilities", () => {
+      const errorHelpers = require("../../package/utils/errorHelpers")
+
+      expect(errorHelpers.isFileNotFoundError).toBeInstanceOf(Function)
+      expect(errorHelpers.isModuleNotFoundError).toBeInstanceOf(Function)
+      expect(errorHelpers.getErrorMessage).toBeInstanceOf(Function)
+    })
+
+    it("should correctly identify ENOENT errors", () => {
+      const {
+        isFileNotFoundError
+      } = require("../../package/utils/errorHelpers")
+
+      const enoentError = new Error("File not found")
+      enoentError.code = "ENOENT"
+
+      const otherError = new Error("Other error")
+
+      expect(isFileNotFoundError(enoentError)).toBe(true)
+      expect(isFileNotFoundError(otherError)).toBe(false)
+    })
+  })
+})

data/tsconfig.json

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "typeRoots": ["./node_modules/@types", "node_modules/@types", "../node_modules/@types"],
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./package",
+    "rootDir": "./package",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "moduleResolution": "node",
+    "allowJs": true,
+    "checkJs": false,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": false,
+    "noImplicitThis": true,
+    "alwaysStrict": false,
+    "allowSyntheticDefaultImports": true,
+    "preserveConstEnums": true,
+    "isolatedModules": true,
+    "removeComments": false
+  },
+  "include": [
+    "package/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "package/**/*.test.ts",
+    "package/**/*.spec.ts"
+  ]
+}

data/yarn.lock

@@ -5997,7 +5997,7 @@ webpack-merge@*:
 
 webpack-merge@^5.8.0:
   version "5.10.0"
-  resolved "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.10.0.tgz"
+  resolved "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.10.0.tgz#a3ad5d773241e9c682803abf628d4cd62b8a4177"
   integrity sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA==
   dependencies:
     clone-deep "^4.0.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 9.0.0.beta.4
+  version: 9.0.0.beta.6
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -149,6 +149,7 @@ files:
 - ".node-version"
 - ".rspec"
 - ".rubocop.yml"
+- ".yalcignore"
 - CHANGELOG.md
 - CLAUDE.md
 - CONTRIBUTING.md
@@ -171,6 +172,7 @@ files:
 - docs/customizing_babel_config.md
 - docs/deployment.md
 - docs/developing_shakapacker.md
+- docs/optional-peer-dependencies.md
 - docs/peer-dependencies.md
 - docs/react.md
 - docs/rspack.md
@@ -180,6 +182,7 @@ files:
 - docs/subresource_integrity.md
 - docs/transpiler-performance.md
 - docs/troubleshooting.md
+- docs/typescript.md
 - docs/using_esbuild_loader.md
 - docs/using_swc_loader.md
 - docs/v6_upgrade.md
@@ -214,6 +217,7 @@ files:
 - lib/shakapacker/dev_server_proxy.rb
 - lib/shakapacker/dev_server_runner.rb
 - lib/shakapacker/digest_strategy.rb
+- lib/shakapacker/doctor.rb
 - lib/shakapacker/env.rb
 - lib/shakapacker/helper.rb
 - lib/shakapacker/instance.rb
@@ -222,6 +226,7 @@ files:
 - lib/shakapacker/railtie.rb
 - lib/shakapacker/rspack_runner.rb
 - lib/shakapacker/runner.rb
+- lib/shakapacker/swc_migrator.rb
 - lib/shakapacker/utils/manager.rb
 - lib/shakapacker/utils/misc.rb
 - lib/shakapacker/utils/version_syntax_converter.rb
@@ -236,22 +241,26 @@ files:
 - lib/tasks/shakapacker/clean.rake
 - lib/tasks/shakapacker/clobber.rake
 - lib/tasks/shakapacker/compile.rake
+- lib/tasks/shakapacker/doctor.rake
 - lib/tasks/shakapacker/info.rake
 - lib/tasks/shakapacker/install.rake
+- lib/tasks/shakapacker/migrate_to_swc.rake
 - lib/tasks/shakapacker/verify_config.rake
 - lib/tasks/shakapacker/verify_install.rake
 - package.json
 - package/babel/preset.js
-- package/config.js
-- package/dev_server.js
-- package/env.js
+- package/config.ts
+- package/dev_server.ts
+- package/env.ts
 - package/environments/base.js
+- package/environments/base.ts
 - package/environments/development.js
 - package/environments/production.js
 - package/environments/test.js
 - package/esbuild/index.js
 - package/index.d.ts
-- package/index.js
+- package/index.ts
+- package/loaders.d.ts
 - package/optimization/rspack.js
 - package/optimization/webpack.js
 - package/plugins/rspack.js
@@ -272,17 +281,20 @@ files:
 - package/rules/swc.js
 - package/rules/webpack.js
 - package/swc/index.js
-- package/utils/configPath.js
-- package/utils/debug.js
-- package/utils/defaultConfigPath.js
-- package/utils/getStyleRule.js
-- package/utils/helpers.js
-- package/utils/inliningCss.js
-- package/utils/requireOrError.js
-- package/utils/snakeToCamelCase.js
-- package/utils/validateCssModulesConfig.js
-- package/utils/validateDependencies.js
-- package/webpackDevServerConfig.js
+- package/types.ts
+- package/utils/configPath.ts
+- package/utils/debug.ts
+- package/utils/defaultConfigPath.ts
+- package/utils/errorHelpers.ts
+- package/utils/getStyleRule.ts
+- package/utils/helpers.ts
+- package/utils/inliningCss.ts
+- package/utils/requireOrError.ts
+- package/utils/snakeToCamelCase.ts
+- package/utils/typeGuards.ts
+- package/utils/validateDependencies.ts
+- package/webpack-types.d.ts
+- package/webpackDevServerConfig.ts
 - prettier.config.js
 - shakapacker.gemspec
 - test/helpers.js
@@ -306,15 +318,18 @@ files:
 - test/package/rules/webpack.test.js
 - test/package/staging.test.js
 - test/package/test.test.js
+- test/peer-dependencies.sh
 - test/resolver.js
+- test/typescript/build.test.js
 - tools/README.md
 - tools/css-modules-v9-codemod.js
+- tsconfig.json
 - yarn.lock
 homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.0.0.beta.4
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.0.0.beta.6
 rdoc_options: []
 require_paths:
 - lib
@@ -354,4 +369,6 @@ test_files:
 - test/package/rules/webpack.test.js
 - test/package/staging.test.js
 - test/package/test.test.js
+- test/peer-dependencies.sh
 - test/resolver.js
+- test/typescript/build.test.js