Change Log

v0.14.1

Published on Tue Oct 13 2020.

Bugfixes

• An upstream cache bug that affected certain combinations of build formats has been fixed

  • The error that was fixed would look similar to: txt (typescript) Error: ENOENT: no such file or directory, rename '[...]/my-lib/node_modules/.cache/rollup-plugin-typescript2/rpt2_4c61ae4392b9bd24f4d43d13a3f56419b8b5805d/code/cache_' -> '[...]/my-lib/node_modules/.cache/rollup-plugin-typescript2/rpt2_4c61ae4392b9bd24f4d43d13a3f56419b8b5805d/code/cache'

• The built-in lodash -> lodash-es replacement no longer breaks imports of lodash/fp

Dependencies

• The warning about incompatible peerDeps from eslint-config-react-app has been resolved

Commits

v0.14.0

Published on Mon Sep 21 2020.

BREAKING CHANGES

Slightly Breaking Changes

Node 10+

Updated the required Node version from 8 to 10.

While previous versions of TSDX began deprecating support for Node 8, it was not officially dropped. In this release, we have officially dropped Node 8: TSDX now requires Node 10+ as many dependencies that were upgraded similarly do.

This should not impact most users as Node 8 has been EoL for ~9 months now. Many packages had already required Node 10+ and the vast majority already have support for it. Most users are on Node 12 or Node 14 already.

Jest 25

Updated the Jest version used by tsdx test from 24 to 25.

The main breaking change in Jest 25 is the upgrade of the default JSDOM environment from JSDOM v11 to JSDOM v15. For most Jest users, this change either has no impact or will reduce configuration if you've manually set a more up-to-date jest-environment-jsdom in your jest.config.js. In some rare cases, where code relied on the old version of JSDOM, this may result in breakage.

• Jest 25 Blog Post
• Jest 25 Changelog

ts-jest and jest-plugin-typeahead have also been upgraded to support Jest 25.

Babel Changes

babel-plugin-transform-async-to-promises -> babel-plugin-polyfill-regenerator

async-to-promises has been unmaintained for around a year now and has several correctness issues, many of which have affected TSDX users. For that reason, we've switched to using babel-plugin-polyfill-regenerator instead, which will add a pure, non-polluting regenerator-runtime polyfill if your targets require it.

The vast majority of browsers (94.37%) now support async/await and generators with no polyfilling necessary, but the default preset-env will add it. If you don't already have one, we recommend adding a .browserslistrc (or preset-env targets) to specify the environments you're targeting.

This should be totally backward-compatible, but it may change the output quite a bit, including making bundles larger due to inclusion of regenerator-runtime.

babel-plugin-macros

TSDX's internal Babel plugin ordering has changed, moving babel-plugin-macros to be first. This was done in order to support several use-cases like styled-components/macro, which previously did not work due to the ordering.

This shouldn't really break anything, but there is an off chance it might have an impact on some rare builds.

Improvements

• Jest 25 / JSDOM 15 usage per above
• Due to the babel-plugin-polyfill-regenerator change above, TSDX now supports polyfilling generators out-of-the-box. Previously we only supported async/await with babel-plugin-transform-async-to-promises and required users to configure their own plugins for generator polyfilling
• styled-components/macro support per above
• A --max-warnings flag has been added to tsdx lint, which works the same as ESLint's --max-warnings flag

Template Improvements

• Storybook template has been updated to Storybook v6, which significantly simplifies the config and adds some features
• Storybook template has now been configured to type-check during Storybook builds
• size-limit has been added to all templates for bundle analysis via NPM/Yarn scripts and a GitHub Action
• All templates' GitHub Actions now have matrix testing for different Node versions and OSes out-of-the-box
• All templates' GitHub Actions now have simplified config and improved caching using bahmutov/npm-install
  • All templates' tsconfig.json now set skipLibCheck, forceConsistentCasingInFileNames, and noEmit
    • The former two are now recommended by TS and the latter one is just a usability improvement for those who use tsc for type-checking. skipLibCheck will also greatly increase performance of tsc's type-checking
• All templates' tsconfig.json now have detailed comments explaining nearly every configuration option in use

Docs

• patch-package is now officially listed as a customization option

Dependencies

• Jest 25 and Node 10+ per above. Most deps were updated by a major or two.
• @babel/preset-env was updated to the latest minor to support nullish coalescing and optional chaining without additional plugins, as well as to update the compatibility table.
  • If you have snapshots that rely on specific output from preset-env or Autoprefixer, as TSDX's internal test suite does, you may need to update those snapshots.
• All vulnerabilities and deprecation warnings should now be resolved
• Due to some upgrades, clean-up, and use of yarn-deduplicate, overall install size should have decreased a good bit

Commits

Postscript

