docs: document typewiz.json and monorepo

mockdeep / typewiz

Automatically discover and add missing types in your TypeScript code

https://medium.com/@urish/manual-typing-is-no-fun-introducing-typewiz-58e3e8813f4c

1.1k stars 46 forks source link

docs: document typewiz.json and monorepo #58

Closed zoehneto closed 6 years ago

zoehneto commented 6 years ago

Part of #31

Note:

This PR should probably only be merged shortly before releasing the next version to avoid confusing users looking at the README while config support is not yet available.

coveralls commented 6 years ago

Coverage increased (+0.5%) to 90.822% when pulling c557f5603eeb5eed2cd6ec0d7d9b9fe4d5988462 on zoehneto:config-file-docs into d76e5dd641701d0920d1596018995b8d74fd982c on urish:master.

urish commented 6 years ago

Thanks! I just published 1.0.0-alpha.0 with the latest changes, and they can be tested by installing typewiz-node@next, etc.

I plan to cut 1.0.0 as soon as we get the CLI ready (it's almost there - #60) as well as some automated test on a large code base (just to make sure our instrumentation doesn't product invalid TS code). I hope to get a beta release out this weekend.

zoehneto commented 6 years ago

Great. I'll create a PR for Schema Store tomorrow. If you want I can also update the docs for the new monorepo layout.

urish commented 6 years ago

Yes please, that would be lovely :)

I just used lerna publish for the first time - it's so much more fun that releasing manually :heart_eyes:

zoehneto commented 6 years ago

I just updated the rest of the docs for the new layout and the new workflow with lerna (no more yarn link). The only thing missing now is updating the applyTypes doc for typewiz-webpack once the cli is merged.

urish commented 6 years ago

Great! Seems like there's a good chance CLI merge will happen today :)

zoehneto commented 6 years ago

I just updated the typewiz-webpack documentation to use the cli. Now the only thing missing is updating the webpack demo project (probably best to do that once 1.0 is released).

urish commented 6 years ago

Lovely!

CLI merged yesterday 🎈 , released as typewiz@1.0.0-beta.1

I also refactored some of the ConfigurationParser tests to be a little simpler, and added some tests for the new CLI

zoehneto commented 6 years ago

Very nice. Since I'm already at it, I'll also add a sentence about the cli to the main README.