Skip to content

Commit 33366a0

Browse files
thomasjammetthomasjammet
committed
chore: initial commit
0 parents  commit 33366a0

Some content is hidden

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

41 files changed

+39057
-0
lines changed

‎.editorconfig

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
end_of_line = lf
7+
indent_style = space
8+
indent_size = 2
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.eslintrc

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"env": {
3+
"browser": true,
4+
"es2020": true
5+
},
6+
"rules": {
7+
"jsdoc/newline-after-description": "off"
8+
},
9+
"parserOptions": {
10+
"ecmaVersion": 2020
11+
},
12+
"extends": "videojs"
13+
}

‎.github/ISSUE_TEMPLATE/01-bug.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Describe a scenario in which this project behaves unexpectedly
4+
title: ''
5+
labels: bug, needs-triage
6+
assignees: ''
7+
8+
---
9+
10+
[NOTE]: # ( ^^ Provide a general summary of the issue in the title above. ^^ )
11+
12+
## Description
13+
14+
[NOTE]: # ( Describe the problem you're encountering. )
15+
[TIP]: # ( Do NOT give us access or passwords to your Ceeblue account or API keys! )
16+
17+
## Steps to Reproduce
18+
19+
[NOTE]: # ( Please be as specific as possible. )
20+
21+
## Expected Behaviour
22+
23+
[NOTE]: # ( Tell us what you expected to happen. )
24+
25+
## Relevant Logs / Console output
26+
27+
[NOTE]: # ( Please provide specifics of the local error logs, Browser Dev Tools console, etc. if appropriate and possible. )
28+
29+
## Your Environment
30+
31+
[TIP]: # ( Include as many relevant details about your environment as possible. )
32+
33+
* Ceeblue videojs-plugins version used:
34+
* Browser name and version:
35+
* Operating System and version:
36+
37+
## Additional context
38+
39+
[TIP]: # ( Add any other context about the problem here. )

‎.github/ISSUE_TEMPLATE/02-enhancement.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Enhancement request
3+
about: Suggest an idea for a future version of this project
4+
title: ''
5+
labels: enhancement, needs-triage
6+
assignees: ''
7+
8+
---
9+
10+
[NOTE]: # ( ^^ Provide a general summary of the request in the title above. ^^ )
11+
12+
## Summary
13+
14+
[NOTE]: # ( Provide a brief overview of what the new feature is all about. )
15+
16+
## Desired Behaviour
17+
18+
[NOTE]: # ( Tell us how the new feature should work. Be specific. )
19+
[TIP]: # ( Do NOT give us access or passwords to your Ceeblue account or API keys! )
20+
21+
## Possible Solution
22+
23+
[NOTE]: # ( Not required. Suggest how to implement the addition or change. )
24+
25+
## Additional context
26+
27+
[TIP]: # ( Why does this feature matter to you? What unique circumstances do you have? )

‎.github/ISSUE_TEMPLATE/config.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discussions
4+
url: https://github.com/CeeblueTV/webrtc-client/discussions
5+
about: Use this for general questions and discussions
6+
- name: Trial Account Request
7+
url: https://ceeblue.net/free-trial/
8+
about: Request your 14-day trial account here
9+
- name: Ceeblue Sales Contact
10+
url: https://ceeblue.net/contact-us/
11+
about: Submit your business-related questions here

‎.github/workflows/lint.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Lint
2+
on:
3+
push:
4+
branches:
5+
- main
6+
- dev
7+
pull_request:
8+
types:
9+
- opened
10+
- reopened
11+
- synchronize
12+
permissions:
13+
contents: read
14+
pull-requests: read
15+
jobs:
16+
lint:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
20+
- uses: wagoid/commitlint-github-action@v5
21+
- uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
22+
with:
23+
cache: npm
24+
node-version: 18
25+
- run: npm ci
26+
- run: npm run lint

