types / mysql2

Typings for https://github.com/sidorares/node-mysql2
ISC License
41 stars 23 forks source link

Move to DT #19

Open SimonSchick opened 6 years ago

SimonSchick commented 6 years ago

I think it would be a good idea to move this repo to DefinitelyTyped.

dashmug commented 6 years ago

I agree.

moberemk commented 6 years ago

Any movement on this? It'd be nice to be able to install this like more traditional type libraries; alternatively the types here could be added to the core mysql2 library via PR if you're alright with that.

tbjers commented 6 years ago

+1

breitsmiley commented 6 years ago

+1

blakeembrey commented 6 years ago

@felixfbecker This is your decision 😄 It might make sense to authorize someone to copy the definition and hand off maintenance to DefinitelyTyped.

For everyone here, note that a lot of people in @types spent a lot of time creating high quality definitions that ultimately were incompatible with the TypeScript operating model because we don't want to work on DefinitelyTyped (hard to iterate, hard to respond to issues, giant mono repo lacking individual ownership, etc) and this resulted in a lot of burn out (especially personally, I dropped OSS for the past year).

moberemk commented 6 years ago

@blakeembrey I feel you for sure on your issues with DT; that's why personally I prefer moving the definitions from here over into the actual mysql2 library. Assuming @sidorares is comfortable with that addition to the repository, I generally feel that including types with the actual package is a superior option to any external source of truth; see the neverending discussion around the Stripe library's types for an example of why.

sidorares commented 6 years ago

@moberemk @blakeembrey yes, happy to have type definitions in repo

dashmug commented 6 years ago

yes, happy to have type definitions in repo

Best news I read this morning! Thanks @sidorares!

moberemk commented 6 years ago

Worth noting that, as things are now, that would mean including @types/mysql as an added dependency for mysql2. If that's not an issue then we should be good to go on this.

melroy89 commented 5 years ago

Any update?

sidorares commented 5 years ago

@danger89 I haven't done anything myself. Happy to review PRs on this

Kosta-Github commented 4 years ago

any updates on this one? would be very much appreciated!

mike-marcacci commented 4 years ago

It sounds like we've got a green light from everybody involved, and are just waiting on someone to make a PR. Is this correct @sidorares @felixfbecker?

Types for mysql2 will be needed on a large project that I'm helping modernize, so I can champion this.

As ISC and MIT are largely compatible (IANAL but this is a widely held perspective), we can probably just embed this entire codebase in a types directory and add both licenses to the mysql2 license file. However, for the sake of simplicity, @felixfbecker would you mind re-licensing this under MIT (again, IANAL but attestation here is probably sufficient) and allow us to simply use the mysql2 license as written (given its existing "and contributors" copyright) or perhaps just add your name to the copyright?

felixfbecker commented 4 years ago

You're welcome to do whatever with it. Pretty sure ISC and MIT are equivalent.

sidorares commented 4 years ago

Is this correct

@mike-marcacci yes, I'm just observer here, happy to merge types if quality looks good enough but I'm not the best person to author