rii-mango / NIFTI-Reader-JS

A JavaScript NIfTI file format reader.
MIT License
137 stars 30 forks source link

Draft: Typescript build tooling #26

Closed kmannislands closed 1 year ago

kmannislands commented 1 year ago

This MR sets up for converting the project to typescript by modernizing the build tooling:

It is probably best to create a feature branch to merge these small changes into

kmannislands commented 1 year ago

cc @neurolabusc @cdrake @hanayik I don't seem to have the github permissions to add reviewers

kmannislands commented 1 year ago

Next change, setup mocha to work with typescript: https://github.com/kmannislands/NIFTI-Reader-JS/pull/1/files

hanayik commented 1 year ago

Hi @kmannislands,

Thanks for starting this draft PR.

The NiiVue group discussed nifti-reader-js in our fortnightly meeting yesterday (12th April) and think it would be a good idea to devote some resources to getting the typescript related changes over the finish line.

@cdrake has offered to help out on this from the NiiVue team over the next 2-4 weeks.

During our discussions we highlighted a few things that would be good to outline in this PR comment chain.

  1. update the tooling (already started by @kmannislands, and some esbuild changes merged in from @nellh via #28)
  2. convert from JS to TS (@cdrake and @kmannislands can collaborate as needed)
  3. enable automated build, test, and npm release GitHub Actions for PRs into the main/master branch (see NiiVue repo for examples

It would be great to discuss some of this at the next NiiVue meeting on 26 April 2023. @kmannislands, you are welcome to join if you want (5pm BST). Just let us know!

neurolabusc commented 1 year ago

@kmannislands the AFNI, FSL and MRIcro teams meet fortnightly to coordinate development on NiiVue. Everything we develop uses permissive licenses, so it can be used commercially. Feel free to email me if you would like to be invited and see if there are topics where we can join forces.

hanayik commented 1 year ago

This PR should be closed by #30