termivolt - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

CHANGELOG.md

@@ -1,3 +0,10 @@
-# v0.2.0 (2021-11-29)
+# v0.3.0 (2022-02-10)
 
+- **BREAKING**: The library has been rewritten in TypeScript - this means that the project is run from the `dist` folder, meaning that you might need to reinstall Termivolt.
+- Add support for banning users (-ban)
+- Add support for optionally setting a custom API URL (specify this as the last argument)
+- General fixes and improvements to enhance the user experie- (but in all seriousness, some strings have been improved/standardised and such)
+
+# v0.2.0 (2021-12-01)
+
 - Add support for kicking users (-kick)
@@ -4,0 +11,0 @@ - General fixes and improvements (less sub-dependencies :tada:)

package.json

 {
   "name": "termivolt",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A simple utility to interact with the Revolt API via the command line.",
@@ -8,3 +8,4 @@ "main": "src/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "prebuild": "rimraf dist",
+    "build": "tsc"
   },
@@ -31,3 +32,3 @@ "repository": {
     "chalk": "^5.0.0",
-    "revolt.js": "^5.1.0-alpha.10"
+    "revolt.js": "^5.2.7"
   },
@@ -37,5 +38,12 @@ "engines": {
   },
-  "bin": {
-    "termivolt": "src/index.js"
+  "bin": "dist/index.js",
+  "files": [
+    "dist/",
+    "CHANGELOG.md"
+  ],
+  "devDependencies": {
+    "@types/node": "^17.0.10",
+    "@types/ws": "^8.2.2",
+    "rimraf": "^3.0.2"
   }
 }

README.md

@@ -31,2 +31,11 @@ # Termivolt
 
+### Global arguments
+
+Aside from the help command, the following arguments are required for all commands:
+
+- `--user/--bot` determines whether the token is a bot or session token. These require different methods of authentication.
+- The token is provided as-is (i.e. as copied from Revolt). Bot tokens can be found in your bot settings page - to get session tokens, [follow this guide](https://infi.sh/post/revolt-tokens).
+
+In addtion, you can optionally specify a custom API URL (e.g. `https://api.myrevoltinstan.ce`). This should be the last argument and in quotes. **This is not required if you're using the official Revolt instance (`https://revolt.chat`).**
+
 ### Sending messages (-send)
@@ -36,24 +45,37 @@
 
-`termivolt -send <(--user/--bot)> <channel id (in quotes)> <message content (in quotes)>`
+`termivolt -send <(--user/--bot)> <token> <channel id (in quotes)> <message content (in quotes)> [custom API URL]`
 
 #### Arguments
 
-- `--user/--bot` determines whether the token is a bot or session token. These require different methods of authenticating. Session tokens are currently broken - a fix will be released in the future.
-- The token is provided as-is (i.e. as copied from Revolt). Bot tokens can be found in your bot settings page - to get session tokens, [follow this guide](https://infi.sh/post/revolt-tokens).
+In addtion to the required arguments:
+
 - The channel ID should be provided as a string (i.e. in quotes). You can find it in the URL when using Revite (the official Revolt client) or by right-clicking the channel's entry on the channel list and selecting "Copy channel ID".
 - The message itself should be fully encased in double quotes - if you want to use double quotes in the message itself, escape them with a backslash. Note that message formatting may be messed up in some cases - I'm still investigating as to why, but it seems backticks and \newlines break.
 
-### Kicking users (-send)
+### Kicking users (-kick)
 
-To kick members from servers with Termivolt, run `termivolt -send`. Note that you'll need the `Kick Members` permission - if you get a 403 error, this might be why. Here's the full list of arguments:
+To kick members from servers with Termivolt, run `termivolt -kick`. Note that you'll need the `Kick Members` permission - if you get a 403 error, this might be why. Here's the full list of arguments:
 
-`termivolt -kick <(--user/--bot)> <server id (in quotes)> <user id (in quotes)>`
+`termivolt -kick <(--user/--bot)> <token> <server id (in quotes)> <user id (in quotes)> [custom API URL]`
 
 #### Arguments
 
-- `--user/--bot` determines whether the token is a bot or session token. These require different methods of authenticating. Session tokens are currently broken - a fix will be released in the future.
-- The token is provided as-is (i.e. as copied from Revolt). Bot tokens can be found in your bot settings page - to get session tokens, [follow this guide](https://infi.sh/post/revolt-tokens).
+In addtion to the required arguments:
+
 - The server ID should be provided as a string (i.e. in quotes). You can find it in the URL when using Revite (the official Revolt client) or by right-clicking the server's entry on the server list and selecting "Copy server ID".
 - The user ID should aslo be provided as a string.
 
+### Banning users (-ban)
+
+To ban members from servers with Termivolt, run `termivolt -ban`. Note that you'll need the `Ban Members` permission - if you get a 403 error, this might be why. Here's the full list of arguments:
+
+`termivolt -ban <(--user/--bot)> <token> <server id (in quotes)> <user id (in quotes)> [custom API URL]`
+
+#### Arguments
+
+In addtion to the required arguments:
+
+- The server ID should be provided as a string (i.e. in quotes). You can find it in the URL when using Revite (the official Revolt client) or by right-clicking the server's entry on the server list and selecting "Copy server ID".
+- The user ID should aslo be provided as a string.
+
 ### Help (-help)
@@ -60,0 +82,0 @@

New alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

86

increased by34.38%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

6686

decreased by-71.8%

Dev dependency count

3

increased byInfinity%

Number of package files

4

decreased by-63.64%

Lines of code

0

decreased by-100%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• Updatedrevolt.js@^5.2.7