yarn workspaces and migrate example app to vite react

E-Kuerschner · Jan 5, 2025 · 307d1b7 · 307d1b7
1 parent 0eacda7
commit 307d1b7
Show file tree

Hide file tree

Showing 69 changed files with 1,144 additions and 8,516 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -40,9 +40,9 @@ jobs:
       - name: Enable Corepack
         run: corepack enable
       - name: Dev Server Setup
-        run: yarn --cwd ./examples install
+        run: yarn install
       - name: Cypress run
         uses: cypress-io/github-action@v2
         with:
-          start: yarn --cwd ./examples run start
+          start: yarn demos-parcel:start
           wait-on: http://localhost:1234/
diff --git a/.gitignore b/.gitignore
@@ -15,13 +15,5 @@ dist
 !.yarn/sdks
 !.yarn/versions
 
-examples/.pnp.*
-examples/.yarn/*
-!examples/.yarn/patches
-!examples/.yarn/plugins
-!examples/.yarn/releases
-!examples/.yarn/sdks
-!examples/.yarn/versions
-
-test/cypress/videos
-test/cypress/screenshots
+packages/react-use-audio-player/test/cypress/videos
+packages/react-use-audio-player/test/cypress/screenshots
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -1 +1,9 @@
 nodeLinker: node-modules
+
+packageExtensions:
+  # deasync didn't add node-gyp as a direct dependency so it fails to build in
+  # Yarn (https://github.com/yarnpkg/berry/issues/5804), so extend its
+  # pkg.json config here.
+  deasync@*:
+    dependencies:
+      node-gyp: 'latest'
diff --git a/demos/vite-spa/.gitignore b/demos/vite-spa/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/demos/vite-spa/README.md b/demos/vite-spa/README.md
@@ -0,0 +1,50 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+export default tseslint.config({
+  languageOptions: {
+    // other options...
+    parserOptions: {
+      project: ['./tsconfig.node.json', './tsconfig.app.json'],
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+})
+```
+
+- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
+- Optionally add `...tseslint.configs.stylisticTypeChecked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
+
+```js
+// eslint.config.js
+import react from 'eslint-plugin-react'
+
+export default tseslint.config({
+  // Set the react version
+  settings: { react: { version: '18.3' } },
+  plugins: {
+    // Add the react plugin
+    react,
+  },
+  rules: {
+    // other rules...
+    // Enable its recommended rules
+    ...react.configs.recommended.rules,
+    ...react.configs['jsx-runtime'].rules,
+  },
+})
+```
diff --git a/demos/vite-spa/index.html b/demos/vite-spa/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="./src/index.tsx"></script>
+  </body>
+</html>
diff --git a/demos/vite-spa/package.json b/demos/vite-spa/package.json
@@ -0,0 +1,29 @@
+{
+  "name": "vite-spa",
+  "packageManager": "[email protected]",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite --port 1234",
+    "demos-vite-spa:start": "cd $INIT_CWD && yarn --cwd $PROJECT_CWD/demos/vite-spa dev",
+    "build": "tsc -b && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^6.11.0",
+    "react-use-audio-player": "workspace:^"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
+    "@vitejs/plugin-react": "^4.3.4",
+    "globals": "^15.14.0",
+    "sass": "^1.83.1",
+    "typescript": "~5.6.2",
+    "vite": "^6.0.5"
+  }
+}
diff --git a/examples/static/audio.mp3 → demos/vite-spa/public/audio.mp3 b/examples/static/audio.mp3 → demos/vite-spa/public/audio.mp3
diff --git a/examples/static/cats.mp3 → demos/vite-spa/public/cats.mp3 b/examples/static/cats.mp3 → demos/vite-spa/public/cats.mp3
diff --git a/examples/static/ch_tunes - baby_seal.wav → .../vite-spa/public/ch_tunes - baby_seal.wav b/examples/static/ch_tunes - baby_seal.wav → .../vite-spa/public/ch_tunes - baby_seal.wav
diff --git a/examples/static/ch_tunes - jam_10.wav → demos/vite-spa/public/ch_tunes - jam_10.wav b/examples/static/ch_tunes - jam_10.wav → demos/vite-spa/public/ch_tunes - jam_10.wav
diff --git a/examples/static/ch_tunes - jam_2.wav → demos/vite-spa/public/ch_tunes - jam_2.wav b/examples/static/ch_tunes - jam_2.wav → demos/vite-spa/public/ch_tunes - jam_2.wav
diff --git a/examples/static/ch_tunes - jam_4.wav → demos/vite-spa/public/ch_tunes - jam_4.wav b/examples/static/ch_tunes - jam_4.wav → demos/vite-spa/public/ch_tunes - jam_4.wav
diff --git a/examples/static/ch_tunes - jam_8.wav → demos/vite-spa/public/ch_tunes - jam_8.wav b/examples/static/ch_tunes - jam_8.wav → demos/vite-spa/public/ch_tunes - jam_8.wav
diff --git a/examples/static/dog.mp3 → demos/vite-spa/public/dog.mp3 b/examples/static/dog.mp3 → demos/vite-spa/public/dog.mp3
diff --git a/examples/src/App.tsx → demos/vite-spa/src/App.tsx b/examples/src/App.tsx → demos/vite-spa/src/App.tsx
@@ -1,12 +1,11 @@
-import React from "react"
 import { BrowserRouter, Link, Route, Routes } from "react-router-dom"
 import { BasicExample } from "./GlobalAudioSource/AudioPlayerState"
 import { Spotifyish } from "./GlobalAudioSource/SoundLibrary"
 import { AutoPlayNextSound } from "./GlobalAudioSource/AutoPlayNextSound"
 import { MultipleSounds } from "./MultipleSounds"
 import { GlobalAudioSource } from "./GlobalAudioSource"
-import "./app.scss"
 import { Streaming } from "./Streaming"
+import "./app.scss"
 
 function ExampleSelect() {
     return (

diff --git a/examples/src/AudioSeekBar.scss → demos/vite-spa/src/AudioSeekBar.scss b/examples/src/AudioSeekBar.scss → demos/vite-spa/src/AudioSeekBar.scss
diff --git a/examples/src/AudioSeekBar.tsx → demos/vite-spa/src/AudioSeekBar.tsx b/examples/src/AudioSeekBar.tsx → demos/vite-spa/src/AudioSeekBar.tsx
@@ -1,4 +1,4 @@
-import React, {
+import {
     useCallback,
     useEffect,
     useRef,
@@ -13,7 +13,7 @@ interface AudioSeekBarProps {
     className?: string
 }
 
-export const AudioSeekBar: FunctionComponent<AudioSeekBarProps> = props => {
+export const AudioSeekBar: FunctionComponent<AudioSeekBarProps> = (props) => {
     const { className = "" } = props
     const { playing, getPosition, duration, seek } = useGlobalAudioPlayer()
     const [pos, setPos] = useState(0)

diff --git a/examples/src/BackToHome.tsx → demos/vite-spa/src/BackToHome.tsx b/examples/src/BackToHome.tsx → demos/vite-spa/src/BackToHome.tsx
@@ -1,10 +1,14 @@
-import React, { FunctionComponent } from "react"
+import { FunctionComponent } from "react"
 import { Link } from "react-router-dom"
 
 interface BackToHomeProps {
     className?: string
 }
 
 export const BackToHome: FunctionComponent<BackToHomeProps> = (props) => {
-    return <Link className={ props.className || "" } to="/">{"< -"} Example Select</Link>
+    return (
+        <Link className={props.className || ""} to="/">
+            {"< -"} Example Select
+        </Link>
+    )
 }
diff --git a/...Source/AudioPlayerState/AudioControls.tsx → ...Source/AudioPlayerState/AudioControls.tsx b/...Source/AudioPlayerState/AudioControls.tsx → ...Source/AudioPlayerState/AudioControls.tsx
@@ -1,17 +1,9 @@
-import React, { useEffect, useState, FunctionComponent } from "react"
+import { type FunctionComponent } from "react"
 import { useGlobalAudioPlayer } from "react-use-audio-player"
 
 export const AudioControls: FunctionComponent<{}> = () => {
-    const {
-        play,
-        pause,
-        stop,
-        mute,
-        muted,
-        playing,
-        loop,
-        looping
-    } = useGlobalAudioPlayer()
+    const { play, pause, stop, mute, muted, playing, loop, looping } =
+        useGlobalAudioPlayer()
 
     return (
         <div>

diff --git a/...dioSource/AudioPlayerState/FileLoader.tsx → ...dioSource/AudioPlayerState/FileLoader.tsx b/...dioSource/AudioPlayerState/FileLoader.tsx → ...dioSource/AudioPlayerState/FileLoader.tsx
@@ -1,9 +1,4 @@
-import React, {
-    useState,
-    FunctionComponent,
-    ChangeEvent,
-    useEffect
-} from "react"
+import { useState, FunctionComponent, ChangeEvent, useEffect } from "react"
 import { AudioLoadOptions, useGlobalAudioPlayer } from "react-use-audio-player"
 
 export const FileLoader: FunctionComponent = () => {

diff --git a/...balAudioSource/AudioPlayerState/index.tsx → ...balAudioSource/AudioPlayerState/index.tsx b/...balAudioSource/AudioPlayerState/index.tsx → ...balAudioSource/AudioPlayerState/index.tsx
@@ -1,4 +1,4 @@
-import React, { FunctionComponent } from "react"
+import { FunctionComponent } from "react"
 import { useGlobalAudioPlayer } from "react-use-audio-player"
 import { FileLoader } from "./FileLoader"
 import { AudioControls } from "./AudioControls"

diff --git a/...lAudioSource/AudioPlayerState/styles.scss → ...lAudioSource/AudioPlayerState/styles.scss b/...lAudioSource/AudioPlayerState/styles.scss → ...lAudioSource/AudioPlayerState/styles.scss
diff --git a/...alAudioSource/AutoPlayNextSound/index.tsx → ...alAudioSource/AutoPlayNextSound/index.tsx b/...alAudioSource/AutoPlayNextSound/index.tsx → ...alAudioSource/AutoPlayNextSound/index.tsx
@@ -1,8 +1,7 @@
-import React, { useEffect, useState } from "react"
+import { useEffect, useState } from "react"
 import { useGlobalAudioPlayer } from "react-use-audio-player"
 import { TimeLabel } from "../../TimeLabel"
-import "./styles"
-import { Howl } from "howler"
+import "./styles.css"
 
 const songs = [
     "/ch_tunes - jam_10.wav",
@@ -13,20 +12,14 @@ const songs = [
 export function AutoPlayNextSound() {
     const [songIndex, setSongIndex] = useState(0)
 
-    const {
-        togglePlayPause,
-        isReady,
-        load,
-        seek,
-        duration,
-        playing
-    } = useGlobalAudioPlayer()
+    const { togglePlayPause, isReady, load, seek, duration, playing } =
+        useGlobalAudioPlayer()
 
     useEffect(() => {
         load(songs[songIndex], {
             autoplay: true,
             onend: () => {
-                setSongIndex(index => {
+                setSongIndex((index) => {
                     if (index === songs.length - 1) {
                         return 0
                     }

diff --git a/...lAudioSource/AutoPlayNextSound/styles.css → ...lAudioSource/AutoPlayNextSound/styles.css b/...lAudioSource/AutoPlayNextSound/styles.css → ...lAudioSource/AutoPlayNextSound/styles.css
diff --git a/examples/src/GlobalAudioSource/PlayBar.tsx → ...ite-spa/src/GlobalAudioSource/PlayBar.tsx b/examples/src/GlobalAudioSource/PlayBar.tsx → ...ite-spa/src/GlobalAudioSource/PlayBar.tsx
@@ -1,18 +1,11 @@
-import React from "react"
 import { useGlobalAudioPlayer } from "react-use-audio-player"
 import { AudioSeekBar } from "../AudioSeekBar"
 import { TimeLabel } from "../TimeLabel"
 import { VolumeControl } from "../VolumeControl"
 
 export const PlayBar = () => {
-    const {
-        togglePlayPause,
-        playing,
-        isReady,
-        setRate,
-        rate,
-        src
-    } = useGlobalAudioPlayer()
+    const { togglePlayPause, playing, isReady, setRate, rate, src } =
+        useGlobalAudioPlayer()
 
     return (
         <div className="playBar">
@@ -38,7 +31,7 @@ export const PlayBar = () => {
                         name="rateSelect"
                         id="rate"
                         value={rate}
-                        onChange={e => setRate(Number(e.target.value))}
+                        onChange={(e) => setRate(Number(e.target.value))}
                     >
                         <option value="0.5">1/2x</option>
                         <option value="1">1x</option>

diff --git a/.../GlobalAudioSource/SoundLibrary/index.tsx → .../GlobalAudioSource/SoundLibrary/index.tsx b/.../GlobalAudioSource/SoundLibrary/index.tsx → .../GlobalAudioSource/SoundLibrary/index.tsx
diff --git a/...lobalAudioSource/SoundLibrary/styles.scss → ...lobalAudioSource/SoundLibrary/styles.scss b/...lobalAudioSource/SoundLibrary/styles.scss → ...lobalAudioSource/SoundLibrary/styles.scss
diff --git a/examples/src/GlobalAudioSource/index.tsx → .../vite-spa/src/GlobalAudioSource/index.tsx b/examples/src/GlobalAudioSource/index.tsx → .../vite-spa/src/GlobalAudioSource/index.tsx
@@ -1,7 +1,6 @@
-import React from "react"
 import { Link, Outlet, useMatch } from "react-router-dom"
-import "./styles.scss"
 import { PlayBar } from "./PlayBar"
+import "./styles.scss"
 
 const ExampleSelect = () => {
     return (

diff --git a/examples/src/GlobalAudioSource/styles.scss → ...ite-spa/src/GlobalAudioSource/styles.scss b/examples/src/GlobalAudioSource/styles.scss → ...ite-spa/src/GlobalAudioSource/styles.scss
diff --git a/demos/vite-spa/src/Globals.d.ts b/demos/vite-spa/src/Globals.d.ts
@@ -0,0 +1,2 @@
+declare module "*.css"
+declare module "*.scss"
diff --git a/examples/src/MultipleSounds/index.tsx → demos/vite-spa/src/MultipleSounds/index.tsx b/examples/src/MultipleSounds/index.tsx → demos/vite-spa/src/MultipleSounds/index.tsx
@@ -1,4 +1,4 @@
-import React, { useState, useCallback, useEffect } from "react"
+import { useState, useCallback, useEffect, ChangeEvent } from "react"
 import { Link } from "react-router-dom"
 import { useAudioPlayer } from "react-use-audio-player"
 import "./styles.scss"
@@ -18,9 +18,10 @@ export const MultipleSounds = () => {
         song2.togglePlayPause()
     }, [song1.togglePlayPause, song2.togglePlayPause])
 
-    const handleFade = useCallback(e => {
-        setXFadeValue(e.target.value)
-        const ratio = e.target.value / 100
+    const handleFade = useCallback((e: ChangeEvent<HTMLInputElement>) => {
+        const value = Number(e.target.value)
+        setXFadeValue(value)
+        const ratio = value / 100
         song1.setVolume(1 - ratio)
         song2.setVolume(ratio)
     }, [])

diff --git a/examples/src/MultipleSounds/styles.scss → ...s/vite-spa/src/MultipleSounds/styles.scss b/examples/src/MultipleSounds/styles.scss → ...s/vite-spa/src/MultipleSounds/styles.scss
diff --git a/examples/src/Streaming/index.tsx → demos/vite-spa/src/Streaming/index.tsx b/examples/src/Streaming/index.tsx → demos/vite-spa/src/Streaming/index.tsx
diff --git a/examples/src/Streaming/styles.scss → demos/vite-spa/src/Streaming/styles.scss b/examples/src/Streaming/styles.scss → demos/vite-spa/src/Streaming/styles.scss
diff --git a/examples/src/TimeLabel.tsx → demos/vite-spa/src/TimeLabel.tsx b/examples/src/TimeLabel.tsx → demos/vite-spa/src/TimeLabel.tsx
@@ -1,4 +1,4 @@
-import React, { useEffect, useState } from "react"
+import { useEffect, useState } from "react"
 import { useGlobalAudioPlayer } from "react-use-audio-player"
 
 const formatTime = (seconds: number) => {
@@ -19,7 +19,7 @@ const formatTime = (seconds: number) => {
 
 export const TimeLabel = () => {
     const [pos, setPos] = useState(0)
-    const { duration, getPosition, playing } = useGlobalAudioPlayer()
+    const { duration, getPosition } = useGlobalAudioPlayer()
 
     useEffect(() => {
         const i = setInterval(() => {

diff --git a/examples/src/VolumeControl.scss → demos/vite-spa/src/VolumeControl.scss b/examples/src/VolumeControl.scss → demos/vite-spa/src/VolumeControl.scss
diff --git a/examples/src/VolumeControl.tsx → demos/vite-spa/src/VolumeControl.tsx b/examples/src/VolumeControl.tsx → demos/vite-spa/src/VolumeControl.tsx
@@ -1,4 +1,4 @@
-import React, { ChangeEvent, useCallback } from "react"
+import { ChangeEvent, useCallback } from "react"
 import { useGlobalAudioPlayer } from "react-use-audio-player"
 import "./VolumeControl.scss"
 

diff --git a/examples/src/app.scss → demos/vite-spa/src/app.scss b/examples/src/app.scss → demos/vite-spa/src/app.scss
diff --git a/demos/vite-spa/src/index.tsx b/demos/vite-spa/src/index.tsx
@@ -0,0 +1,12 @@
+import { StrictMode } from "react"
+import { createRoot } from "react-dom/client"
+import App from "./App"
+import "./app.scss"
+
+const root = createRoot(document.getElementById("root")!)
+
+root.render(
+    <StrictMode>
+        <App />
+    </StrictMode>
+)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		declare module "*.css"
		declare module "*.scss"