Version 2

[drewjbartlett]

Making a place to document the changes on V2

• Rewrite entirely in TypeScript
• Properly declare and import type definitions Properly declare and import type definitions #41
• Fix all tests Fix tests for v2 #46
• api renamed to http
• swap qs for qs-stringify since we only use that method https://www.npmjs.com/package/qs-stringify
• Allow for other promise-based http services to be used in place of axios with injection
• Rewrite version 2 docs to reflect updates
• Rewrite version 2 docs in nuxt (and maybe markdown)
• Extract debugger to allow easier testing and optionally include based off ENV
• Extract custom routes into package
• Add plugin system to allow syntax like rapid.use(customRouter)
• Fix nasty inheritance chain

[drewjbartlett]

@mgred I'm going to add a lot more features here but I figured for now we can use this to track progress and such. Feel no obligation to help me out, but if you want to it'd be much appreciated :D

[mgred]

@drewjbartlett that sounds like a plan! I will get into your branch over the weekend and see if there is something to add here.

[drewjbartlett]

@mgred Awesome thanks! More than anything I need help getting proper ts declarations and compiling in place. Right now I am a bit lost on some of those things :D

[mgred]

@drewjbartlett Alright, no problem! I think I can help there.

[yihou]

Hi @drewjbartlett, I think I can help out, where can I start from?
Should we use rollup to compile instead?
rollup ts: https://github.com/rollup/rollup-plugin-typescript
rollup config: https://github.com/rollup/rollup-starter-lib/blob/master/rollup.config.js

[drewjbartlett]

@yihou Thank you! Right now I have no working build tool for v2. Give a look at https://github.com/rapidjs/rapid.js/tree/v2-refactor and you can see what I (sort of) have in place. Ultimately I want to have a working typescript compiler. I think the first step is to take it in its current rendition and remove all the errors from the ts compiler and properly get that working. Then I have some other plans to rewrite and simplify the API! Thanks a ton for offering your help :D

[ctsstc]

I noticed the branch for v2 is 10 commits behind master, hopefully there's nothing too breaking to try and get caught up with. As mentioned in my PR into the v2 branch I would recommend looking at removing manually written d.ts files and let those be generated in the TS compile via some settings in the ts config, you may have to transition those d.ts files over to their own ts files for interfaces, etc. I've seen mixed answers about interface file naming conventions; I think if you're in C# you prepend them with and i, but in TS you don't iirc.

[mgred]

@ctsstc

I would recommend looking at removing manually written d.ts files and let those be generated in the TS compile via some settings in the ts config

I think this is the way to go. Basically {declaration: true} in the tsconfig.json should do the trick.

I think if you're in C# you prepend them with and i, but in TS you don't iirc.

Yes

[mgred]

Changed the description to also have a point regarding the tests

[mgred]

@drewjbartlett i just had a look at githubs project boards
Just a quick thought... do you think it would make sense to organise all the refactoring work there to have a better overview of the tasks and duties?

[drewjbartlett]

@mgred I am definitely not opposed to this. Let me evaluate shortly what I want to change and I will list it out and we can plan the attack :D

[mgred]

Nice thanks, @drewjbartlett