Skip to content

Commit

Permalink
feat/types: import types in jsdoc
Browse files Browse the repository at this point in the history
- remove main field from package.json
- update integration test fixtures
- update readme example
  • Loading branch information
cncolder committed Oct 1, 2020
1 parent 66d60de commit dd6624d
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 8 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,15 +324,14 @@ The `options` object type definition in [src/externalTypes.ts](src/externalTypes
#### Example: Adding Postcss

```js
const tsdx = require('tsdx');
const postcss = require('rollup-plugin-postcss');
const autoprefixer = require('autoprefixer');
const cssnano = require('cssnano');

module.exports = {
/**
* @param {tsdx.RollupOptions} config
* @param {tsdx.TsdxOptions} options
* @param {import('tsdx').RollupOptions} config
* @param {import('tsdx').TsdxOptions} options
*/
rollup(config, options) {
config.plugins.push(
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
"bugs": {
"url": "https://github.com/formium/tsdx/issues"
},
"main": "./dist/externalTypes.js",
"typings": "./dist/externalTypes.d.ts",
"bin": {
"tsdx": "./dist/index.js"
Expand Down
6 changes: 2 additions & 4 deletions test/integration/fixtures/build-withConfig/tsdx.config.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
/* eslint-disable-next-line no-unused-vars */
const tsdx = require('..');
const postcss = require('rollup-plugin-postcss');
const autoprefixer = require('autoprefixer');
const cssnano = require('cssnano');

module.exports = {
/**
* @param {tsdx.RollupOptions} config
* @param {tsdx.TsdxOptions} options
* @param {import('tsdx').RollupOptions} config
* @param {import('tsdx').TsdxOptions} options
*/
rollup(config, options) {
config.plugins.push(
Expand Down

0 comments on commit dd6624d

Please sign in to comment.