From ddc25a54b5119379e00af775c4a70144faf16d25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Drago=C8=99=20Str=C4=83inu?= Date: Sun, 17 May 2020 13:11:00 +0300 Subject: [PATCH] docs: add links to top with jump2header --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index f1967e2e3..0b9cf492d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Despite all the recent hype, setting up a new TypeScript (x React) library can be tough. Between [Rollup](https://github.com/rollup/rollup), [Jest](https://github.com/facebook/jest), `tsconfig`, [Yarn resolutions](https://yarnpkg.com/en/docs/selective-version-resolutions), ESLint, and getting VSCode to play nicely....there is just a whole lot of stuff to do (and things to screw up). TSDX is a zero-config CLI that helps you develop, test, and publish modern TypeScript packages with ease--so you can focus on your awesome new library and not waste another afternoon on the configuration. + + @@ -58,6 +60,8 @@ TSDX comes with the "battery-pack included" and is part of a complete TypeScript - Jest test runner setup with sensible defaults via `tsdx test` - Zero-config, single dependency +[🔝](#toc) + ## Quick Start ```bash @@ -102,6 +106,8 @@ If you want to customize eslint you can add an `eslint` block to your package.js Bundles and packages to the `dist` folder. Runs automatically when you run either `npm publish` or `yarn publish`. The `prepare` script will run the equivalent of `npm run build` or `yarn build`. It will also be run if your module is installed as a git dependency (ie: `"mymodule": "github:myuser/mymodule#some-branch"`) so it can be depended on without checking the transpiled code into git. +[🔝](#toc) + ## Optimizations Aside from just bundling your module into different formats, TSDX comes with some optimizations for your convenience. They yield objectively better code and smaller bundle sizes. @@ -300,6 +306,8 @@ Note: We don't provide this function for you, it is up to you how you want it to _TODO: Simple guide to host error codes to be completed_ +[🔝](#toc) + ## Customization ### Rollup @@ -385,6 +393,8 @@ You can add your own `jest.config.js` to the root of your project and TSDX will You can add your own `.eslintrc.js` to the root of your project and TSDX will **deep merge** it with [its own ESLint config](./src/createEslintConfig.ts). +[🔝](#toc) + ## 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. @@ -396,6 +406,8 @@ TSDX is ripped out of [Formik's](https://github.com/jaredpalmer/formik) build to - TSDX is 100% TypeScript focused - 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. +[🔝](#toc) + ## API Reference ### `tsdx watch` @@ -501,6 +513,8 @@ Examples $ tsdx lint src --report-file report.json ``` +[🔝](#toc) + ## Contributing Please see the [Contributing Guidelines](./CONTRIBUTING.md). @@ -621,3 +635,6 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! + + +[🔝](#toc)