@purpleproser/soundboard-downloader-cli 1.1.0 → 1.2.2

package/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: 📦️ Publish to NPM
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  id-token: write # Required for OIDC
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+          registry-url: "https://registry.npmjs.org"
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm publish

package/.github/workflows/release-please.yml

@@ -0,0 +1,25 @@
+name: ➡️ Release please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        with:
+          # this assumes that you have created a personal access token
+          # (PAT) and configured it as a GitHub action secret named
+          # `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
+          token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
+          # this is a built-in strategy in release-please, see "Action Inputs"
+          # for more options
+          release-type: node

package/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: 🧪 Run Tests
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Run tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run tests
+        run: npm test

package/CHANGELOG.md

@@ -0,0 +1,73 @@
+# Changelog
+
+This changelog is automatically generated by [release-please](https://github.com/google-github-actions/release-please-action).
+
+## [1.2.2](https://github.com/blacksagres/soundboard-downloader-cli/compare/v1.2.1...v1.2.2) (2026-02-15)
+
+
+### Bug Fixes
+
+* prevent tests from running until fixed ([2da9ad1](https://github.com/blacksagres/soundboard-downloader-cli/commit/2da9ad1e3616dddb4868babde7c39a97f92a2c30))
+* use the correct yml file for publishing to npm ([364cbb8](https://github.com/blacksagres/soundboard-downloader-cli/commit/364cbb8fe95456fb036d90a1a8bd014bccc7cea7))
+
+## [1.2.1](https://github.com/blacksagres/soundboard-downloader-cli/compare/v1.2.0...v1.2.1) (2026-02-15)
+
+
+### Bug Fixes
+
+* configure trusted publisher in npm and adjust the publish file ([8cbddce](https://github.com/blacksagres/soundboard-downloader-cli/commit/8cbddce0b6e80ce099bd848aef855d5e27abbc18))
+
+## [1.2.0](https://github.com/blacksagres/soundboard-downloader-cli/compare/v1.1.1...v1.2.0) (2026-02-15)
+
+
+### Features
+
+* add new option to display url ([51758d3](https://github.com/blacksagres/soundboard-downloader-cli/commit/51758d3c26602a649f5172a8dcb31981f5e7bc89))
+
+
+### Bug Fixes
+
+* add correct release type to config ([737d1b9](https://github.com/blacksagres/soundboard-downloader-cli/commit/737d1b925ccaae715061a2023470e0f3d7534688))
+* handle potential undefined from file name generation ([484129f](https://github.com/blacksagres/soundboard-downloader-cli/commit/484129f79da05d56edee650c320fcc82cf81d042))
+* make vitest ignore files outside src ([7313579](https://github.com/blacksagres/soundboard-downloader-cli/commit/7313579f62f482bbd069da7de539f10697e2de83))
+* prevent shipping declaration files in the package ([fad7dc7](https://github.com/blacksagres/soundboard-downloader-cli/commit/fad7dc76c1b916a5becfa9677a486821b75c9792))
+* prevent test files from being added to build ([268b43f](https://github.com/blacksagres/soundboard-downloader-cli/commit/268b43fb788d7f9438b2473c4376349aa27e446b))
+* remove prepare script ([362e823](https://github.com/blacksagres/soundboard-downloader-cli/commit/362e823434f368bede87541d9fef3e70ca260343))
+* unblock other workflows until I know what's wrong with the test ([9f8c092](https://github.com/blacksagres/soundboard-downloader-cli/commit/9f8c092c6086cbbaaec087ae1de02dc47f5c954d))
+
+## v1.0.1 (2024-02-14)
+
+### Features
+
+- **download**: simplify download location to use current working directory
+
+### Bug Fixes
+
+- **publish**: fix scoped package publishing with public access config
+- **deps**: remove unused @types/node dependency
+
+### Documentation
+
+- **readme**: update with clear download location examples
+- **readme**: add npm scope vs GitHub username explanation
+- **changelog**: add comprehensive change tracking
+- **release**: add management guide for future releases
+
+### Chores
+
+- **ci**: set up GitHub Actions for automated releases
+- **config**: add release-please workflow
+
+## v1.0.0 (2024-02-14)
+
+### Features(v1.0.0)
+
+- **core**: initial implementation with MyInstants API integration
+- **cli**: interactive interface with @inquirer/prompts
+- **download**: sound download with progress indicators
+- **playback**: browser playback option using open package
+
+### Documentation(v1.0.0)
+
+- **readme**: initial setup and usage instructions
+- **license**: add MIT license file

package/README.md

@@ -1,26 +1,24 @@
 # @purpleproser/soundboard-downloader-cli
 
-A command-line tool to download soundboard sounds from MyInstants.
+A Node.js command-line tool to download soundboard sounds from [MyInstants](https://myinstants.com).
 
-**npm Package**: `@purpleproser/soundboard-downloader-cli`
-**GitHub Repository**: [blacksagres/soundboard-downloader-cli](https://github.com/blacksagres/soundboard-downloader-cli) Built with TypeScript and Node.js.
+**📦️ npm package**: `@purpleproser/soundboard-downloader-cli`
+
+**GitHub Repository**: [blacksagres/soundboard-downloader-cli](https://github.com/blacksagres/soundboard-downloader-cli)
 
 ## Features
 
 - 🔍 Search for sounds by name using interactive prompts
 - 🎵 Preview sounds by playing them in your browser
-- ⬇️ Download individual sounds to your local machine
 - 📁 Downloads are saved directly in your current working directory
 - ✨ Simple and easy-to-use interactive interface
 
 ## Tech Stack
 
-- **TypeScript** - Type-safe development
-- **Node.js** - Runtime environment
 - **Inquirer** - Interactive CLI prompts
 - **jsdom** - HTML parsing and DOM manipulation
 - **ora** - Elegant terminal spinners
-- **open** - Opens URLs in the user's browser
+- **open** - Opens URLs in the user's browser to allow previewing the sound
 
 ## Prerequisites
 
@@ -129,18 +127,6 @@ $ npm start
 
 ## Development
 
-### Project Structure
-
-```
-src/
-├── main.ts                          # Entry point
-├── api/
-│   └── my-instants.api.ts          # API layer for MyInstants
-├── components/                      # CLI components
-└── service/
-    └── my-instants.service.ts      # Business logic
-```
-
 ### Available Scripts
 
 - `npm start` - Run in development mode with ts-node

package/dist/main.js

@@ -6,9 +6,20 @@ const ora_1 = require("ora");
 const prompts_1 = require("@inquirer/prompts");
 const open_1 = require("open");
 const file_downloader_service_1 = require("./service/file-downloader.service");
+process.on("uncaughtException", (error) => {
+    if (error instanceof Error && error.name === "ExitPromptError") {
+        console.log("👋 until next time!");
+    }
+    else {
+        // Rethrow unknown errors
+        console.error(error);
+    }
+});
 (async function () {
     const answer = await (0, prompts_1.input)({
         message: "What sound effects are you looking for?",
+        required: true,
+        default: "wilhelm scream",
     });
     const spinner = (0, ora_1.default)({
         text: "Loading result...",
@@ -18,7 +29,8 @@ const file_downloader_service_1 = require("./service/file-downloader.service");
     const sounds = await (0, my_instants_service_1.getSoundNodes)(answer);
     spinner.stop();
     const selection = await (0, prompts_1.select)({
-        message: "Which one to download?",
+        message: "Which one to download? (use the keyboard arrows to navigate, search for something directly)",
+        pageSize: 30,
         choices: sounds.map((sound) => ({
             name: sound.label,
             value: `${sound.label}||${sound.download_url}`,
@@ -37,11 +49,18 @@ const file_downloader_service_1 = require("./service/file-downloader.service");
             name: "Play",
             value: "action:play",
         },
+        {
+            name: "Show download URL (you can pipe this to other commands)",
+            value: "action:show-url",
+        },
     ];
     const action = await (0, prompts_1.select)({
         message: `Selected: ${label}`,
         choices: actions,
     });
+    if (action === "action:show-url") {
+        console.log(downloadUrl);
+    }
     if (action === "action:play") {
         (0, open_1.default)(downloadUrl);
     }
@@ -52,6 +71,9 @@ const file_downloader_service_1 = require("./service/file-downloader.service");
             spinner: "growHorizontal",
         }).start();
         const downloadFileName = downloadUrl.split("/").pop();
+        if (!downloadFileName) {
+            throw new ReferenceError(`Could not find download file name for: [${downloadUrl}], could it be a malformed link?`);
+        }
         // Download directly to current working directory
         (0, file_downloader_service_1.downloadFile)(downloadUrl, {
             destination: downloadFileName,

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;AAEA,uEAA8D;AAC9D,6BAAsB;AACtB,+CAAkD;AAClD,+BAAwB;AACxB,+EAAiE;AAEjE,CAAC,KAAK;IACJ,MAAM,MAAM,GAAG,MAAM,IAAA,eAAK,EAAC;QACzB,OAAO,EAAE,yCAAyC;KACnD,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC;QAClB,IAAI,EAAE,mBAAmB;QACzB,KAAK,EAAE,SAAS;QAChB,OAAO,EAAE,cAAc;KACxB,CAAC,CAAC,KAAK,EAAE,CAAC;IAEX,MAAM,MAAM,GAAG,MAAM,IAAA,mCAAa,EAAC,MAAM,CAAC,CAAC;IAE3C,OAAO,CAAC,IAAI,EAAE,CAAC;IAEf,MAAM,SAAS,GAAG,MAAM,IAAA,gBAAM,EAAC;QAC7B,OAAO,EAAE,wBAAwB;QACjC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC9B,IAAI,EAAE,KAAK,CAAC,KAAK;YACjB,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,YAAY,EAAW;SACxD,CAAC,CAAC;KACJ,CAAC,CAAC;IAEH,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnD,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,cAAc,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,OAAO,GAAG;QACd;YACE,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,iBAAiB;SACzB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,aAAa;SACrB;KACO,CAAC;IAEX,MAAM,MAAM,GAAG,MAAM,IAAA,gBAAM,EAAC;QAC1B,OAAO,EAAE,aAAa,KAAK,EAAE;QAC7B,OAAO,EAAE,OAAO;KACjB,CAAC,CAAC;IAEH,IAAI,MAAM,KAAK,aAAa,EAAE,CAAC;QAC7B,IAAA,cAAI,EAAC,WAAW,CAAC,CAAC;IACpB,CAAC;IAED,IAAI,MAAM,KAAK,iBAAiB,EAAE,CAAC;QACjC,MAAM,eAAe,GAAG,IAAA,aAAG,EAAC;YAC1B,IAAI,EAAE,qBAAqB;YAC3B,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,gBAAgB;SAC1B,CAAC,CAAC,KAAK,EAAE,CAAC;QAEX,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;QAEtD,iDAAiD;QACjD,IAAA,sCAAY,EAAC,WAAW,EAAE;YACxB,WAAW,EAAE,gBAAiB;YAC9B,OAAO,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE;YACtC,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE;SACvC,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,EAAE,CAAC"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;AAEA,uEAA8D;AAC9D,6BAAsB;AACtB,+CAAkD;AAClD,+BAAwB;AACxB,+EAAiE;AAEjE,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,KAAK,EAAE,EAAE;IACxC,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC/D,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACrC,CAAC;SAAM,CAAC;QACN,yBAAyB;QACzB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,CAAC,KAAK;IACJ,MAAM,MAAM,GAAG,MAAM,IAAA,eAAK,EAAC;QACzB,OAAO,EAAE,yCAAyC;QAClD,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,gBAAgB;KAC1B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC;QAClB,IAAI,EAAE,mBAAmB;QACzB,KAAK,EAAE,SAAS;QAChB,OAAO,EAAE,cAAc;KACxB,CAAC,CAAC,KAAK,EAAE,CAAC;IAEX,MAAM,MAAM,GAAG,MAAM,IAAA,mCAAa,EAAC,MAAM,CAAC,CAAC;IAE3C,OAAO,CAAC,IAAI,EAAE,CAAC;IAEf,MAAM,SAAS,GAAG,MAAM,IAAA,gBAAM,EAAC;QAC7B,OAAO,EACL,6FAA6F;QAE/F,QAAQ,EAAE,EAAE;QACZ,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC9B,IAAI,EAAE,KAAK,CAAC,KAAK;YACjB,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,YAAY,EAAW;SACxD,CAAC,CAAC;KACJ,CAAC,CAAC;IAEH,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnD,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,cAAc,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,OAAO,GAAG;QACd;YACE,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,iBAAiB;SACzB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,aAAa;SACrB;QACD;YACE,IAAI,EAAE,yDAAyD;YAC/D,KAAK,EAAE,iBAAiB;SACzB;KACO,CAAC;IAEX,MAAM,MAAM,GAAG,MAAM,IAAA,gBAAM,EAAC;QAC1B,OAAO,EAAE,aAAa,KAAK,EAAE;QAC7B,OAAO,EAAE,OAAO;KACjB,CAAC,CAAC;IAEH,IAAI,MAAM,KAAK,iBAAiB,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,MAAM,KAAK,aAAa,EAAE,CAAC;QAC7B,IAAA,cAAI,EAAC,WAAW,CAAC,CAAC;IACpB,CAAC;IAED,IAAI,MAAM,KAAK,iBAAiB,EAAE,CAAC;QACjC,MAAM,eAAe,GAAG,IAAA,aAAG,EAAC;YAC1B,IAAI,EAAE,qBAAqB;YAC3B,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,gBAAgB;SAC1B,CAAC,CAAC,KAAK,EAAE,CAAC;QAEX,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;QAEtD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,cAAc,CACtB,2CAA2C,WAAW,kCAAkC,CACzF,CAAC;QACJ,CAAC;QAED,iDAAiD;QACjD,IAAA,sCAAY,EAAC,WAAW,EAAE;YACxB,WAAW,EAAE,gBAAgB;YAC7B,OAAO,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE;YACtC,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE;SACvC,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@purpleproser/soundboard-downloader-cli",
-  "version": "1.1.0",
+  "version": "1.2.2",
   "description": "Easily download sounds from myinstants.com using this interactive CLI tool",
   "license": "MIT",
   "publishConfig": {
@@ -13,10 +13,9 @@
     "soundboard-downloader": "./dist/main.js"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "vitest",
     "start": "ts-node ./src/main.ts",
-    "build": "tsc",
-    "prepare": "npm run build",
+    "build": "tsc -p tsconfig.prod.json",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -38,7 +37,8 @@
   "devDependencies": {
     "@types/jsdom": "^27.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   },
   "dependencies": {
     "@inquirer/prompts": "^8.2.0",

package/tsconfig.prod.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig",
+  "exclude": ["**/*.test.ts", "**/*.mock.ts"],
+  "compilerOptions": {
+    "declaration": false,
+    "declarationMap": false
+  }
+}

package/vite.config.js

@@ -0,0 +1,7 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    exclude: ["**/node_modules/**", "**/dist/**", "./temp/**"],
+  },
+});