feat: add skip button plugin #2

jboix · 2024-04-25T08:45:22Z

Description

Introduces the skip button plugin, providing a convenient option to skip segments of a video. Key features include:

Detection of skippable segments, such as opening intros and closing credits, through the srgssr/interval event from the Pillarbox player.
Multilingual support with translations in French, Italian, English, German, and Romansh.

Example of integration

import Pillarbox from '@srgssr/pillarbox-web';
import '@srgssr/skip-button-plugin';

const player = new Pillarbox('my-player', { plugins: { 'skip-button-plugin': true } });
player.src({
  src: 'urn:swi:video:48115940',
  type: 'srgssr/urn'
});

Screenshot

Changes Made

Migrated test framework from jest to vitest:
- Adjusted plugin template with a default vitest configuration.
- Adjusted eslint configuration with vitest plugins.
Added a new prompt in the create script asking for localisation, this prompt will automatically generate the folder structure and the bindings if the users wishes to include localisation to their plugin.
Added a new prompt in the create script to enable users to specify whether they want to generate a new component, plugin, or button.

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.

github-actions · 2024-04-25T09:05:51Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	100%	93 / 93
🔵	Statements	100%	93 / 93
🔵	Functions	85.71%	6 / 7
🔵	Branches	88.88%	8 / 9

File Coverage

File	Stmts	% Branch	% Funcs	% Lines
Changed Files
plugins/skip-button/src/skip-button.js	100%	88.88%	85.71%	100%
plugins/skip-button/src/lang/index.js	100%	100%	100%	100%

Generated in workflow #17

Introduces the skip button plugin, providing a convenient option to skip segments of a video. Key features include: - Detection of skippable segments, such as opening intros and closing credits, through the `srgssr/interval` event from the Pillarbox player. - Multilingual support with translations in French, Italian, English, German, and Romansh. Example of integration: ```javascript import Pillarbox from '@srgssr/pillarbox-web'; import '@srgssr/skip-button-plugin'; const player = new Pillarbox('my-player', { plugins: { 'skip-button-plugin': true } }); player.src({ src: 'urn:swi:video:48115940', type: 'srgssr/urn' }); ```

Introduces vitest as a testing framework. Vitest integrates with es modules by default resulting in a better integration. Changes made: - Adjusted plugin template with a default vitest configuration. - Adjustes eslint configuration with vitest plugins.

github-actions · 2024-04-25T11:44:07Z

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-04-30 09:38 UTC

plugins/skip-button-plugin/README.md

plugins/skip-button-plugin/src/skip-button-plugin.js

plugins/skip-button-plugin/src/skip-button.js

plugins/skip-button-plugin/index.html

plugins/skip-button-plugin/package.json

plugins/skip-button-plugin/src/skip-button-plugin.js

- Ensures that the skip button component functions correctly in isolation. - Moved class building to `buildCssClass` function. - Adjusted style and removed unused inline in `skip-button-plugin.js` file. - Fixed the plugin configuration example in the README. - Fixed the plugin configuration example in the README template.

- Adds dedicated `json` files for each localization. - A new prompt has been added to the `create:plugin` script asking for localization, this prompt will automatically generate the folder structure and the bindings if the users wishes to include localization to their plugin.

Adds dispose logic to remove the event listener from the player.

plugins/skip-button/README.md

plugins/skip-button/index.html

- Added a new prompt in the `create` script to enable users to specify whether they want to generate a new component, plugin, or button. - Adapted the existing templates to correctly produce the type of element selected by the user. - Migrated the functionality of the skip-button-plugin into a simpler component format.

amtins

Amazing!

jboix requested a review from amtins April 25, 2024 08:45

jboix self-assigned this Apr 25, 2024

jboix force-pushed the feat/skip-button-plugin branch from a035ba6 to 3739222 Compare April 25, 2024 09:05

SRGSSR deleted a comment from github-actions bot Apr 25, 2024

jboix added 2 commits April 25, 2024 13:43

refactor: migrate jest to vitest

9964894

Introduces vitest as a testing framework. Vitest integrates with es modules by default resulting in a better integration. Changes made: - Adjusted plugin template with a default vitest configuration. - Adjustes eslint configuration with vitest plugins.

jboix force-pushed the feat/skip-button-plugin branch from 3739222 to 3ffcba1 Compare April 25, 2024 11:43

jboix changed the title ~~Feat/skip button plugin~~ feat: add skip button plugin Apr 25, 2024