Merge pull request #35 from taj54/main

chore: improve CI/CD and add linting

Author: taj54

.github/workflows/release.yml

@@ -36,4 +36,3 @@ jobs:
         run: pnpm publish --access public --no-git-checks
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-

.github/workflows/tag-after-merge.yml

@@ -67,7 +67,7 @@ jobs:
         run: |
           # Match lines starting with "## vX.Y.Z " until the next "## "
           awk "/^## v${{ env.version }}[[:space:]]/{flag=1; next} /^## /{flag=0} flag" CHANGELOG.md > RELEASE_NOTES.md
-        
+
           echo "notes<<EOF" >> $GITHUB_ENV
           if [ "${{ env.release_type }}" = "major" ]; then
             echo "## 🚀 Major Release" >> $GITHUB_ENV
@@ -83,7 +83,7 @@ jobs:
         uses: softprops/action-gh-release@v2
         with:
           tag_name: v${{ env.version }}
-          name: "Release v${{ env.version }}"
+          name: 'Release v${{ env.version }}'
           body: ${{ env.notes }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/version-bump.yaml renamed to .github/workflows/version-bump.yml

@@ -17,8 +17,6 @@ on:
           - minor
           - major
 
-
-
 jobs:
   bump:
     runs-on: ubuntu-latest

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "ignores": ["node_modules", "dist"]
+}

CHANGELOG.md

@@ -3,7 +3,9 @@
 All notable changes to this project will be documented in this file.
 
 ## [0.1.0] - 2025-08-19
+
 ### Added
+
 - new tag release action added
 
 ## [0.0.2] - 2025-08-17
@@ -25,4 +27,4 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
-- Converted the project from a Svelte component to a Svelte action.
+- Converted the project from a Svelte component to a Svelte action.

CODE_OF_CONDUCT.md

@@ -17,24 +17,24 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-*   Demonstrating empathy and kindness toward other people
-*   Being respectful of differing opinions, viewpoints, and experiences
-*   Giving and gracefully accepting constructive feedback
-*   Accepting responsibility and apologizing to those affected by our mistakes,
-    and learning from the experience
-*   Focusing on what is best not just for us as individuals, but for the
-    overall community
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
 
 Examples of unacceptable behavior include:
 
-*   The use of sexualized language or imagery, and sexual attention or
-    advances of any kind
-*   Trolling, insulting or derogatory comments, and personal or political attacks
-*   Public or private harassment
-*   Publishing others' private information, such as a physical or email
-    address, without their explicit permission
-*   Other conduct which could reasonably be considered inappropriate in a
-    professional setting
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Enforcement Responsibilities
 

CONTRIBUTING.md

@@ -22,7 +22,7 @@ Before contributing, please take a moment to review this document. It outlines t
 
 ## Code of Conduct
 
-This project adheres to the [CODE\_OF\_CONDUCT.md](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [insert contact email or method here, e.g., `support@example.com`].
+This project adheres to the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [insert contact email or method here, e.g., `support@example.com`].
 
 ## How Can I Contribute?
 
@@ -100,4 +100,3 @@ We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0
 ## License
 
 By contributing to `@interactive-video-labs/svelte`, you agree that your contributions will be licensed under its MIT License. See the [LICENSE](LICENSE) file for details.
-

DEVELOPER.md

@@ -7,6 +7,7 @@ This document provides essential information for developers looking to contribut
 To get started with local development, follow these steps:
 
 1.  **Clone the repository:**
+
     ```bash
     git clone https://github.com/interactive-video-labs/interactive-video-svelte-wrapper.git
     cd interactive-video-svelte-wrapper
@@ -26,35 +27,35 @@ To get started with local development, follow these steps:
 
 Here are the common development scripts available:
 
--   **`pnpm build`**: Compiles the TypeScript + Svelte source code into JavaScript (ESM and CommonJS formats) and generates declaration files (`.d.ts`). This command is run before publishing.
+- **`pnpm build`**: Compiles the TypeScript + Svelte source code into JavaScript (ESM and CommonJS formats) and generates declaration files (`.d.ts`). This command is run before publishing.
 
-    ```bash
-    pnpm build
-    ```
+  ```bash
+  pnpm build
+  ```
 
--   **`pnpm dev`**: Starts the TypeScript compiler and Svelte build in watch mode, recompiling files on changes. Useful for active development.
+- **`pnpm dev`**: Starts the TypeScript compiler and Svelte build in watch mode, recompiling files on changes. Useful for active development.
 
-    ```bash
-    pnpm dev
-    ```
+  ```bash
+  pnpm dev
+  ```
 
--   **`pnpm test`**: Runs the unit tests using Vitest.
+- **`pnpm test`**: Runs the unit tests using Vitest.
 
-    ```bash
-    pnpm test
-    ```
+  ```bash
+  pnpm test
+  ```
 
--   **`pnpm clean`**: Removes the `dist` directory, clearing all compiled output.
+- **`pnpm clean`**: Removes the `dist` directory, clearing all compiled output.
 
-    ```bash
-    pnpm clean
-    ```
+  ```bash
+  pnpm clean
+  ```
 
--   **`pnpm prepare`**: This script is typically run after `pnpm install` and before `pnpm publish`. In this project, it simply runs `pnpm build`.
+- **`pnpm prepare`**: This script is typically run after `pnpm install` and before `pnpm publish`. In this project, it simply runs `pnpm build`.
 
-    ```bash
-    pnpm prepare
-    ```
+  ```bash
+  pnpm prepare
+  ```
 
 ## Testing
 
@@ -77,4 +78,3 @@ This project uses an automated release workflow via GitHub Actions (`.github/wor
 ## Contributing
 
 We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) file for detailed guidelines on how to submit issues, propose features, and make pull requests.
