Skip to content

Commit 9d389aa

Browse files
RomakitaRomakita
committed
chore: move on monorepo
1 parent c9654e7 commit 9d389aa

File tree

407 files changed

+9040
-6124
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

407 files changed

+9040
-6124
lines changed

Diff for: ‎.eslintignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
**/node_modules

Diff for: ‎.eslintrc

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"extends": [
3+
"plugin:prettier/recommended"
4+
],
5+
"parserOptions": {
6+
"ecmaVersion": 2018,
7+
"sourceType": "module",
8+
"project": "./tsconfig.json"
9+
},
10+
"env": {
11+
"node": true,
12+
"es6": true
13+
},
14+
"rules": {
15+
"no-case-declarations": "off",
16+
"no-empty": "off",
17+
"prefer-const": "off",
18+
"no-fallthrough": "off"
19+
},
20+
"ignorePatterns": []
21+
}

Diff for: ‎.github/workflows/build.yml

+6
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,9 @@ jobs:
5151
GH_TOKEN: ${{ secrets.GH_TOKEN }}
5252
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
5353
run: yarn release
54+
- uses: actions/upload-artifact@v2
55+
with:
56+
name: packages
57+
path: |
58+
package.json
59+
packages/*/package.json

Diff for: ‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,5 @@ typings/
3737
.nyc_output
3838

3939
.npmrc
40-
.vscode
40+
.vscode
41+
dist

Diff for: ‎.lintstagedrc

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"packages/*/src/**/*.js": [
3+
"prettier --write",
4+
"eslint --fix",
5+
"git add"
6+
]
7+
}

Diff for: ‎.mocharc.js

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
process.env.NODE_ENV = "test";
2+
3+
module.exports = {
4+
recursive: true,
5+
reporter: "dot",
6+
spec: [
7+
"packages/**/*.spec.js"
8+
]
9+
};

Diff for: ‎.nycrc

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"include": [
3-
"src/**/*.js"
3+
"packages/*/src/**/*.js"
44
],
55
"exclude": [
66
"**/index.js"
@@ -16,6 +16,5 @@
1616
"lines": 0,
1717
"functions": 0,
1818
"branches": 0,
19-
"statements": 0,
20-
"all": true
19+
"statements": 0
2120
}

Diff for: ‎.prettierignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
dist
2+
docs
3+
node_modules
4+
*-lock.json
5+
*.lock

Diff for: ‎.prettierrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"printWidth": 140,
3+
"bracketSpacing": false,
4+
"trailingComma": "none",
5+
"arrowParens": "always"
6+
}