Apologies again for the delay on getting to v0.14.0, COVID added a lot of stress and work had been busy, to say the least. Unfortunately I wasn't able to get to all the changes I wanted to into it, but v0.14.0 has been waiting long enough. Only two complex issues were left out and many more PRs added in, though not everything had made it into v0.13.x either.

I also wanted to push Rollup 2, TS 4.0, Prettier 2, and ESLint upgrades into this, but the breaking changes in the changelog started getting too big, so I decided to wait a bit to split those changes across more releases to not throw too much breakage at users at once.

If you're wondering, all of my co-workers, my team, and I were suddenly laid off just over a week ago, so that's why I had time (and want to distract myself) to push out ~2 dozen PRs the past week 😕

Best wishes and stay safe to everyone!

v0.13.3

Published on Sun Aug 23 2020.

Optimizations

• Types are only checked once now, type declarations are only emitted once now, and cache is shared with all formats
  • Previously it was once per each format
  • This was a roughly 15-30% perf boost altogether on the TSDX test suite, but YMMV

Template Bugfixes

• Templates no longer have baseUrl or paths set in their tsconfig, fixing a long-standing bug

Template Docs

• Template READMEs have been significantly improved, adding consistency between all 3, fixing outdated portions, and better describing certain behaviors

Commits

Postscript

Apologies for the delay on releasing this and the delay on getting to v0.14.0, COVID added a lot of stress and work has been busy, to say the least. I'm behind on all of my OSS repos, TSDX is actually the most maintained (but needs a lot more attention) 😕 v0.14.0 will be the next release, which will be a breaking change mostly due to updating dependencies' majors. I held back on it to get more into v0.13.x before getting busy, but unfortunately I wasn't able to get to all the changes I wanted to into it, but v0.14.0 has been waiting long enough

Wishing everyone well! Please stay safe and please do your part to follow public health guidelines!

✊ Quoting from a Chromium release ✊ : > Black Lives Matter. Saying this does not mean that other lives do not matter. It should not be controversial to say this. If I say Chromium updates matter, it does not mean that other Fedora packages do not matter, it means that a Chromium update is needed to fix this giant pile of severe security vulnerabilities, here, today, now: [...]

In making that analogy, I do not intend to trivialize BLM. In no way do I mean to compare the lives of people to a silly web browser update. People are infinitely important than software. But since I'm here to push this software update out, I am also choosing to say clearly and unambiguously that Black Lives Matter.

Open Source proves that many voices, many contributions, together can change the world. It depends on it. This is my voice.

v0.13.2

Published on Mon Apr 13 2020.

Bugfixes

• @types/jest was moved to be a dependency instead of a devDependency. It has also been removed from the templates.
  • This should fix any version mismatch issues that were occuring, like using @types/jest v25 but Jest v24.
    • Stay tuned for an upgrade to Jest v25 in the next minor release of TSDX
• semver was also moved from devDependency to dependency. It's used in tsdx create, so it was misplaced.

Template Improvements

• Several redundant tsconfig compilerOptions have been removed. strict already includes all of these.

Commits:

Postscript

Wishing everyone well during the pandemic! Please stay safe and please do your part to follow public health guidelines!

If you're looking for more ways to help out, there are many, many around and likely local initiatives where you live. I also included a small few I stumbled upon in the previous release postscript. Another recent relevant one might be the shortage of COBOL programmers in the US. If you're a tech worker interested in helping out NJ (whether you know COBOL or not), there's a sign-up form here.

v0.13.1

Published on Sun Mar 29 2020.

Template Bugfix

• tsconfig.json include was changed to remove test from the array. This faulty include resulted in declarations being generated in dist/ for test files as well as slowing down builds. It was also the cause of TS errors around v0.13.0's change to rootDir: './src'

Tests

• Testing has been significantly improved in the commits leading up to this release, including:
  • creating an integration test set-up
  • creating many integration tests
  • migrating the tests to TypeScript (they were previously 99% JS)

Commits:

Postscript

Wishing everyone well during the pandemic! Please stay safe and follow the guidelines of public health officials, for yourself, for your family, and for everyone else and their families!

There's also lots of ways to help out, here's just a few I've stumbled upon: - https://foldingathome.org/ - https://stackoverflow.blog/2020/03/26/ways-to-help-the-fight-against-covid-19-from-home/ - http://hackathon.gogcrc.org/ - #BuildforCOVID19 - https://covid19responsefund.org/ - https://www.gofundme.com/c/act/covid19 - https://github.com/jcl5m1/ventilator, https://github.com/jcl5m1/ventilator/issues/17

v0.13.0

Published on Fri Mar 20 2020.

Deprecations

• tsconfig.json rootDir has been changed to ./src. ./ is now deprecated and will give a warning

Improvements

