Feat: Upgrade to TS ➕ 🦖

Acknowledgement 🎉

First of all, thanks for being here. This project has always been a close one to my heart. Many thanks in advance for any contributions that are made, whether they’re issues, docs, code, or just fixing typos.

Description 🚧

This can be the placeholder ticket for the migration. How I’m understanding this now is the first step being changing the .js extension to .ts. The NPM script for the TypeScript compiler was already setup on the branch typescript-migration which will serve as our main feature branch we can send PRs to.

Developing 💻

Since we’ll have dual compilers until we finish, development scripts will probably include two scripts being run in two separate sessions: npm run watch and npm run tsc -- --watch.

Testing 🐛

After you’re set up, you should be able to run npm start to test your local build. If you have a global installation of check-it-out that you want to use the local build for, you can run npm link (I believe) so your global cio binary should link to your local output files in this repo

Contributing 🧗🏼

Find the project board and pick a ticket. If there’s more work that has been overlooked, or we need to break any files up into smaller tickets, lets create them accordingly.

[drewbrokke]

@jwu910 absolutely!

I actually played around with this idea a bit and have a suggestion: disable ESLint initially and just focus on getting the TS conversion done. Having two separate compilers bark at you can be a lot during the transition.

Once the TS side of things is up to snuff, re-introduce ES as if for the first time, since you’ll have to change the config anyways to make it work with TS.

All this is ultimately up to you of course, this is just how I would approach it. Thoughts?

[jwu910]

@drewbrokke sweet that sounds like a plan. I’ll put up an issue later for the Eslint removal and when we turn it back on later anyways, we can use that opportunity to upgrade the packages