Improvements and enhancement of dev experience (#15)

* chore: rework global DX * chore: use biomejs instead of eslint * chore: examples in ts, switch from CJS to ECM, fix docs typos, remove discord-logs for less internal coupling
HunteRoi · Jun 20, 2024 · 5dbfab4 · 5dbfab4
1 parent 54f49de
commit 5dbfab4
Show file tree

Hide file tree

Showing 31 changed files with 775 additions and 1,568 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -7,13 +7,11 @@ on:
       - master
 
 jobs:
-  publish:
+  build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: 20
-          registry-url: https://registry.npmjs.org/
-          scope: '@hunteroi'
       - run: yarn
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -9,8 +9,8 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org/

diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,7 @@
 # Node
-node_modules
+node_modules/
 
 # Compiled files
-lib
-
-# Tests
-**test**
+lib/
+examples/index.js
+examples/index2.js
diff --git a/.prettierrc b/.prettierrc
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,8 @@
+{
+    "editor.codeActionsOnSave": {
+        "quickfix.biome": "explicit",
+        "source.organizeImports.biome": "explicit"
+    },
+    "editor.defaultFormatter": "biomejs.biome",
+    "editor.formatOnSave": true
+}
diff --git a/biome.json b/biome.json
@@ -0,0 +1,24 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.6.4/schema.json",
+	"organizeImports": {
+		"enabled": true
+	},
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true,
+		"defaultBranch": "master"
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "space",
+		"indentWidth": 4,
+		"lineEnding": "lf"
+	}
+}
diff --git a/docs/api-docs/classes/ClientWithTempManager.html b/docs/api-docs/classes/ClientWithTempManager.html
diff --git a/docs/api-docs/classes/TempChannelsManager.html b/docs/api-docs/classes/TempChannelsManager.html
diff --git a/docs/api-docs/enums/TempChannelsManagerEvents.html b/docs/api-docs/enums/TempChannelsManagerEvents.html
diff --git a/docs/api-docs/index.html b/docs/api-docs/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@hunteroi/discord-temp-channels</title><meta name="description" content="Documentation for @hunteroi/discord-temp-channels"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@hunteroi/discord-temp-channels</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@hunteroi/discord-temp-channels</h2></div><div class="tsd-panel tsd-typography"><p><a href="https://www.npmjs.com/@hunteroi/discord-temp-channels"><img src="https://img.shields.io/github/v/release/hunteroi/discord-temp-channels?style=for-the-badge" alt="release version"/></a>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@hunteroi/discord-temp-channels</title><meta name="description" content="Documentation for @hunteroi/discord-temp-channels"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/hunteroi/discord-temp-channels">GitHub</a><a href="https://github.com/hunteroi/discord-temp-channels/blob/master/BREAKING_CHANGES.md">Breaking Changes</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@hunteroi/discord-temp-channels</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@hunteroi/discord-temp-channels</h2></div><div class="tsd-panel tsd-typography"><p><a href="https://www.npmjs.com/@hunteroi/discord-temp-channels"><img src="https://img.shields.io/github/v/release/hunteroi/discord-temp-channels?style=for-the-badge" alt="release version"/></a>
 <a href="https://www.npmjs.com/@hunteroi/discord-temp-channels"><img src="https://img.shields.io/npm/dt/@hunteroi/discord-temp-channels?style=for-the-badge" alt="nb downloads npm"/></a></p>
 <a id="md:discord-temporary-voice-channels" class="tsd-anchor"></a><h1><a href="#md:discord-temporary-voice-channels">Discord Temporary Voice Channels</a></h1><p>This library works the same way its parent does (see <a href="https://github.com/Androz2091/discord-temp-channels">discord-temp-channels</a> of <a href="https://github.com/Androz2091">Androz2091</a>) except that it brings a few new features:</p>
 <ul>