Create TypeScript MVP for Issues Functionality to Determine Viability - Githubissues

node-gh / gh

(DEPRECATED) GitHub CLI made with NodeJS. Use the official https://cli.github.com/ instead.

http://nodegh.io

Other

1.71k stars 217 forks source link

Create TypeScript MVP for Issues Functionality to Determine Viability #543

Closed protoEvangelion closed 6 years ago

protoEvangelion commented 6 years ago

After studying TypeScript & using it on a personal project, Node GH seems like a great candidate to refactor.

Some of the benefits I think could be realized in this code base are:

Code that is easier to reason about
Type safety at compile time
Ability to use modern JS

For the initial refactor, I would not want to go overboard with type checking but rather:

Port over all of the files from js to ts
Get the build system working
Type check the low hanging fruit

Acceptance Criteria:

Add gulp build process to compile typescript
Add/remove necessary dependencies to package.json
Get the Issues functionality similar to it's current state using Github's GraphQL api

protoEvangelion commented 6 years ago

See foundational alpha changes here: https://github.com/node-gh/gh/compare/191bef0...3daddd0