Building multiple projects with same top-level configs (Rollup, `tsconfig`) results in declarations for *all* projects output for each project

[Alxandr]

What happens and why it is wrong

I'm building 2 projects with one rollup.config file, and the result is this:

As can be seen, I get the .d.ts files for both projects in both dist folders.

Environment

OSX.

Versions

• typescript: 2.8.1
• rollup: 0.57.1
• rollup-plugin-typescript2: 0.12.0

rollup.config.js

It's auto-generated, so I can't really paste it.

tsconfig.json

{
  "compilerOptions": {
    "strict": true,
    "module": "esnext",
    "target": "es2016",
    "declaration": true
  },
  "exclude": ["node_modules", "**/node_modules/*"]
}

plugin output with verbosity 3

log

/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/src/before-exit.ts → packages/before-exit/dist/before-exit.js, packages/before-exit/dist/before-exit.mjs...
rpt2: typescript version: 2.8.1
rpt2: rollup-plugin-typescript2 version: 0.12.0
rpt2: plugin options:
{
    "verbosity": 3,
    "cacheRoot": "/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/.rpt2_cache",
    "exclude": [
        "*.d.ts",
        "**/*.d.ts",
        "/Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/*"
    ],
    "check": true,
    "clean": false,
    "include": [
        "*.ts+(|x)",
        "**/*.ts+(|x)"
    ],
    "abortOnError": true,
    "rollupCommonJSResolveHack": false,
    "typescript": "version 2.8.1",
    "useTsconfigDeclarationDir": false,
    "tsconfigOverride": {},
    "tsconfigDefaults": {}
}
rpt2: rollup config:
{
    "external": [
        "",
        "assert",
        "buffer",
        "child_process",
        "cluster",
        "console",
        "constants",
        "crypto",
        "dgram",
        "dns",
        "domain",
        "events",
        "fs",
        "http",
        "https",
        "module",
        "net",
        "os",
        "path",
        "punycode",
        "querystring",
        "readline",
        "repl",
        "stream",
        "string_decoder",
        "sys",
        "timers",
        "tls",
        "tty",
        "url",
        "util",
        "vm",
        "zlib",
        "v8",
        "process",
        "async_hooks",
        "http2",
        "perf_hooks"
    ],
    "input": "/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/src/before-exit.ts",
    "perf": false,
    "plugins": [
        {
            "name": "auto-external"
        },
        {
            "name": "rpt2"
        }
    ],
    "entry": "/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/src/before-exit.ts"
}
rpt2: built-in options overrides: {
    "noEmitHelpers": false,
    "importHelpers": true,
    "noResolve": false,
    "noEmit": false,
    "outDir": "/Users/alxandr/hub/yolodev-aspnet-utils",
    "moduleResolution": 2,
    "declarationDir": "/Users/alxandr/hub/yolodev-aspnet-utils"
}
rpt2: parsed tsconfig: {
    "options": {
        "module": 6,
        "strict": true,
        "target": 3,
        "declaration": true,
        "noEmitHelpers": false,
        "importHelpers": true,
        "noResolve": false,
        "noEmit": false,
        "outDir": "/Users/alxandr/hub/yolodev-aspnet-utils",
        "moduleResolution": 2,
        "declarationDir": "/Users/alxandr/hub/yolodev-aspnet-utils",
        "configFilePath": "/Users/alxandr/hub/yolodev-aspnet-utils/tsconfig.json"
    },
    "fileNames": [
        "/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/dist/before-exit/src/before-exit.d.ts",
        "/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/dist/workdir-pid/src/workdir-pid.d.ts",
        "/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/src/before-exit.ts",
        "/Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/dist/before-exit/src/before-exit.d.ts",
        "/Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/dist/workdir-pid/src/workdir-pid.d.ts",
        "/Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/src/workdir-pid.ts"
    ],
    "typeAcquisition": {
        "enable": false,
        "include": [],
        "exclude": []
    },
    "raw": {
        "compilerOptions": {
            "module": "esnext",
            "strict": true,
            "target": "es2016",
            "declaration": true
        },
        "exclude": [
            "node_modules",
            "**/node_modules/*"
        ]
    },
    "errors": [],
    "wildcardDirectories": {
        "/users/alxandr/hub/yolodev-aspnet-utils": 1
    },
    "compileOnSave": false,
    "configFileSpecs": {
        "includeSpecs": [
            "**/*"
        ],
        "excludeSpecs": [
            "node_modules",
            "**/node_modules/*"
        ],
        "validatedIncludeSpecs": [
            "**/*"
        ],
        "validatedExcludeSpecs": [
            "node_modules",
            "**/node_modules/*"
        ],
        "wildcardDirectories": {
            "/users/alxandr/hub/yolodev-aspnet-utils": 1
        }
    }
}
rpt2: included:
'[
    "*.ts+(|x)",
    "**/*.ts+(|x)"
]'
rpt2: excluded:
'[
    "*.d.ts",
    "**/*.d.ts",
    "/Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/*"
]'
rpt2: Ambient types:
rpt2:     /Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/dist/before-exit/src/before-exit.d.ts
rpt2:     /Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/dist/workdir-pid/src/workdir-pid.d.ts
rpt2:     /Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/dist/before-exit/src/before-exit.d.ts
rpt2:     /Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/dist/workdir-pid/src/workdir-pid.d.ts
rpt2:     /Users/alxandr/hub/yolodev-aspnet-utils/node_modules/@types/acorn/index.d.ts
rpt2:     /Users/alxandr/hub/yolodev-aspnet-utils/node_modules/@types/estree/index.d.ts
rpt2:     /Users/alxandr/hub/yolodev-aspnet-utils/node_modules/@types/node/index.d.ts
rpt2: ambient types changed, redoing all semantic diagnostics
rpt2: transpiling '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/src/before-exit.ts'
rpt2:     cache: '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/.rpt2_cache/0df88d81930e5b98b75cf91f784bf1ae5bbd236a/code/cache/2d9c6a3ef228d04e8594fac73f6ee4cdd1c12da5'
rpt2:     cache miss
rpt2:     cache: '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/.rpt2_cache/0df88d81930e5b98b75cf91f784bf1ae5bbd236a/syntacticDiagnostics/cache/2d9c6a3ef228d04e8594fac73f6ee4cdd1c12da5'
rpt2:     cache miss
rpt2:     cache: '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/.rpt2_cache/0df88d81930e5b98b75cf91f784bf1ae5bbd236a/semanticDiagnostics/cache/2d9c6a3ef228d04e8594fac73f6ee4cdd1c12da5'
rpt2:     cache miss
rpt2: generated declarations for '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/src/before-exit.ts'
rpt2: generating target 1
rpt2: rolling caches
rpt2: generating missed declarations for '/Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/src/workdir-pid.ts'
rpt2: writing declarations for '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/src/before-exit.ts' to '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/dist/before-exit/src/before-exit.d.ts'
rpt2: writing declarations for '/Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/src/workdir-pid.ts' to '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/dist/workdir-pid/src/workdir-pid.d.ts'
rpt2: generating target 2
rpt2: rolling caches
rpt2: writing declarations for '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/src/before-exit.ts' to '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/dist/before-exit/src/before-exit.d.ts'
rpt2: writing declarations for '/Users/alxandr/hub/yolodev-aspnet-utils/packages/workdir-pid/src/workdir-pid.ts' to '/Users/alxandr/hub/yolodev-aspnet-utils/packages/before-exit/dist/workdir-pid/src/workdir-pid.d.ts'
created packages/before-exit/dist/before-exit.js, packages/before-exit/dist/before-exit.mjs in 1s

