intuit / LD-React-Components

Semantic component helpers to support LaunchDarkly feature flags in your React app.
MIT License
24 stars 35 forks source link

Refactor for TypeScript: Scaffolding #20

Closed poorpaddy closed 4 years ago

poorpaddy commented 4 years ago

There's a lot of benefit to using TypeScript for collaboration but also for self documenting code. Would be nice to have this project follow suit.

This issue is for setting up the scaffolding to support incremental TS building.

[ ] Backwards compatible [ ] Tests Pass [ ] Linting Passes

hjaintech commented 4 years ago

Hey @poorpaddy , Can I pick this up ? I believe doing this change incrementally would make more sense instead of doing it in one shot.

poorpaddy commented 4 years ago

@hjaintech Yes, by all means. Just fork and create a pull request. Remember to add yourself as a contributor in the PR. See readme for more information on that.

hjaintech commented 4 years ago

@poorpaddy Is there some documentation/examples apart from the Readme file which can help me understand the functionality/use case of this project ?

poorpaddy commented 4 years ago

@hjaintech This package is essentially an integration to the LaunchDarkly feature flag service. You can get an idea of what it does by visiting their site at https://launchdarkly.com.

As it pertains to documentation of this package all of the documentation is in the readme.

poorpaddy commented 4 years ago

@hjaintech I agree incremental is probably best. Although it really isn't a very large package.

mathagician commented 4 years ago

@poorpaddy I agree. Can you split it and create more issues. That shall also help in testing also.

Swazimodo commented 4 years ago

I have TS'ed things in the past and would be happy to help out. If this get's split then I can do a chunk. Whoever does the first PR will have to also lay the foundation for TS support (packages and config).

poorpaddy commented 4 years ago

@Swazimodo Yes, I am about to create a handful of issues. We can treat this one as a scaffolding. Just revisied the description.

poorpaddy commented 4 years ago

@Swazimodo @mathagician @hjaintech I've created a bunch of issues around this. Hopefully it makes it a bit easier to contribute.

billy-le commented 4 years ago

Hello, I would love to help out. I haven't set up ts in an existing project before so I won't be putting time into getting that up. However, I can handle converting some of the components if someone is able to get TS in the project.

heykevin commented 4 years ago

If no one's picked up the task of doing the scaffolding I can also give it a shot. I've introduced TS into projects a handful of times.

Swazimodo commented 4 years ago

Sounds good, let me know if you get stuck and I could give you a hand.

poorpaddy commented 4 years ago

@Swazimodo While I assigned it, it is on a first mergable pull request basis.

Swazimodo commented 4 years ago

Sorry for stealing this one but it was blocking my other change