Merge branch 'master' of https://github.com/Deivu/Shoukaku

.gitattributes

@@ -1 +1,3 @@
-* text=auto eol=lf
+* text=auto eol=lf
+
+package-lock.json binary

.github/workflows/code-check.yml

@@ -20,7 +20,9 @@ jobs:
     - name: Install Node
       uses: actions/setup-node@v4
       with:
-        node-version: 18
+        node-version: latest
+        cache: npm
+        cache-dependency-path: package-lock.json
     - name: Install Deps
       run: npm i
     - name: Lint code

.github/workflows/code-compile.yml

@@ -15,13 +15,17 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x]
+        node-version: [lts/*, latest]
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
+        cache: npm
+        cache-dependency-path: package-lock.json
     - run: npm i
     - run: npm pack

.github/workflows/prerelease.yml

@@ -1,23 +1,31 @@
 name: Prerelease
-on: workflow_dispatch
+
+on:
+  push:
+    branches:
+      - "master"
+      - "v[0-9]+"
+    tags:
+      - "!**"
+  pull_request:
 
 jobs:
   publish:
     name: Publish Prerelease
     runs-on: ubuntu-latest
     permissions:
       contents: read
-      id-token: write
     steps:
       - uses: actions/checkout@v4
-      - name: Publish to NPM
+        with:
+          persist-credentials: false
+      - name: Use Node LTS
         uses: actions/setup-node@v4
-        if: ${{ steps.changelog.outputs.skipped == 'false' }}
         with:
           node-version: lts/*
-          registry-url: https://registry.npmjs.org
-      - run: npm i
-      - run: 'npm version --preid=git --no-git-tag-version 0.0.0-git.$(git rev-parse HEAD)'
-      - run: npm publish --provenance --access public --tag prerelease
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          cache: npm
+          cache-dependency-path: package-lock.json
+      - name: Install Depedencies
+        run: npm ci
+      - name: Publish to pkg.pr.new
+        run: npx pkg-pr-new publish

.github/workflows/typedoc.yml

@@ -0,0 +1,50 @@
+name: Publish TypeDoc
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps: 
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: latest
+          cache: npm
+          cache-dependency-path: package-lock.json
+
+      - name: Install deps
+        run: npm i
+
+      - name: Build docs
+        run: npm run build:docs
+
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/
+
+  deploy-docs:
+    needs: build-docs
+
+    permissions:
+      id-token: write
+      pages: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+

.gitignore

@@ -3,7 +3,6 @@
 .DS_Store
 node_modules/
 dist/
-package-lock.json
 pnpm-lock.yaml
 yarn.lock
 yarn-debug.log*

.npmignore

@@ -1,8 +1,6 @@
 .github
 .idea
 .vscode
-.eslintignore
-.eslintrc.json
 .gitattributes
 .gitignore
 assets/
@@ -11,5 +9,7 @@ src/
 index.ts
 tsconfig.json
 tsup-config.json
+package-lock.json
+eslint.config.mjs
 **.tgz
 **.md

TypeDoc.md

@@ -0,0 +1,18 @@
+
+> A stable and updated wrapper around Lavalink
+
+[![Discord](https://img.shields.io/discord/423116740810244097?style=flat-square)](https://discordapp.com/invite/FVqbtGu)
+[![npm](https://img.shields.io/npm/v/shoukaku?style=flat-square)](https://www.npmjs.com/package/shoukaku)
+![Github Stars](https://img.shields.io/github/stars/Deivu/Shoukaku?style=flat-square)
+![GitHub issues](https://img.shields.io/github/issues-raw/Deivu/Shoukaku?style=flat-square)
+![NPM](https://img.shields.io/npm/l/shoukaku?style=flat-square)
+
+Automatically generated documentation for the *latest commit* on the ***master*** branch.
+
+API Documentation for specific versions and additional usage information can be found on the [guide](https://guide.shoukaku.shipgirl.moe/).
+
+<p align="center">
+    <img src="https://safe.saya.moe/OlYoY5xxkMLO.png"> 
+</p>
+
+> Shoukaku, from Azur Lane, drawn by: elfenlied22