[ezolenko]

Looks like your tsconfig includes everything under yolodev-aspnet-utils/packages/ including dist apparently so typescript compiler uses output definitions from previous build as ambient types for current build -- this is almost always wrong.

This plugin generates definitions for all ts files typescript sees during compilation (instead of only generating types for file rollup requests during build) because rollup ignores type-only imports. In your case you see a side-effect of that.

If you run tsc in the folder your current tsconfig is in, it will build both of your projects as well.

What tool do you use for generating rollup config? If it has a way to pass options to this plugin you can either create two tsconfigs with appropriate include/exclude sections and pass their names as tsconfig parameter, or you could use one tsconfig, but pass in tsconfigOverride with appropriate includes.

[zerkalica]

Same problem, plugin generates wrongs dts paths in lerna environment.
d.ts generates in packages/*/src/dist/<package.name>/src

Look at my project https://github.com/zerkalica/zerollup
rollup.config.js

    plugins: [
        typescript({
            abortOnError: true,
            check: true,
            exclude: ['*.spec*', '**/*.spec*'],
            tsconfig: path.join(__dirname, 'tsconfig.json'),
            tsconfigOverride: {
                // compilerOptions: {
                //     rootDir: cwd 
                // },
                include: [
                    __dirname + '/packages/*/src'
                ]
            }
        })
    ],

