Based off of https://github.com/skonves/esnext-reference.
The easiest way to see it working is:
- Clone this repo
- Install packages:
npm install - Run tests:
npm t
Babel is used to transpile the /src/ and /tests folders into the /.compiled/src and /.compiled/tests folders. Three scripts are used to facilitate the "build" process:
clean- removes all files from the/.compiledfolder.compile- runs babel and outputs files to/.compiledWITHOUT removing previous content.recompile- runscleanand thencompile
If you want to copy additional files that are not copied or transpiled by babel, you should initiate that process in the compile script.
ESLint is setup to lint code in the /src/ and /tests folders and configured in .eslintrc. Two npm scripts are provided:
npm run lint- Lints and returns errorsnpm run lintfix- Lints fixing any auto-fixable errors. Any non-fixable errors are returned.
This project assumes VSCode as the IDE, although all the code and scripts should work in other editors as well. The compile and recompile scripts generate source maps, so that the Launch Program and Launch Tests will break on breakpoints set in the non-transpiled code. The source-map-support package fixes stack traces for files with source maps; however, there are currently issues (either in that package or how it is configured in this project) that prevent breakpoints from being hit when using the async/await pattern for async code.
Mocha is currently used for example tests, although any other framework could be swapped in. Babel runs against the /tests folder and outputs to /.compiled/tests. If you would like to replace mocha, you will need to replace the code in /tests and update the npm test script. You will also need to update the Launch Tests configuration in /.vscode/launch.json if you want to continue supporting test debugging.