-

README.md

@@ -1,4 +1,5 @@
 # @interactive-video-labs/svelte
+
 <p align="center">
   <img src="https://raw.githubusercontent.com/interactive-video-labs/docs/main/logo.svg" width="200px" alt="Interactive Video Labs Logo" />
 </p>
@@ -79,15 +80,15 @@ Here’s a simple example of how to use the `<InteractiveVideo />` component in
 
 ### Props
 
-| Prop               | Type                                                           | Required | Default | Description                                                                 |
-|--------------------|----------------------------------------------------------------|----------|---------|-----------------------------------------------------------------------------|
-| `videoUrl`         | `string`                                                       | `true`   | —       | The URL of the video to be loaded.                                          |
-| `cues`             | `CuePoint[]`                                                   | `false`  | `[]`    | An array of cue points for interactive events. Reactive/updated at runtime. |
-| `translations`     | `Translations`                                                 | `false`  | `{}`    | Translations for the player UI.                                             |
-| `autoplay`         | `boolean`                                                      | `false`  | `false` | Whether the video should start playing automatically.                       |
-| `loop`             | `boolean`                                                      | `false`  | `false` | Whether the video should loop.                                              |
-| `locale`           | `string`                                                       | `false`  | `'en'`  | The locale to be used for the player (e.g., `'en'`, `'es'`).                |
-| `bind:playerRef`   | `Player` (`@interactive-video-labs/core`)                      | `false`  | —       | Two-way bind to access the underlying core player instance.                 |
+| Prop             | Type                                      | Required | Default | Description                                                                 |
+| ---------------- | ----------------------------------------- | -------- | ------- | --------------------------------------------------------------------------- |
+| `videoUrl`       | `string`                                  | `true`   | —       | The URL of the video to be loaded.                                          |
+| `cues`           | `CuePoint[]`                              | `false`  | `[]`    | An array of cue points for interactive events. Reactive/updated at runtime. |
+| `translations`   | `Translations`                            | `false`  | `{}`    | Translations for the player UI.                                             |
+| `autoplay`       | `boolean`                                 | `false`  | `false` | Whether the video should start playing automatically.                       |
+| `loop`           | `boolean`                                 | `false`  | `false` | Whether the video should loop.                                              |
+| `locale`         | `string`                                  | `false`  | `'en'`  | The locale to be used for the player (e.g., `'en'`, `'es'`).                |
+| `bind:playerRef` | `Player` (`@interactive-video-labs/core`) | `false`  | —       | Two-way bind to access the underlying core player instance.                 |
 
 > Any additional attributes supported by `@interactive-video-labs/core` will be forwarded to the player configuration.
 
@@ -99,8 +100,14 @@ Player analytics/events are dispatched as a Svelte DOM event named `analyticsEve
 
 ```ts
 type AnalyticsDetail = {
-  event: 'PLAYER_LOADED' | 'VIDEO_STARTED' | 'VIDEO_PAUSED' | 'VIDEO_ENDED' |
-          'CUE_TRIGGERED' | 'INTERACTION_COMPLETED' | 'ERROR';
+  event:
+    | 'PLAYER_LOADED'
+    | 'VIDEO_STARTED'
+    | 'VIDEO_PAUSED'
+    | 'VIDEO_ENDED'
+    | 'CUE_TRIGGERED'
+    | 'INTERACTION_COMPLETED'
+    | 'ERROR';
   payload?: any;
 };
 ```
@@ -171,4 +178,3 @@ Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTIN
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
-

eslint.config.mjs

@@ -0,0 +1,43 @@
+import { defineConfig } from 'eslint/config';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import prettier from 'eslint-plugin-prettier';
+import tsParser from '@typescript-eslint/parser';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default defineConfig([
+  {
+    ignores: ['node_modules/*', 'dist/*', '.svelte-kit/*', 'scripts/*', 'test/*'],
+  },
+  {
+    extends: compat.extends(
+      'eslint:recommended',
+      'plugin:@typescript-eslint/recommended',
+      'prettier',
+    ),
+
+    plugins: {
+      '@typescript-eslint': typescriptEslint,
+      prettier,
+    },
+
+    languageOptions: {
+      parser: tsParser,
+    },
+
+    rules: {
+      ...typescriptEslint.configs.recommended.rules,
+      'prettier/prettier': 'error',
+    },
+  },
+]);