-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: initialize pillarbox web suite with plugint scaffolding
Sets up the foundational structure for the Pillarbox Web Suite, providing an npm workspace with customizable plugins and themes for pillarbox-web. Key features include: - Configured `package.json` with necessary dependencies and workspace definitions for plugins. - Included scripts for creating plugins (`create:plugin`) leveraging plop configurations. - Set up ESLint and StyleLint for code quality, and Jest for testing. - Integrated Rollup and Babel for building plugins. - Utilized Husky to enforce linting pre-commits to maintain conventional commits standard. The repository is ready for further development and contribution as outlined in the README, which includes detailed instructions for getting started, contributing, and licensing info.
- Loading branch information
Showing
28 changed files
with
24,340 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"extends": [ | ||
"@commitlint/config-conventional" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
[*] | ||
charset=utf-8 | ||
end_of_line=lf | ||
insert_final_newline=true | ||
indent_style=space | ||
indent_size=2 | ||
|
||
[{*.ts,*.js,*.jsx,*.tsx}] | ||
quote_type=single | ||
|
||
[*.md] | ||
max_line_length=100 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
{ | ||
"env": { | ||
"browser": true, | ||
"es2021": true, | ||
"jest/globals": true | ||
}, | ||
"plugins": [ | ||
"jest" | ||
], | ||
"extends": [ | ||
"eslint:recommended", | ||
"plugin:jest/recommended" | ||
], | ||
"overrides": [ | ||
{ | ||
"files": [ | ||
"plugins/**/test/**" | ||
], | ||
"rules": { | ||
"complexity": "off", | ||
"max-lines-per-function": "off", | ||
"max-statements": "off", | ||
"max-nested-callbacks": "off", | ||
"max-len": "off", | ||
"no-conditional-expect": "off" | ||
} | ||
}, | ||
{ | ||
"files": ["scripts/**/*.js"], | ||
"env": { | ||
"browser": false, | ||
"node": true | ||
}, | ||
"rules": { | ||
"no-console": "off" | ||
} | ||
} | ||
], | ||
"parserOptions": { | ||
"ecmaVersion": "latest", | ||
"sourceType": "module" | ||
}, | ||
"rules": { | ||
"complexity": [ | ||
"error", | ||
{ | ||
"max": 5 | ||
} | ||
], | ||
"function-paren-newline": [ | ||
"error", | ||
"multiline-arguments" | ||
], | ||
"linebreak-style": [ | ||
"error", | ||
"unix" | ||
], | ||
"max-depth": [ | ||
"error", | ||
2 | ||
], | ||
"max-len": [ | ||
"error", | ||
{ | ||
"code": 80, | ||
"ignoreComments": true, | ||
"ignoreStrings": true, | ||
"ignoreTemplateLiterals": true, | ||
"ignoreTrailingComments": true, | ||
"ignoreUrls": true | ||
} | ||
], | ||
"max-lines-per-function": [ | ||
"error", | ||
{ | ||
"max": 35, | ||
"skipComments": true | ||
} | ||
], | ||
"max-nested-callbacks": [ | ||
"error", | ||
3 | ||
], | ||
"max-statements": [ | ||
"error", | ||
10 | ||
], | ||
"newline-after-var": [ | ||
"error", | ||
"always" | ||
], | ||
"no-bitwise": [ | ||
"error", | ||
{ | ||
"int32Hint": true | ||
} | ||
], | ||
"no-cond-assign": [ | ||
"error", | ||
"always" | ||
], | ||
"no-console": [ | ||
"error", | ||
{ | ||
"allow": [ | ||
"warn", | ||
"error" | ||
] | ||
} | ||
], | ||
"no-plusplus": [ | ||
"error", | ||
{ | ||
"allowForLoopAfterthoughts": true | ||
} | ||
], | ||
"padding-line-between-statements": [ | ||
"error", | ||
{ | ||
"blankLine": "always", | ||
"prev": "*", | ||
"next": "return" | ||
} | ||
], | ||
"semi": [ | ||
"error", | ||
"always" | ||
], | ||
"space-before-function-paren": [ | ||
"error", | ||
"never" | ||
] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## Description | ||
|
||
> Please provide a brief summary of the changes made. Please explain why | ||
> this change was necessary. Was there a problem or an issue this change | ||
> will address? What will be improved with this change? | ||
## Changes Made | ||
|
||
> Please detail the modifications made. This could include areas such as | ||
> code, documentation, structure, or formatting. | ||
## Checklist | ||
|
||
- [ ] I have followed the project's style and contribution guidelines. | ||
- [ ] I have performed a self-review of my own changes. | ||
- [ ] I have made corresponding changes to the documentation. | ||
- [ ] I have added tests that prove my fix is effective or that my feature works. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
#!/usr/bin/env sh | ||
. "$(dirname -- "$0")/_/husky.sh" | ||
|
||
npx --no -- commitlint --edit ${1} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
#!/bin/sh | ||
. "$(dirname "$0")/_/husky.sh" | ||
|
||
npm run eslint && npm run stylelint |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"extends": "@parcel/config-default", | ||
"transformers": { | ||
"*.{js,mjs,jsx,cjs,ts,tsx}": [ | ||
"@parcel/transformer-js" | ||
] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
dist | ||
coverage | ||
node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"extends": [ | ||
"stylelint-config-standard-scss", | ||
"stylelint-config-rational-order" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 SRG SSR | ||
|
||
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: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"presets": [ | ||
[ | ||
"@babel/preset-env", | ||
{ | ||
"targets": [ | ||
"last 3 major versions", | ||
"Firefox ESR", | ||
"Chrome >= 53", | ||
"not dead", | ||
"not ie 11", | ||
"not baidu 7", | ||
"not and_qq 11", | ||
"not and_uc 12", | ||
"not op_mini all" | ||
], | ||
"bugfixes": true | ||
} | ||
] | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers | ||
pledge to making participation in our project and our community a harassment-free experience for | ||
everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level | ||
of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic address, without explicit | ||
permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are | ||
expected to take appropriate and fair corrective action in response to any instances of unacceptable | ||
behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, | ||
code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or | ||
to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is | ||
representing the project or its community. Examples of representing a project or community include | ||
using an official project e-mail address, posting via an official social media account, or acting as | ||
an appointed representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting | ||
the project team. The project team will review and investigate all complaints, and will respond in a | ||
way that it deems appropriate to the circumstances. The project team is obligated to maintain | ||
confidentiality with regard to the reporter of an incident. Further details of specific enforcement | ||
policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face | ||
temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available | ||
at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
|
||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Contributing | ||
|
||
Thank you very much for your interest in contributing to our project! As a public service company, | ||
we want to shape a product that better matches our user needs and desires. Ideas or direct | ||
contributions are therefore warmly welcome and will be considered with great care, provided they | ||
fulfill a few requirements listed in this document. Please read it first before you decide to | ||
contribute. | ||
|
||
## Purpose | ||
|
||
Our development team is small, our ability to quickly evaluate a need or a code submission is | ||
therefore critical. Please follow the present contributing guidelines so that we can efficiently | ||
consider your proposal. You should also read or our [code of conduct](CODE_OF_CONDUCT.md), providing | ||
a few guidelines to keep interactions as respectful as possible. | ||
|
||
## Contributions we are looking for | ||
|
||
Any kind of contribution is welcome, as long as it improves the overall quality of our product, for | ||
example: | ||
|
||
* Requests for new features or ideas. | ||
* Bug reports or fixes. | ||
* Documentation improvements. | ||
* Translation improvements. | ||
|
||
Contributions can either take the form of simple issues where you describe the problem you face or | ||
what you would like to see in our products. If you feel up to the challenge, you can even submit | ||
code in the form of pull requests which our team will review. | ||
|
||
## Contributions we are not looking for | ||
|
||
Requests which are too vague or not related to our product will not be taken into account. We also | ||
have no editorial influence, any issue related to the content available on our platform will simply | ||
be closed. | ||
|
||
## Making a contribution | ||
|
||
You can use issues to report bugs, submit ideas or request features. People with a programming | ||
background can also submit changes directly via pull requests. Creating issues or pull requests | ||
requires you to own or [open](https://github.com/join) a GitHub account. | ||
|
||
If you are not sure about the likelihood of a change you propose to be accepted, please open an | ||
issue first. We can discuss it there, especially whether it is compatible with our product or not. | ||
This way you can avoid creating an entire pull request we will never be able to merge. | ||
|
||
Templates are available when you want to contribute: | ||
|
||
* [Issues](https://github.com/SRGSSR/pillarbox-web-demo/issues/new/choose): Please follow our issue | ||
template. You can omit information which does not make sense but, in general, the more details you | ||
can provide, the better. This ensures we can quickly reproduce the problem you are facing, | ||
increasing the likelihood we can fix it. | ||
* [Pull requests](https://github.com/SRGSSR/pillarbox-web-demo/compare): Please follow our code | ||
conventions, test your code well, and write unit tests when this makes sense. We will review your | ||
work and, if successful, merge it back into the main development branch. | ||
|
||
## Code conventions | ||
|
||
We currently have no formal code conventions, but we try to keep our codebase consistent. In | ||
general, having a look at the code itself should be enough for you to discover how you should write | ||
your changes. | ||
|
||
## Code review | ||
|
||
Pull requests, once complete, can be submitted for review by our team. Depending on the complexity | ||
of the involved changes, a few iterations might be needed. Once a pull request has been approved, it | ||
will be rebased, merged back into the development trunk and delivered with the next release. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.