With rootDir uncommented, ts generates errors:

rpt2: options error TS6059 File '/user/projects/zerollup/packages/injector/src/index.ts' is not under 'rootDir' '/user/projects/zerollup/packages/helpers'. 'rootDir' is expected to contain all source files.

tsconfig.json

{
	"compilerOptions": {
		"baseUrl": "packages",
		"paths": {
			"@zerollup/*": [ "./*/src" ]
		},
		"allowSyntheticDefaultImports": false,
		"declaration": true,
		"module": "esnext",
		"target": "es5",
		"moduleResolution": "node",
		"sourceMap": true,
		"lib": [
			"dom",
			"esnext"
		],
		"jsx": "react",
		"noImplicitAny": false,
		"noUnusedLocals": true,
		"noImplicitReturns": true,
		"alwaysStrict": true,
		"strictNullChecks": false,
		"strictFunctionTypes": true,
		"removeComments": false,
		"experimentalDecorators": true
	},
	"include": [
		"packages/*/src"
	],
	"exclude": ["node_modules", "**/node_modules/*"]
}

Inferno uses ts2 rollup plugin and have same problem with path: join(__dirname, '../../build/packages/', pkgJSON.name, 'src/index.d.ts')

https://github.com/infernojs/inferno/blob/master/scripts/typings/build.js#L13

[Alxandr]

I managed to get it working. For reference, this is the main part of the script I'm using to generate rollup config:

import autoExternal from 'rollup-plugin-auto-external';
import fs from 'fs';
import path from 'path';
import { promisify } from 'util';
import typescript from 'rollup-plugin-typescript2';

const readFile = promisify(fs.readFile);

export default async ({ location, main, name }) => {
  const pkg = JSON.parse(
    await readFile(path.resolve(location, 'package.json'), {
      encoding: 'utf-8',
    }),
  );

  return {
    input: path.resolve(location, main),
    output: [
      { format: 'cjs', file: path.resolve(location, 'dist', `${name}.js`) },
      { format: 'es', file: path.resolve(location, 'dist', `${name}.mjs`) },
    ],
    plugins: [
      autoExternal({
        builtins: true,
        dependencies: true,
        packagePath: location,
        peerDependencies: true,
      }),
      typescript({
        tsconfigOverride: {
          compilerOptions: {
            rootDir: path.resolve(location, 'src'),
          },
          include: [path.resolve(location, 'src')],
        },
      }),
    ],
  };
};

[zerkalica]

It's not works for package in package directory which depends on another package in package directory.
in my repo packages/plugin-template has dependency packages/helpers

npm run build.plugin-template

rpt2: options error TS6059 File '/home/user/projects/zerollup/packages/helpers/src/index.ts' is not under 'rootDir' '/home/user/projects/zerollup/packages/plugin-template'. 'rootDir' is expected to contain all source files.

[Alxandr]

@zerkalica You should remove your paths configuration, and rely on node resolution. If you have lerna setup correct, then lerna bootstrap should create symlinks for you under the projects. So for instance, if you have two modules (A, and B), and A depends on B, then you get a symlink from packages/a/node_modules/B to packages/b. Then you just need to configure typings in packages/b/package.json.

[Alxandr]