‎.github/workflows/release.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Release
2+
on:
3+
workflow_run:
4+
workflows: [lint]
5+
types: [completed]
6+
branches: [main]
7+
workflow_dispatch:
8+
branches: [main]
9+
permissions:
10+
contents: read # for checkout
11+
jobs:
12+
release:
13+
permissions:
14+
contents: write # to be able to publish a github release
15+
issues: write # to be able to comment on released issues
16+
pull-requests: write # to be able to comment on released pull requests
17+
id-token: write # to enable use of OIDC for npm provenance
18+
name: release
19+
runs-on: ubuntu-latest
20+
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
21+
steps:
22+
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
23+
with:
24+
fetch-depth: 0
25+
- uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
26+
with:
27+
cache: npm
28+
node-version: lts/*
29+
- run: npm ci
30+
- run: npx semantic-release
31+
env:
32+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
34+
GIT_AUTHOR_NAME: ${{ vars.RELEASE_BOT_GIT_AUTHOR_NAME }}
35+
GIT_AUTHOR_EMAIL: ${{ vars.RELEASE_BOT_GIT_AUTHOR_EMAIL }}
36+
GIT_COMMITTER_NAME: ${{ vars.RELEASE_BOT_GIT_COMMITTER_NAME }}
37+
GIT_COMMITTER_EMAIL: ${{ vars.RELEASE_BOT_GIT_COMMITTER_EMAIL }}

‎.gitignore

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# OS
2+
Thumbs.db
3+
ehthumbs.db
4+
Desktop.ini
5+
.DS_Store
6+
._*
7+
8+
# Editors
9+
*~
10+
*.swp
11+
*.tmproj
12+
*.tmproject
13+
*.sublime-*
14+
.idea/
15+
.project/
16+
.settings/
17+
.vscode/
18+
19+
# Logs
20+
logs
21+
*.log
22+
npm-debug.log*
23+
24+
# Dependency directories
25+
bower_components/
26+
node_modules/
27+
28+
# Build-related directories
29+
dist/
30+
es/
31+
cjs/
32+
docs/api/
33+
test/dist/
34+
.eslintcache
35+
.yo-rc.json

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npx lint-staged

‎.husky/prepare-commit-msg

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
exec < /dev/tty && git cz --hook || true

‎.lintstagedrc.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"*.{js,jsx,ts,tsx}": ["eslint"]
3+
}

‎.npmignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Intentionally left blank, so that npm does not ignore anything by default,
2+
# but relies on the package.json "files" array to explicitly define what ends
3+
# up in the package.

‎.releaserc.json

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"plugins": [
3+
"@semantic-release/commit-analyzer",
4+
"@semantic-release/release-notes-generator",
5+
[
6+
"@semantic-release/exec",
7+
{
8+
"prepareCmd": "version=${nextRelease.version} npm run build"
9+
}
10+
],
11+
"@semantic-release/npm",
12+
"@semantic-release/github",
13+
[
14+
"@semantic-release/git",
15+
{
16+
"assets": ["package.json", "package-lock.json"],
17+
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
18+
}
19+
]
20+
],
21+
"branches": ["main"],
22+
"dryRun": false,
23+
"debug": false
24+
}

‎CHANGELOG.md

Whitespace-only changes.

‎CONTRIBUTING.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# CONTRIBUTING
2+
3+
Your contributions to this project are highly appreciated. Please adhere to this guide to streamline the process for everyone.
4+
5+
By contributing code to this project, you agree to license your contribution under the [GNU Affero General Public License](/LICENSE).
6+
7+
## Code Formatting and Linting Process
8+
9+
In our development workflow, we prioritize code quality through the use of the highly opinionated code formatter, Prettier. We have automated the formatting and linting processes on every staged commit to ensure that our codebase adheres to consistent standards.
10+
11+
Feel free to reach out if you have any questions or need further clarification on our code formatting and linting practices.
12+
13+
## Issues
14+
15+
Use issues exclusively for bug reporting and proposing enhancements. For questions, ideas, or other matters, visit our [discussions page](https://github.com/ceebluetv/webrtc-client/discussions).
16+
17+
When reporting bugs, describe the problem clearly and provide all relevant information to replicate it. Describe both the expected and actual behavior as detailed as possible.
18+
19+
🐛 **[File a bug report](https://github.com/CeeblueTV/videojs-plugins/issues/new?assignees=&labels=&template=01-bug.md&title=)**
20+
✨ **[Propose enhancement](https://github.com/CeeblueTV/videojs-plugins/issues/new?assignees=&labels=&template=02-enhancement.md&title=)**
21+
22+
## Pull Requests
23+
24+
To contribute fork the project, then submit a Pull-Request with your changes, targeting the **dev** branch.
25+
26+
## Commit Formatting
27+
28+
We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for continuous deployment, versioning, and changelog creation.
29+
30+
Once `npm install` is executed, git hooks aid in the committing process. Should the hooks not install automatically, run `npm rebuild husky`. Use `git commit` to commit your changes; [Commitizen](https://github.com/commitizen/cz-cli) assists in crafting a structured commit message. To complete the commit, close the text editor that appears (typically with ctrl + x), and then `git push` as usual.
31+
32+
## Getting Started
33+
34+
Make sure you have Node.js 8 or higher and npm installed.
35+
36+
1. Fork this repository and clone your fork
37+
1. Install dependencies: `npm install`
38+
1. Run a development server: `npm start`
39+
40+
### Running Tests
41+
42+
Testing is a crucial part of any software project. For all but the most trivial changes (typos, etc) test cases are expected. Tests are run in actual browsers using [Karma][karma].
43+
44+
- In all available and supported browsers: `npm test`
45+
- In a specific browser: `npm run test:chrome`, `npm run test:firefox`, etc.
46+
- While development server is running (`npm start`), navigate to [`http://localhost:9999/test/`][local]
47+
48+
## [Developer's Certificate of Origin 1.1](https://github.com/nodejs/node/blob/main/CONTRIBUTING.md#developers-certificate-of-origin-11)
49+
50+
By making a contribution to this project, I certify that:
51+
52+
* (a) The contribution was created in whole or in part by me and I
53+
have the right to submit it under the open source license
54+
indicated in the file; or
55+
56+
* (b) The contribution is based upon previous work that, to the best
57+
of my knowledge, is covered under an appropriate open source
58+
license and I have the right under that license to submit that
59+
work with modifications, whether created in whole or in part
60+
by me, under the same open source license (unless I am
61+
permitted to submit under a different license), as indicated
62+
in the file; or
63+
64+
* (c) The contribution was provided directly to me by some other
65+
person who certified (a), (b) or (c) and I have not modified
66+
it.
67+
68+
* (d) I understand and agree that this project and the contribution
69+
are public and that a record of the contribution (including all
70+
personal information I submit with it, including my sign-off) is
71+
maintained indefinitely and may be redistributed consistent with
72+
this project or the open source license(s) involved.
73+
74+
[karma]: http://karma-runner.github.io/
75+
[local]: http://localhost:9999/test/
76+
[conventions]: https://github.com/videojs/generator-videojs-plugins/blob/master/docs/conventions.md

0 commit comments

Comments
 (0)