To get started, take a look at the documentation listed below:
- docs
NODE_ENV
: Environment name. Options are: dev, test and prod. Default: dev- Default Value: "undefined"
yarn test
yarn build
: Assemblessrc
code into a single, minified JS module with type definitions. Exportsbuild
scripts into a build folder.yarn bundle
: Runs WebPack on thesrc
code.yarn clean
: Purges all temporary foldersyarn count
: Counts lines of source code.yarn docs:all
: Standardizes markdown and generates the API metadata.yarn docs:api
: Creates aproject-api
Markdown in docs and anindex.d.ts
file in dist.yarn docs:publish
: Generates end-to-end documentation for the entire project and publishes it to thegh-pages
branch.yarn docs:standardize
: Creates or updates a new readme with a standard set of readme sections, including a toc, yarn script documention, links to repo documentation files and an LUDDITES licenseyarn generate:exports
: Generates index.ts files for all exports recursively in the 'src' folderyarn lint
: Lints the codebase and the documentationyarn lint:fix
: Lints the codebase and fixes auto-correctable errors. Runs prettier on the code.yarn sortJson
: Performs aesthetic operations to make the project files easier to navigate and readyarn test
: Builds and then runs tests and calculates test coverage. This should be run by CI.yarn test:coverage
: Runs tests, calculates test coverage in debug mode.yarn test:debug
: Runs tests with the debugger attached.yarn test:only
: Runs tests and calculates test coverage. This should be run for local development.