jaredpalmer · cncolder · Aug 23, 2020 · Aug 23, 2020 · Aug 23, 2020 · Aug 30, 2020
diff --git a/README.md b/README.md
@@ -319,32 +319,7 @@ module.exports = {
 };
 ```
 
-The `options` object contains the following:
-
-```tsx
-export interface TsdxOptions {
-  // path to file
-  input: string;
-  // Name of package
-  name: string;
-  // JS target
-  target: 'node' | 'browser';
-  // Module format
-  format: 'cjs' | 'umd' | 'esm' | 'system';
-  // Environment
-  env: 'development' | 'production';
-  // Path to tsconfig file
-  tsconfig?: string;
-  // Is error extraction running?
-  extractErrors?: boolean;
-  // Is minifying?
-  minify?: boolean;
-  // Is this the very first rollup config (and thus should one-off metadata be extracted)?
-  writeMeta?: boolean;
-  // Only transpile, do not type check (makes compilation faster)
-  transpileOnly?: boolean;
-}
-```
+The `options` object type definition in [src/externalTypes.ts](src/externalTypes.ts).
 
 #### Example: Adding Postcss
 
@@ -354,6 +329,10 @@ const autoprefixer = require('autoprefixer');
 const cssnano = require('cssnano');
 
 module.exports = {
+  /**
+   * @param {import('tsdx').RollupOptions} config
+   * @param {import('tsdx').TsdxOptions} options
+   */
   rollup(config, options) {
     config.plugins.push(
       postcss({

diff --git a/package.json b/package.json
@@ -18,6 +18,7 @@
   "bugs": {
     "url": "https://github.com/formium/tsdx/issues"
   },
+  "typings": "./dist/externalTypes.d.ts",
   "bin": {
     "tsdx": "./dist/index.js"
   },

diff --git a/src/externalTypes.ts b/src/externalTypes.ts
@@ -0,0 +1,2 @@
+export { RollupOptions } from 'rollup';
+export { TsdxOptions } from './types';
diff --git a/src/types.ts b/src/types.ts
@@ -1,9 +1,9 @@
 interface SharedOpts {
-  // JS target
+  /** JS target */
   target: 'node' | 'browser';
-  // Path to tsconfig file
+  /** Path to tsconfig file */
   tsconfig?: string;
-  // Is error extraction running?
+  /** Is error extraction running? */
   extractErrors?: boolean;
 }
 
@@ -33,19 +33,19 @@ export interface NormalizedOpts
 }
 
 export interface TsdxOptions extends SharedOpts {
-  // Name of package
+  /** Name of package */
   name: string;
-  // path to file
+  /** path to file */
   input: string;
-  // Environment
+  /** Environment */
   env: 'development' | 'production';
-  // Module format
+  /** Module format */
   format: ModuleFormat;
-  // Is minifying?
+  /** Is minifying? */
   minify?: boolean;
-  // Is this the very first rollup config (and thus should one-off metadata be extracted)?
+  /** Is this the very first rollup config (and thus should one-off metadata be extracted)? */
   writeMeta?: boolean;
-  // Only transpile, do not type check (makes compilation faster)
+  /** Only transpile, do not type check (makes compilation faster) */
   transpileOnly?: boolean;
 }
 

diff --git a/test/integration/fixtures/build-withConfig/tsdx.config.js b/test/integration/fixtures/build-withConfig/tsdx.config.js
@@ -3,6 +3,10 @@ const autoprefixer = require('autoprefixer');
 const cssnano = require('cssnano');
 
 module.exports = {
+  /**
+   * @param {import('tsdx').RollupOptions} config
+   * @param {import('tsdx').TsdxOptions} options
-   * @param {import('tsdx').RollupOptions} config
-   * @param {import('tsdx').TsdxOptions} options
+   * @param {import('../../../../').RollupOptions} config
+   * @param {import('../../../../').TsdxOptions} options
-   * @param {import('tsdx').RollupOptions} config
-   * @param {import('tsdx').TsdxOptions} options
+   * @param {import('../../../../').RollupOptions} config
+   * @param {import('../../../../').TsdxOptions} options
+   */
   rollup(config, options) {
     config.plugins.push(
       postcss({

diff --git a/tsconfig.json b/tsconfig.json
@@ -7,7 +7,7 @@
     "importHelpers": true,
     "esModuleInterop": true,
     "outDir": "dist",
-    "declaration": false,
+    "declaration": true,
     "module": "commonjs",
     "rootDir": "src",
     "strict": true,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export { RollupOptions } from 'rollup';
Copy link Collaborator agilgur5 Aug 30, 2020 • edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. I was thinking of using the exact type that TSDX modifies this to, although that may not be possible to override Copy link Collaborator agilgur5 Oct 1, 2020 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Nevermind, TSDX itself uses `RollupOptions` internally. Copy link Collaborator agilgur5 Oct 12, 2020 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. So I ran `tsc` over a `tsdx.config.js` with the proper import and a `// @ts-check` and `allowJs: "true"` etc and that actually failed because of the lack of exact typing. E.g.: $ tsc --noEmit tsdx.config.js:13:5 - error TS2532: Object is possibly 'undefined'. 13 config.plugins.push( Now the problem is that I'm not entirely sure how to do this in TS or if it's possible to. TSDX's Rollup config should conform to `RollupOptions` but should also be more specific than `RollupOptions` -- e.g. we should know that `config.plugins.push` is possible without any type-casting. Of course, TSDX Rollup config could have its own interface that extends `RollupOptions`, but that would be the naive route and could still cause users some type-checking problems. The config is complex enough that I'd like it to be inferred (especially the plugins' types, since users may override them) while still conforming to `RollupOptions` (so we don't get problems like #371 ). I'm not sure if that's possible in TS or if I just haven't been able to figure out how to do it in TS.
		export { TsdxOptions } from './types';