README.md

TonJS

The node.js web framework build for ton of request.

Usage

# do something

Contributing Guide

Pull Request Guidelines

• Must Follow the GitHub Flow.

• Checkout a topic branch from a base branch, e.g. master, and merge back against that branch.

• If adding a new feature:

  • Add accompanying test case. Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.

• If fixing bug:

  • If you are resolving a special issue, add (fix #xxxx[,#xxxx]) (#xxxx is the issue id) in your PR title for a better release log, e.g. update entities encoding/decoding (fix #3899).
  • Provide a detailed description of the bug in the PR. Live demo preferred.
  • Add appropriate test coverage if applicable. You can check the coverage of your code addition by running yarn test --coverage.

• It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.

• Make sure tests pass!

• Commit messages must follow the commit message convention so that changelogs can be automatically generated. Commit messages are automatically validated before commit (by invoking Git Hooks via husky).

• No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with ESLint and Prettier on commit (by invoking Git Hooks via husky).

• Beware of the git GUI, make sure the husky working fine before you commit.

  • Sourcetree app on macOS, must open via command line.

  open /Applications/Sourcetree.app
  # or
  stree folder-name

Prior Knowledge

• lerna (monorepo)

  • https://github.com/lerna/lerna/blob/master/README.md
  • https://zhuanlan.zhihu.com/p/71385053

• yarn workspace

  • https://classic.yarnpkg.com/en/docs/workspaces
  • https://classic.yarnpkg.com/en/docs/cli/workspace
  • https://classic.yarnpkg.com/blog/2018/02/15/nohoist

Common Scripts

project

# create the new project
yarn lerna create project-name

package

# install all packages
yarn install

# add the package in whole workspace (root)
yarn add package-name --ignore-workspace-root-check
# alternative: yarn add package-name -W

# add the package in special workspace
yarn workspace workspace-name add package-name

# add the package from another workspace
yarn workspace workspace-a add workspace-b@version
# example: yarn workspace @tonjs/bin add @tonjs/ton@0.0.0

dev

# build the packages first
yarn build

# dev any ts file
yarn dev file-name.ts

format

# format whole workspace (in root)
yarn format

lint

# lint the whole workspace (in root)
yarn lint --fix

test

# test the code
yarn test # --coverage --watchAll

clean

# clean the project
yarn clean

build

# build the any project in whole workspace (in root)
yarn build # or
# yarn workspaces run build

release

# tag a version
yarn lerna version --message "chore(release): publish" --create-release github

# publish
yarn lerna publish from-package