rpt2 does not resolve pnpm symlinked dependencies

[davelsio]

What happens and why it is wrong

When trying to build a project installed with pnpm, rpt2 fails to resolve the created symlinked dependencies in node_modules (non-flat).

Setting check: false is (arguably) a workaround.

Related issues: #188, #214

Reproduction

Repository: https://github.com/davelsan/rpt2-pnpm-symlinks
Config: https://github.com/davelsan/rpt2-pnpm-symlinks/blob/master/rollup.config.js

The provided repro is a minimal vue3 plugin that imports the App interface from vue in index.ts

import  { App } from 'vue'

This import causes the following error on build:

 [!] (plugin rpt2) Error: semantic error TS2305: Module '"../node_modules/vue/dist/vue"' has no exported member 'App'.

Setting the check option to false in rollup.config.js eliminates the error.

Versions

• typescript: 4.2.3
• rollup: 2.41.5
• rollup-plugin-typescript2: 0.30.0

rollup.config.js

import path    from 'path';
import rpt2    from 'rollup-plugin-typescript2';
import pkgJson from './package.json';

export default {

  input: './src/index.ts',

  external: ['vue'],

  plugins: [
    rpt2({
      check: true,
      tsconfig: path.resolve(__dirname, 'tsconfig.json'),
    })
  ],

  output: [
    {
      file: pkgJson.browser, // dist/index.esm.js
      format: 'es',
      sourcemap: true,
    },
  ],
}

tsconfig.json

A snippet with the relevant module resolution options only.

{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "node",
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
  }
}

package.json

A snippet with the relevant dependencies only.

{
  "peerDependencies": {
    "vue": "^3.0.7"
  },
  "devDependencies": {
    "rollup": "^2.41.5",
    "rollup-plugin-typescript2": "^0.30.0",
    "typescript": "^4.2.3",
    "vue": "^3.0.7"
  }
}

[davelsio]

Update

According to this comment in the pnpm repo, there was a similar problem caused by the rollup-plugin-commonjs plugin (note that I'm not using it in the repro).

However, none of the provided solutions will work in this case.

// include the actual pnpm registry path
commonjs({ include: '../../node_modules/.pnpm/registry.npmjs.org/**' })

// or set the following option in rollup.config.js
preserveSymlinks: true

[davelsio]

I've been looking at the code and I'm mystified. Leaving more info here for myself and other passing-by folks:

• In theory resolve already supports symlinks (preserveSymlinks doesn't work properly from root package browserify/resolve#196 was fixed in [Fix] preserveSymlinks: false ensure that files are realpathed browserify/resolve#197)

• This is also supported in @rollup/plugin-resolve via the rollup option preserveSymlinks. Though it seems to use a different resolve algorithm.
  https://github.com/rollup/plugins/blob/9ad41a0760b4eeed9fd26d2da9b5122aa8a351e5/packages/node-resolve/src/index.js#L148-L156

• This plugin does use resolve.sync if rollupCommonJSResolveHack is set to true. But it does not pass an options object.

rollup-plugin-typescript2/src/index.ts

Lines 160 to 162 in 428140b

	const resolved = pluginOptions.rollupCommonJSResolveHack
	? resolve.sync(result.resolvedModule.resolvedFileName)
	: result.resolvedModule.resolvedFileName;

Based on the above, I cannot see any combination of options and/or plugins that will correctly resolve pnpm symlinks. Maybe I could try to implement it? It looks simple enough, which probably means it is more complicated than I can see 😅

[davelsio]

I'm starting to suspect this is not an issue with rpt2, despite what the error says, but rather a problem that's propagating upstream.

Closing until I have more information.

[theoparis]

Any updates on this? I'm trying to bundle a react app with rollup and the original @rollup/plugin-typescript gives debug failure errors, so I tried this.

I got the following error specifically:

[!] (plugin rpt2) Error: /media/theo/TheoData/Essentials/Projects/Programming/hypervpn/src/pages/home.tsx(1,10): semantic error TS2305: Module '"@chakra-ui/react"' has no exported member 'Button'.
src/pages/home.tsx
Error: /media/theo/TheoData/Essentials/Projects/Programming/hypervpn/src/pages/home.tsx(1,10): semantic error TS2305: Module '"@chakra-ui/react"' has no exported member 'Button'.
    at error (/media/theo/TheoData/Essentials/Projects/Programming/hypervpn/node_modules/.pnpm/rollup@2.40.0/node_modules/rollup/dist/shared/rollup.js:5279:30)

[theoparis]

Thing is, it works fine with the original ts plugin before I had debug failure errors, and running tsc by itself works fine as well.

[beetaa]

Thing is, it works fine with the original ts plugin before I had debug failure errors, and running tsc by itself works fine as well.

I am using pnpm as the package manager, same situation while rolling up a vue component. no problem when using @rollup/plugin-typescript.

[beetaa]

@Davelsan @creepinson I think this issue should be opened again for further discussion. thank you.

[davelsio]

Hi @beetaa. Thanks for your interest in this issue. I have updated the original repro and I can confirm the issue is still there. I'm re-opening the discussion as per your request.

[ezolenko]

@Davelsan

This plugin does use resolve.sync if rollupCommonJSResolveHack is set to true. But it does not pass an options object.
[...]
Based on the above, I cannot see any combination of options and/or plugins that will correctly resolve pnpm symlinks. Maybe I could try to implement it? It looks simple enough, which probably means it is more complicated than I can see 😅

So you are saying rpt2 should pass { preserveSymlinks: false } option to resolve?

[jackson-yyy]

[... shortened for readability ...]
So you are saying rpt2 should pass { preserveSymlinks: false } option to resolve?

I got the same problem in my project with pnpm.
I debugged line by line and found the problem is getAllReferences function returned a path the symlink, not the path of the real file or directory.

rollup-plugin-typescript2/src/tscache.ts

Lines 63 to 75 in 428140b

	export function getAllReferences(importer: string, snapshot: tsTypes.IScriptSnapshot | undefined, options: tsTypes.CompilerOptions)
	{
	if (!snapshot)
	return [];
	const info = tsModule.preProcessFile(snapshot.getText(0, snapshot.getLength()), true, true);
	return _.compact(_.concat(info.referencedFiles, info.importedFiles).map((reference) =>
	{
	const resolved = tsModule.nodeModuleNameResolver(reference.fileName, importer, options, tsModule.sys);
	return resolved.resolvedModule ? resolved.resolvedModule.resolvedFileName : undefined;
	}));
	}

for examples,
consider this following directory

node_modules
├─.pnpm
|  ├─vue@3.2.2
|  |  ├─node_modules
|  |  |   ├─@vue
|  |  |   ├─vue
packages
|  ├─demo
|  |   ├─node_modules
|  |   │  └─vue(symlink, real path should be `project_root/node_modules/.pnpm/vue@3.2.2/node_modules/vue`)
|  |   ├─public
|  |   └─src

As you see, the real path of vue in demo should be project_root/node_modules/.pnpm/vue@3.2.2/node_modules/vue
But after resolving by tsModule.nodeModuleNameResolver in function getAllReferences , it becomes project_root/packages/demo/node_modules/vue

Vue@3.2.2 depends on @vue, which is not exist in project_root/packages/demo/node_modules, so it throw an error while resolving.

I wonder if there is any way to solve this problem.
Otherwise i can only use pnpm --shamefully-hoist to hoist all packages to root node_modules, which is similar to yarn/npm.😅

[mammadataei]

Any news?
I have the same issue

semantic error TS2305: Module '"vue"' has no exported member 'defineComponent'.