Skip to content

Commit

Permalink
docs: update features and comparison with changes from past year (#847)
Browse files Browse the repository at this point in the history
- `tsdx lint` is a thing now
- `tsdx create` is a thing
- `tsdx.config.js` is a thing now

- "last year or so" in reference to microbundle is outdated now and the
  differences have grown since then, so be softer on the language of
  similarities
- TSDX now has good support for JS as well, I put in a good bit of work
  to make that possible, especially for gradual migrations and partial
  codebases
  - and some contributors helped as well
  • Loading branch information
agilgur5 authored Aug 31, 2020
1 parent 45aea66 commit 1619bc1
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ TSDX comes with the "battery-pack included" and is part of a complete TypeScript
- Bundle size snapshots
- Opt-in to extract `invariant` error codes
- Jest test runner setup with sensible defaults via `tsdx test`
- ESLint with Prettier setup with sensible defaults via `tsdx lint`
- Zero-config, single dependency
- Escape hatches for customization via `.babelrc.js`, `jest.config.js`, `.eslintrc.js`, and `tsdx.config.js`

## Quick Start

Expand Down Expand Up @@ -387,13 +389,18 @@ You can add your own `.eslintrc.js` to the root of your project and TSDX will **

## Inspiration

TSDX is ripped out of [Formik's](https://github.com/jaredpalmer/formik) build tooling. TSDX is very similar to [@developit/microbundle](https://github.com/developit/microbundle), but that is because Formik's Rollup configuration and Microbundle's internals have converged around similar plugins over the last year or so.
TSDX was originally ripped out of [Formik's](https://github.com/jaredpalmer/formik) build tooling.
TSDX has several similarities to [@developit/microbundle](https://github.com/developit/microbundle), but that is because Formik's Rollup configuration and Microbundle's internals had converged around similar plugins.

### Comparison with Microbundle

Some key differences include:

- TSDX includes out-of-the-box test running via Jest
- TSDX includes a bootstrap command and default package template
- TSDX is 100% TypeScript focused
- TSDX includes out-of-the-box linting and formatting via ESLint and Prettier
- TSDX includes a bootstrap command with a few package templates
- TSDX allows for some lightweight customization
- TSDX is TypeScript focused, but also supports plain JavaScript
- TSDX outputs distinct development and production builds (like React does) for CJS and UMD builds. This means you can include rich error messages and other dev-friendly goodies without sacrificing final bundle size.

## API Reference
Expand Down

1 comment on commit 1619bc1

@vercel
Copy link

@vercel vercel bot commented on 1619bc1 Aug 31, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.