Compatibility Issue Due to Documentation/Configuration Mismatch

Open
#30 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Domain
build-system

Research direction

Compare the installation instructions with the package's tsup configuration and the two package imports shown in the report. Reproduce the TypeScript error using the provided configuration, then verify that the documented dependency and configuration reference the same package and that the error is resolved.

Written by the indexing model from the issue text.

Description

Hello,

I am encountering a compatibility issue after following your package's installation instructions. The documentation indicates that a specific package should be installed; however, the tsup configuration appears to be referencing an older, incompatible version. This discrepancy is causing conflicts and preventing the package from functioning correctly.

Reproduction Steps

  1. Installed the package as instructed:

    yarn add esbuild-plugin-react18
    
  2. Configured tsup I think it use your old package esbuild-react18-useclient as follows:

    // tsup.config.ts or tsup.config.js
    import { defineConfig } from "tsup";
    import react18Plugin from "esbuild-react18-useclient";
    
    const react18PluginOptions: React18PluginOptions = {}
    export default defineConfig(options => ({
        ...
        esbuildPlugins:[react18Plugin(react18PluginOptions)]
    }));
    
  3. Attempted to use the following configuration, but encountered a TypeScript error:

    import { defineConfig } from 'tsup'
    import react18Plugin, { React18PluginOptions } from 'esbuild-plugin-react18'
    
    const react18PluginOptions: React18PluginOptions = {}
    export default defineConfig({
      entry: ['src/index.ts'],
      format: ['cjs', 'esm'],
      splitting: false,
      sourcemap: true,
      dts: true,
      minify: true,
      treeshake: true,
      external: ['react', 'react-dom'],
      esbuildPlugins: [react18Plugin(react18PluginOptions)],
    })
    

    TypeScript Error:

                Type '"external" | "bundle" | undefined' is not assignable to type '"external" | undefined'.
                  Type '"bundle"' is not assignable to type '"external"'.ts(2322)
    

Request

Could you please take a look at the tsup configuration within the package and ensure it aligns with the documented dependencies? I would greatly appreciate your assistance in resolving this matter.

Thank you for your time and consideration.

Dominant language
TypeScript
Stars
15
Forks
1
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from react18-tools/esbuild-plugin-react18

All issues in react18-tools/esbuild-plugin-react18

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.