Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alljointtw/alljointtool
The Next Generation AllJointJS
https://github.com/alljointtw/alljointtool
Last synced: about 1 month ago
JSON representation
The Next Generation AllJointJS
- Host: GitHub
- URL: https://github.com/alljointtw/alljointtool
- Owner: AllJointTW
- License: gpl-3.0
- Created: 2020-02-15T14:16:24.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T06:58:51.000Z (9 months ago)
- Last Synced: 2024-11-18T10:56:08.979Z (about 1 month ago)
- Language: JavaScript
- Size: 8.62 MB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# AllJointTool
> The Tool Sets Be Used For AllJointNext
## Document
- [ESlintConfig](https://github.com/AllJointTW/AllJointTool/tree/master/packages/ESLintConfig): The ESLint Config Used For AllJointNext
- [ESlintConfigLite](https://github.com/AllJointTW/AllJointTool/tree/master/packages/ESLintConfigLite): The ESLint Config Used For AllJointNext (without Jest)
- [ESLintConfigTypeScript](https://github.com/AllJointTW/AllJointTool/tree/master/packages/ESLintConfigTypeScript) The ESLint Config Be Used For AllJointNext
- [ESLintConfigVue](https://github.com/AllJointTW/AllJointTool/tree/master/packages/ESLintConfigVue) The ESLint Config Vue 2 Be Used For AllJointNext
- [ESLintConfigVue3](https://github.com/AllJointTW/AllJointTool/tree/master/packages/ESLintConfigVue3) The ESLint Config Vue 3 Be Used For AllJointNext
- [TSConfig](https://github.com/AllJointTW/AllJointTool/tree/master/packages/TSConfig) The TS Config Be Used For AllJointNext
- [SelfHostedNgrok](https://github.com/AllJointTW/AllJointTool/tree/master/packages/SelfHostedNgrok) The Self Hosted Ngrok Be Used For AllJointNext
## Contributing Guide
### Pull Request Guidelines
- Must Follow the [GitHub Flow](https://guides.github.com/introduction/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](https://www.conventionalcommits.org/en/v1.0.0/) 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.
```sh
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**
```sh
# create the new project
yarn lerna create project-name
```
**package**
```sh
# 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
```
**format**
```sh
yarn format
```
**lint**
```sh
yarn lint # --fix
```
**release**
```sh
# tag a version
yarn lerna version --message "chore(release): publish" --create-release github
# publish
yarn lerna publish from-package
```