|
2 | 2 |
|
3 | 3 | ## Reporting bugs
|
4 | 4 |
|
5 |
| -Report any bugs on github: <https://github.com/ezolenko/rollup-plugin-typescript2/issues>. |
| 5 | +Report any bugs [in the GitHub Issue Tracker](https://github.com/ezolenko/rollup-plugin-typescript2/issues). |
6 | 6 |
|
7 |
| -Attach your `tsconfig.json`, `package.json` (for versions of dependencies), rollup script and anything else that could influence module resolution, ambient types and typescript compilation. |
| 7 | +Attach your `tsconfig.json`, `package.json` (for versions of dependencies), `rollup.config.js`, and anything else that could influence module resolution, ambient types, and TS compilation. |
8 | 8 |
|
9 |
| -Check if problem is reproducible after running `npm prune` to clear any rogue types from npm_modules (by default typescript grabs all ambient types). |
| 9 | +Check if the problem is reproducible after running `npm prune` to clear any rogue types from `node_modules` (by default TS grabs _all_ ambient types). |
10 | 10 |
|
11 |
| -Check if you get the same problem with `clean` option set to true (might indicate a bug in the cache). |
| 11 | +Check if you get the same problem with `clean` option set to `true` (might indicate a bug in the cache). |
12 | 12 |
|
13 |
| -If makes sense, check if running `tsc` directly produces similar results. |
| 13 | +If it makes sense, check if running `tsc` directly produces similar results. |
14 | 14 |
|
15 | 15 | Attach plugin output with `verbosity` option set to 3 (this will list all files being transpiled and their imports).
|
16 | 16 |
|
17 | 17 | ## Developing
|
18 | 18 |
|
19 |
| -Use the normal github process of forking, making a branch and creating a PR when ready. Fix all linting problems (run `npm lint`), fix any failed checks that are run on the PR (basically lint right now). Use an editor that supports editorconfig, or match the settings from `.editorconfig` file manually. |
| 19 | +Use the [standard GitHub process](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model) of forking, making a branch, and creating a PR when ready. Fix all linting problems (`npm run lint`) and fix any failed checks on the PR. Use an editor that supports `editorconfig`, or match the settings from [`.editorconfig`](./.editorconfig) manually. |
20 | 20 |
|
21 |
| -Fastest way to test changes is to do a self build, the plugin is part of its own build system: |
22 |
| -- make changes |
23 |
| -- run `npm build` (uses last released version on npm) |
24 |
| -- check that you get expected changes in `dist` |
25 |
| -- run `npm build-self` (uses fresh local build) |
26 |
| -- check `dist` for the expected changes |
27 |
| -- run `npm build-self` _again_ to make sure plugin built by new version can still build itself |
| 21 | +Fastest way to test changes is to do a self build; the plugin is part of its own build system: |
28 | 22 |
|
29 |
| -If `build-self` breaks at some point, fix the problem and restart from `build` step (a known good copy). |
| 23 | +1. make changes |
| 24 | +1. run `npm build` (uses last released version on npm) |
| 25 | +1. check that you get expected changes in `dist` |
| 26 | +1. run `npm build-self` (uses fresh local build) |
| 27 | +1. check `dist` for the expected changes |
| 28 | +1. run `npm build-self` _again_ to make sure plugin built by new version can still build itself |
30 | 29 |
|
31 |
| -This repo badly needs unittests and integration tests with various scenarios and expected outcomes though. |
| 30 | +If `build-self` breaks at some point, fix the problem and restart from the `build` step (a known good copy). |
| 31 | + |
| 32 | +This repo badly needs unit tests and integration tests with various scenarios and expected outcomes though. |
0 commit comments