From 415d083f24a6376525c8496cc9ed7ad717f0ab30 Mon Sep 17 00:00:00 2001 From: Ollie Taylor <13766232+OllieJT@users.noreply.github.com> Date: Mon, 10 Jul 2023 21:44:55 +0100 Subject: [PATCH] JSDoc (#43) --- .changeset/six-donkeys-warn.md | 5 ++ .github/workflows/publish.yml | 6 +- .vscode/settings.json | 1 - package.json | 8 +- src/content/example/add-loader.svelte | 4 +- .../{component.svelte => context.svelte} | 7 +- src/lib/audio/index.js | 9 ++ src/lib/audio/index.ts | 2 - src/lib/{components => audio}/player.svelte | 17 ++-- src/lib/{components => audio}/progress.svelte | 12 ++- src/lib/audio/stores/audio-element.js | 50 +++++++++++ src/lib/audio/stores/audio-element.ts | 32 -------- .../{episode-data.ts => episode-data.js} | 64 +++++++++------ src/lib/audio/stores/episode-details.js | 12 +++ src/lib/audio/stores/episode-details.ts | 12 --- ...pisode-progress.ts => episode-progress.js} | 29 ++++--- src/lib/audio/stores/{index.ts => index.js} | 0 src/lib/components/index.ts | 2 - src/lib/index.js | 4 + src/lib/index.ts | 5 -- src/lib/user/{index.ts => index.js} | 5 ++ src/lib/user/user-preferences.js | 82 +++++++++++++++++++ src/lib/user/user-preferences.ts | 49 ----------- src/lib/user/user-progress.js | 77 +++++++++++++++++ src/lib/user/user-progress.ts | 53 ------------ src/lib/utility/announce.js | 67 +++++++++++++++ src/lib/utility/announce.ts | 49 ----------- src/lib/utility/{index.ts => index.js} | 5 ++ ...o-timestamp.ts => seconds-to-timestamp.js} | 14 ++-- src/lib/utility/use-url.js | 31 +++++++ src/lib/utility/use-url.ts | 23 ------ src/routes/+layout.svelte | 4 +- 32 files changed, 443 insertions(+), 297 deletions(-) create mode 100644 .changeset/six-donkeys-warn.md rename src/lib/audio/{component.svelte => context.svelte} (95%) create mode 100644 src/lib/audio/index.js delete mode 100644 src/lib/audio/index.ts rename src/lib/{components => audio}/player.svelte (82%) rename src/lib/{components => audio}/progress.svelte (82%) create mode 100644 src/lib/audio/stores/audio-element.js delete mode 100644 src/lib/audio/stores/audio-element.ts rename src/lib/audio/stores/{episode-data.ts => episode-data.js} (70%) create mode 100644 src/lib/audio/stores/episode-details.js delete mode 100644 src/lib/audio/stores/episode-details.ts rename src/lib/audio/stores/{episode-progress.ts => episode-progress.js} (53%) rename src/lib/audio/stores/{index.ts => index.js} (100%) delete mode 100644 src/lib/components/index.ts create mode 100644 src/lib/index.js delete mode 100644 src/lib/index.ts rename src/lib/user/{index.ts => index.js} (58%) create mode 100644 src/lib/user/user-preferences.js delete mode 100644 src/lib/user/user-preferences.ts create mode 100644 src/lib/user/user-progress.js delete mode 100644 src/lib/user/user-progress.ts create mode 100644 src/lib/utility/announce.js delete mode 100644 src/lib/utility/announce.ts rename src/lib/utility/{index.ts => index.js} (62%) rename src/lib/utility/{seconds-to-timestamp.ts => seconds-to-timestamp.js} (59%) create mode 100644 src/lib/utility/use-url.js delete mode 100644 src/lib/utility/use-url.ts diff --git a/.changeset/six-donkeys-warn.md b/.changeset/six-donkeys-warn.md new file mode 100644 index 0000000..cfd264c --- /dev/null +++ b/.changeset/six-donkeys-warn.md @@ -0,0 +1,5 @@ +--- +'svelte-podcast': minor +--- + +switch to jsdoc from ts diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 7b0c41e..43a28b4 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -75,12 +75,14 @@ jobs: - name: Install dependencies run: yarn install --frozen-lockfile + - name: Package svelte src/lib + run: yarn run package + - name: Create Release Pull Request or Publish to npm id: changesets uses: changesets/action@v1 with: - # This expects you to have a script called release which does a build for your packages and calls changeset publish - publish: yarn release + publish: yarn run release env: GITHUB_TOKEN: ${{ secrets.TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/.vscode/settings.json b/.vscode/settings.json index d16cc42..e6dca7c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -25,7 +25,6 @@ "**/*.map": true, "**/.turbo": true, "**/.vercel": true, - "**/dist": true, "**/node_modules": true, "**/tsconfig.tsbuildinfo": true, "**/.npmrc": true diff --git a/package.json b/package.json index 1b08cf2..cd51ddc 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ }, "scripts": { "dev": "vite dev", - "build": "vite build && yarn package", + "build": "vite build", "preview": "vite preview", "package": "svelte-kit sync && svelte-package && publint", "sync": "svelte-kit sync", @@ -23,7 +23,7 @@ "lint:eslint": "TIMING=1 eslint . --ext .ts,.tsx,.svelte --cache", "lint": "yarn lint:prettier && yarn lint:eslint", "format": "prettier --write --plugin-search-dir=. .", - "release": "yarn package && changeset publish", + "release": "changeset publish", "ts": "tsc --pretty --noImplicitAny --noEmit" }, "exports": { @@ -36,11 +36,13 @@ "dist" ], "peerDependencies": { - "svelte": ">=3.00.0" + "@sveltejs/kit": ">=1.0.0", + "svelte": ">=3.0.0" }, "dependencies": { "@inqling/svelte-icons": "^3.3.2", "clsx": "^1.2.1", + "esm-env": "^1.0.0", "just-clamp": "^4.2.0", "svelte-local-storage-store": "^0.5.0" }, diff --git a/src/content/example/add-loader.svelte b/src/content/example/add-loader.svelte index 1bdecd7..d4ee0b8 100644 --- a/src/content/example/add-loader.svelte +++ b/src/content/example/add-loader.svelte @@ -1,8 +1,8 @@ -