• Async Rollup Plugins for tsdx.config.js are now supported out-of-the-box (no more need for hacks like objectHashIgnoreUnknownHack)
• Jest's --config flag is now respected
• tsconfig.json's declarationDir is now respected
• Much better support of JS & JSX files in build, test, and lint. This should enhance the gradual migration experience quite a bit
• Co-located test files are ignored during build by default now (so unnecessary declarations aren't generated for them)

Bugfixes

• Babel presets should no longer be ignored and will be merged with TSDX's defaults
• Multiple JSX -> JSX imports should resolve correctly now
• src/index.jsx will now be parsed as an entry file (previously only .ts, .tsx, and .js were)
• esModuleInterop should be properly read now for the purposes of configuring Rollup's esModule / CJS __esModule -- a bug made it so these were always added previously. This does not impact parsing of esModuleInterop for anything else, which worked correctly and still does.
• Jest transform regexes are now properly anchored, non-TS/TSX files shouldn't be passed to ts-jest anymore
• Jest config parsing now errors loudly instead of silently during failures
• Async Rollup Plugins in tsdx.config.js don't bug out anymore

Templates

• Storybook template has been significantly upgraded and patched
• GH Actions have been added to all templates
• tsconfig.json rootDir has been changed to ./src. ./ is now deprecated and will give a warning
• Confusing tsconfig.json target has been removed as it is not currently configurable (configured with @babel/preset-env instead)
• src is now included in package.json files to improve debugging
• Node version requirement is enforced when creating templates

Commits:

Commit Range

https://github.com/jaredpalmer/tsdx/compare/v0.12.3...v0.13.0

Postscript

Sorry for the long delay on this release everyone, I was recently added as an official maintainer (a week ago) and just given publishing privileges (yesterday). See https://github.com/jaredpalmer/tsdx/issues/512 for more details.

Wishing everyone well during the pandemic!

v0.12.3

Published on Mon Jan 13 2020.

Patch

• tsdx test no longer defaults to watch mode in interactive environments. This reverts previous behavior which caused bugs.

Commits - Run tests in series with --runInBand (#429) 367a7a5 - Deprecate Node 8 support (#426) bd35f65 - Revert "default jest watch unless in CI" PR #366 (#421) 95ac3f4 - Drop Node 8 from test matrix f1cf8b1

https://github.com/jaredpalmer/tsdx/compare/v0.12.2...v0.12.3

v0.12.2

Published on Mon Jan 13 2020.

Patch

• Fix issue with TS compilation. Please upgrade to 12.2, as builds are inconsistent.

Commits - (docs): add contributing guidelines (#417) e5747fd - Fix onFailure example (#416) 9e8ab92 - (fix): revert #130's breaking change of tsconfig options (#415) 00f80ac - (refactor): replace ensureDistFolder with fs.outputFile (#406) ea124bc - upgraded rollup-plugin-'s to @rollup/plugin-'s. (#411) cfc1e76 - (docs): add warning to tsdx.config.js usage (#400) 35fa947 - (types/refactor): be more specific than 'any' in build code (#401) 158ee9a - (refactor): use path constants instead of custom resolveApp (#402) a38041f - (docs): run doctoc on pre-commit (#399) f338613

https://github.com/jaredpalmer/tsdx/compare/v0.12.1...v0.12.2

v0.12.1

Published on Sun Dec 29 2019.

Improvements

• Add success/failure flags
• Add transpileOnly flag

Description
  Rebuilds on any change

Usage
  $ tsdx watch [options]

Options
  -i, --entry           Entry module(s)
  --target              Specify your target environment  (default web)
  --name                Specify name exposed in UMD builds
  --format              Specify module format(s)  (default cjs,esm)
  --tsconfig            Specify your custom tsconfig path (default <root-folder>/tsconfig.json)
  --verbose             Keep outdated console output in watch mode instead of clearing the screen
+  --onFirstSuccess      Run a command on the first successful build
+  --onSuccess           Run a command on a successful build
+  --onFailure           Run a command on a failed build
  --noClean             Don't clean the dist folder
+  --transpileOnly       Skip type checking
  -h, --help            Displays this message

Examples
  $ tsdx watch --entry src/foo.tsx
  $ tsdx watch --target node
  $ tsdx watch --name Foo
  $ tsdx watch --format cjs,esm,umd
  $ tsdx watch --tsconfig ./tsconfig.foo.json
  $ tsdx watch --noClean
+  $ tsdx watch --onFirstSuccess "echo The first successful build!"
+  $ tsdx watch --onSuccess "echo Successful build!"
+  $ tsdx watch --onFailure "The build failed!"
+  $ tsdx watch --transpileOnly

Bugfixes

• Fixed jest watch mode

Commits - (refactor): invert if in run function (#404) e1370de - (optim/test): use node testEnvironment (#405) ec0f285 - (clean): remove --env=jsdom as JSDOM is Jest's default (#396) 7c79b74 - (format): alphabetize package.json deps (#398) 27ba1dd - (docs/fix): fix ToC changes / bugs introduced in #307 (#397) 387f3c2 - (docs): improve test watch mode docs (#395) 531010e - Update @types/node to the latest version 🚀 (#391) be3c410 - [docs] howto turn off watch mode (#385) efb3539 - feat: Add success/failure hooks to watch (#130) ab54278 - (types/fix): explicit Rollup typing, fix treeshake location (#371) 2a5e5a5 - feat: Add transpileOnly flag to watch and build command (#307) ee4b307

https://github.com/jaredpalmer/tsdx/compare/v0.12.0...v0.12.1

v0.12.0

Published on Thu Dec 19 2019.

Improvements

• Added Storybook template
• Upgraded to Ts 3.7.x
• Updated rollup deps / plugins
• Moved the cache root to be inside of node_modules, you can delete the .rts2cachexxx folders from root and remove them from your .gitignore files
• (internals) Made internal methods async where possible, should result in a minor speed boost.
• Added optional chaining and nullish coalescing operators support
• When running in an interactive shell (i.e. if process.env.CI false), tsdx test now runs Jest in watch mode. Note: Most CI services set CI env variable to true by default. Our implementation is exactly how create-react-app does it.
• tsdx test will pass in cases where no tests exist

• Added "prepare" task to package.json scripts so that you can publish immediately. For those interested, I like to publish (TSDX) packages with np to do this.

  Bugfixes

• Fix error when providing babel/preset-env without options
• Got rid of eslint warning upon install
• (Internal) Tests now run on PRs
• Do not output warning about react on non-react projects

Roadmap

• Add Closure Compiler
• Better support for "preshaking" and top level exports
• Monorepo support. Note: Formik is now using lerna and TSDX, so we'll be using it as a playground

Commits - (deps/lint): upgrade @typescript-eslint to support ?. and ?? (#377) 843c676 - (ci): add a lint job so PRs will require passing lint (#378) 930feb9 - (clean): remove .rtscache* from storybook gitignore (#375) c5df5ac - Add optional chaining and nullish coalescing operators support (#370) a736c77 - Added Storybook template (#318) c487377 - Merge pull request #373 from agilgur5/fix-pr-ci 7c8481b - (fix/ci): GitHub Actions should run on PRs as well 5da9f65 - Merge pull request #372 from agilgur5/fix-format b8f24e2 - (fix/format): formatting of #366 didn't pass lint f3399e0 - Add prepare script to generated project (#334) ef93d1d - default jest to watch mode when not in CI (#366) 5ee9dfc - (fix): respect tsconfig esModuleInterop flag (#327) e8be03c - Merge pull request #368 from jamesgeorge007/hotfix/typo-fix 78cccfe - fix: minor typo aa8ab42 - update rollup deps and plugins (#364) d621994 - update rollup deps and plugins eb35feb - update to ts 3.7 (#363) cab5591 - update to ts 3.7 5e84911 - Remove unnecessary yarn install command in GH action (#361) c44bd41 - Remove unnecessary yarn install command in GH action 3148138 - Replaced some sync methods for their async version (#291) c5f65bc - Merge pull request #360 from goznauk/master 5aa5eda - update README.md dfdd364 - update README.md 085916c - Use node_modules/.cache/... as cacheRoot (#329) 55c0d47 - fix(lint): Only default to src test if they exist (#344) 3261dea - Fix error when providing babel/preset-env without options (#350) a1a0dcb - Replaced some sync methods for their async version 4deb7e2 - fix(lint): do not output warning about react on non-react projec… (#308) 6252b70 - chore(lint): use detect setting for eslint-plugin-react in react projects b6c3153 - fix(eslint): do not output warning about react on non-react projects 830e413 - Merge pull request #303 from jaredpalmer/greenkeeper/rollup-plugin-typescript2-0.25.2 ffd8733 - chore(package): update lockfile yarn.lock ed6f490 - fix(package): update rollup-plugin-typescript2 to version 0.25.2 62f0241 - feat(utils): add util that gets the React version of a project, if exists cf6718c - Tweak docs f1a2643 - Update execa to the latest version 🚀 (#266) 6225b8e - Merge branch 'master' into greenkeeper/execa-3.2.0 c9f04c3 - Merge pull request #195 from sadsa/patch-1 acd7e54 - Update eslint-plugin-react-hooks to the latest version 🚀 (#281) 72154fa - chore(package): update lockfile yarn.lock 1186b7d - fix(package): update eslint-plugin-react-hooks to version 2.2.0 28f16c2 - chore(package): update lockfile yarn.lock 1cd2fb3 - fix(package): update execa to version 3.2.0 d6b5ef3 - Pass tests in cases where no tests exist 61a3177

https://github.com/jaredpalmer/tsdx/compare/v0.11.0...v0.12.0