You can see my setup here: https://github.com/YoloDev/aspnet-node-utils

[zerkalica]

Thank you @Alxandr
It looks like some workaround, but paths overriding in rollup config works.
Removing paths from tsconfig.json breaks ts resolution on clean project without builds.

Working configs:

rollup.config.js

    plugins: [
        typescript({
            abortOnError: true,
            check: true,
            exclude: ['*.spec*', '**/*.spec*'],
            tsconfig: path.join(__dirname, 'tsconfig.json'),
            tsconfigOverride: {
                compilerOptions: {
                    paths: [],
                    rootDir: path.join(cwd, 'src')
                },
                include: [path.join(cwd, 'src')]
            }
        })
    ],

tsconfig.json

{
        "compilerOptions": {
                "baseUrl": "packages",
                "paths": {
                        "@zerollup/*": [ "./*/src" ]
                },
                "allowSyntheticDefaultImports": false,
                "declaration": true,
                "module": "esnext",
                "target": "es5",
                "moduleResolution": "node",
                "sourceMap": true,
                "lib": [
                        "dom",
                        "esnext"
                ],
                "jsx": "react",
                "noImplicitAny": false,
                "noUnusedLocals": true,
                "noImplicitReturns": true,
                "alwaysStrict": true,
                "strictNullChecks": false,
                "strictFunctionTypes": true,
                "removeComments": false,
                "experimentalDecorators": true
        },
        "exclude": ["node_modules", "**/node_modules/*"]
}

[ezolenko]

@Alxandr @zerkalica looks like you both have a workaround. Doesn't look like I can do much to handle this situation automatically -- project structure information is unavailable to typescript before you define it in those overrides.

Another option, possibly cleaner, is to have a base tsconfig and individual tsconfigs for subprojects (located in subproject folders) that all extend base file (see extends option in tsconfig) and provide correct include values. Then give the plugin just the tsconfig option with correct file path for a given subproject.

[Alxandr]

@ezolenko Yes. I get that, but I was trying to get this working with minimal things having to be replaced per package. Also, I didn't know that it was caused by where my tsconfig lives, but thought instead it was caused by where my rollup config lived. Therefore I split my rollup config up into one per package, but that didn't help, and as such I made this issue. I would suggest having some documentation/examples for this in the readme :).

@zerkalica I can't speak to why you're not getting it working without keeping paths, but I can guess (as I don't have all the info). As said, the important part is in package.json, not tsconfig.json. You need to set typings to point to the entry ts file to get it to work before build. Again, you can see this working in my project.

[Edit]
I just noticed that you actually linked to your repository @zerkalica, and the "issue" is that your typings points to built files. Which does not exist before you build them. On the other hand, I have issues in that I need to ship the ts sources (which is probably even worse, and something I'm working on a fix for).

[zerkalica]

@Alxandr
Yes, I try to use prebuilded d.ts files in dist and do not include src into package

"types": "dist/index.d.ts",

With src directory included, we can completely disable d.ts generation. May be you right.

@ezolenko Have you some examples, how to do it without customizing tsconfig.json per each package in packages directory?

[ezolenko]

@zerkalica I haven't tried that, but I suspect if you create base tsconfig file with all the interesting options in the root, then create per-package tsconfigs that extend base file but have no other options at all, then tell plugin the path to a given package tsconfig in tsconfig option -- then everything would work.

Typescript will use tsconfig location as your source root and default values for includes would do the right thing.

[Alxandr]

If I'm not mistaken, that doesn't work. When you extend a tsconfig, you get it's base path and include path. At least that used to be the case.

[Alxandr]

@zerkalica You're using lerna, right? I'm trying to set up a script (using lerna lifecycle methods) such that when the package is being published it changes the types value in package.json. So you can keep it pointed at src for dev (I even use it to get the entry-point). Then, just before deploy, it's changed to point to dist. I think this is likely the way to go.

[ezolenko]

If derived tsconfig inherits default includes from base, then you might need to provide includes in derived file (they replace ones from base). If project structure is similar, that can be the same value in all copies of derived files. It is only a cosmetic difference vs using override even if it works though.