Diff for: ‎CODE_OF_CONDUCT.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
In the interest of fostering an open and welcoming environment, we as
4+
contributors and maintainers pledge to making participation in our
5+
project and our community a harassment-free experience for everyone,
6+
regardless of age, body size, disability, ethnicity, gender identity
7+
and expression, level of experience, nationality, personal appearance,
8+
race, religion, or sexual identity and orientation.
9+
10+
Examples of behavior that contributes to creating a positive
11+
environment include:
12+
13+
* Using welcoming and inclusive language
14+
* Being respectful of differing viewpoints and experiences
15+
* Gracefully accepting constructive criticism
16+
* Focusing on what is best for the community
17+
* Showing empathy towards other community members
18+
19+
Examples of unacceptable behavior by participants include:
20+
21+
* The use of sexualized language or imagery and unwelcome sexual
22+
attention or advances
23+
* Trolling, insulting/derogatory comments, and personal or political
24+
attacks
25+
* Public or private harassment
26+
* Publishing others' private information, such as a physical or
27+
electronic address, without explicit permission
28+
* Other conduct which could reasonably be considered inappropriate
29+
in a professional setting
30+
31+
Project maintainers are responsible for clarifying the standards of
32+
acceptable behavior and are expected to take appropriate and fair
33+
corrective action in response to any instances of unacceptable
34+
behavior.
35+
36+
Project maintainers have the right and responsibility to remove, edit,
37+
or reject comments, commits, code, wiki edits, issues, and other
38+
contributions that are not aligned to this Code of Conduct, or to ban
39+
temporarily or permanently any contributor for other behaviors that
40+
they deem inappropriate, threatening, offensive, or harmful.
41+
42+
This Code of Conduct applies both within project spaces and in public
43+
spaces when an individual is representing the project or its
44+
community. Examples of representing a project or community include
45+
using an official project e-mail address, posting via an official
46+
social media account, or acting as an appointed representative at an
47+
online or offline event. Representation of a project may be further
48+
defined and clarified by project maintainers.
49+
50+
Instances of abusive, harassing, or otherwise unacceptable behavior
51+
may be reported by contacting the project team
52+
at https://gitter.im/Tsed-io/community. All complaints will be
53+
reviewed and investigated and will result in a response that is deemed
54+
necessary and appropriate to the circumstances. The project team is
55+
obligated to maintain confidentiality with regard to the reporter of
56+
an incident. Further details of specific enforcement policies may be
57+
posted separately.
58+
59+
Project maintainers who do not follow or enforce the Code of Conduct
60+
in good faith may face temporary or permanent repercussions as
61+
determined by other members of the project's leadership.
62+
63+
This Code of Conduct is adapted from
64+
the [Contributor Covenant][homepage], version 1.4, available
65+
at [http://contributor-covenant.org/version/1/4][version]
66+
67+
[homepage]: http://contributor-covenant.org
68+
[version]: http://contributor-covenant.org/version/1/4/
69+
[email]: mailto:[email protected]

Diff for: ‎CONTRIBUTING.md

+162
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# Contributing
2+
## Introduction
3+
4+
First, thank you for considering contributing to Ts-doc! It is people like you that make the open source community such a great community! 😊
5+
6+
We welcome any type of contribution, not just code. You can help with:
7+
8+
- QA: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
9+
- Marketing: writing blog posts, how to's, printing stickers, ...
10+
- Community: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
11+
- Code: take a look at the [open issues](https://github.com/TypedProject/tsed/issues). Even if you can't write code, commenting on them and showing that you care about a given issue matters. It helps us triage them.
12+
- Money: we welcome financial contributions in full transparency on our [open collective](https://opencollective.com/tsed).
13+
14+
## Your First Contribution
15+
16+
Working on your first Pull Request? You can learn how from this free series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
17+
18+
## Submitting code
19+
20+
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
21+
Code review process
22+
23+
The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?
24+
25+
---
26+
### WARNING
27+
28+
Ts-doc project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) as format commit message.
29+
30+
Release note and tagging version are based on the message commits.
31+
If you don't follow the format, our CI won't be able to increment the version correctly and your feature won't be released on NPM.
32+
33+
To write your commit message, see [convention page here](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)
34+
---
35+
36+
## Financial contributions
37+
38+
We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our [open collective](https://opencollective.com/tsed) by the core contributors, and the person who filed the expense will be reimbursed.
39+
40+
## Questions
41+
42+
If you have any questions, create an [issue](https://github.com/TypedProject/tsed/issues) (protip: do a quick search first to see if someone else didn't ask the same question before!). You can also reach us at https://gitter.im/Tsed-io/community.
43+
44+
## How to work on Ts-doc
45+
### Setup
46+
47+
Clone your fork of the repository
48+
49+
```bash
50+
$ git clone https://github.com/YOUR_USERNAME/tsed.git
51+
```
52+
53+
Install npm dependencies with yarn (not with NPM!):
54+
```bash
55+
yarn
56+
```
57+
> After installing dependencies, yarn/npm run the `postinstall` hook and mounted all packages with `npm link` (e.g. `yarn run repo:bootstrap`).
58+
59+
Compile TypeScript:
60+
61+
```bash
62+
yarn build
63+
// or
64+
npm run build
65+
```
66+
67+
### Test
68+
69+
```bash
70+
yarn test
71+
# or
72+
npm run test
73+
```
74+
75+
### Gflow (optional)
76+
77+
[Gflow](https://www.npmjs.com/package/gflow) is a command line tool to help developers with the Git process used in Ts-doc.
78+
79+
Gflow helps you create a branch from master, rebase and run the tests before pushing your branch on your remote repository.
80+
81+
```bash
82+
npm install -g gflow
83+
```
84+
85+
### Start a feature branch
86+
87+
```bash
88+
git fetch
89+
git branch --no-track -b feat-branch-name origin/master # !IMPORTANT
90+
yarn
91+
92+
## OR
93+
gflow new feat name_of_feat
94+
```
95+
96+
### Commit & Push a feature
97+
98+
This command rebases your branch feature from the master branch, runs the test, and pushes your branch.
99+
100+
```bash
101+
git commit -m "feat(domain): Your message"
102+
```
103+
104+
Then:
105+
```bash
106+
npm run test
107+
git fetch
108+
git rebase origin/master
109+
git push -f
110+
111+
# OR using gflow (run fetch, rebase and push for you)
112+
gflow push
113+
```
114+
115+
When your feature is ready to review, you can open a PR on Ts-doc github.
116+
117+
### Submitting your PR
118+
119+
Create the PR on the master branch. A valid PR must follows these points:
120+
121+
- Unit test is correctly implemented and cover the new scenario.
122+
- If the code introduce new feature, please add documentation in the `/docs` or describe the feature in the PR description.
123+
- The commit message follows the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) format.
124+
125+
The review is always takes priority over other tasks. We can validate the PR very quickly if everything is clear and it's aligned with the evolution/vision of the framework.
126+
127+
### Write documentation
128+
129+
Ts-doc use vuepress to convert markdown to web application. In addition, all documentation in your code will be used to generate
130+
the API documentation. To run the website on your local, run this command:
131+
132+
```sh
133+
yarn vuepress:serve
134+
```
135+
136+
### Guidelines
137+
138+
- Ts-doc follows the git flow to generate a release note. To write your commit message see [convention page](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit).
139+
- Please try to combine multiple commits before pushing.
140+
- Please use TDD when fixing bugs. This means that you should write a unit test that fails because it reproduces the issue, then fix the issue and finally run the test to ensure that the issue has been resolved. This helps us prevent fixed bugs from happening again in the future.
141+
- Please keep the test coverage. Write additional unit tests if necessary.
142+
- Please create an issue before sending a PR if it is going to change the public interface of Ts-doc or includes significant architecture changes.
143+
- Feel free to ask for help from other members of the Ts-doc team.
144+
145+
## Credits
146+
### Contributors
147+
148+
<a href="https://github.com/TypedProject/ts-express-decorators/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
149+
150+
151+
### Backers
152+
153+
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
154+
155+
<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/backers.svg?width=890"></a>
156+
157+
158+
### Sponsors
159+
160+
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
161+
162+
<!-- This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template -->

Diff for: ‎LICENSE

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2020 Romain Lenzotti
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Diff for: ‎components/symbol-params/symbol-params.js

-37
This file was deleted.

0 commit comments

Comments
 (0)