Getting startedWhy use Encodable?
Contributing guidelinesSetup local developmentFile organizationBuilds, linting, and testingCommittingPublishingAbout
Setup local development
- clone this repo
yarninstall package dependencies and manage the symlinking between packages for you
git clone ...encodable && cd encodableyarn installyarn build
lerna and yarn are used to manage versions and dependencies between packages in this monorepo.
encodable/lerna.jsonpackage.json...packages/package1/package.json...src/test/ # unit teststypes/ # typescript type declarations...lib/ # commonjs outputesm/ # es module output......
Builds, linting, and testing
Each package defines its own build config, linting, and testing. You can have lerna run commands
across all packages using the syntax
yarn test (or
yarn test:watch for watch mode) from
This repository follows
conventional commits guideline for commit
messages and has a
commitlint hook which will require you to have the valid commit message before
committing. You can use
npm run commit to help you create a commit message.
yarn bump-version-auto# or manualyarn bump-version-force# Then follow the prompt to pick new versions for each package