Flattenizer
Functions to flatten and unflatten nested JavaScript objects into a single level. Keys are enumerated if they collide.Commands Configuration Continuous Integration
API
The code is documented usingtsdoc
. The tests are helpful to read as well. There are also docs generated using api-extractor
in the docs folder.Developing
Commands
To run:npm start
This builds to
/dist
and runs the project in watch mode so any edits you save inside src
causes a rebuild to /dist
.To do a one-off build, use
npm run build
.To run tests, use
npm test
.Configuration
Code quality is set up for you withprettier
, husky
, and lint-staged
. Adjust the respective fields in package.json
accordingly.Jest
Jest tests are set up to run withnpm test
.Bundle Analysis
size-limit
is set up to calculate the real cost of your library with npm run size
and visualize the bundle with npm run analyze
.Continuous Integration
GitHub Actions
Two actions are added by default:main
which installs deps w/ cache, lints, tests, checks size and builds on all pushes against a Node and OS matrix