termivolt - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

CHANGELOG.md

@@ -0,5 +1,11 @@
+# v0.6.0 (2024-07-20)
+
+- **BREAKING**: v0.6.0 now requires Node v18 or later.
+- Added support for interactive uasge (`-interactive`).
+- Various improvements to the build process and other cleanup.
+
 # v0.5.0 (2022-03-12)
 
 - **BREAKING**: This is the first version of Termivolt to support Revolt v0.5.3+ - it will **not work** with older versions of Revolt.
-- Added support for archiving channels (`-archive`), fetching messages (`-fetch`) and removing memebrs from groups (`-rmfromgroup`).
+- Added support for archiving channels (`-archive`), fetching messages (`-fetch`) and removing members from groups (`-rmfromgroup`).
 - Various other minor improvements.
@@ -9,3 +15,3 @@
 
-- **BREAKING**: 0.4.1 requires Node 16.14.0 or higher. If you're using Node 12/14/older versions of Node 16, please use 0.3.4 instead.
+- **BREAKING**: v0.4.1 requires Node 16.14.0 or higher. If you're using Node 12/14/older versions of Node 16, please use 0.3.4 instead.
 - Fixed a few more issues - the library should now be useable again. Apologies for the prior issues!
@@ -12,0 +18,0 @@

package.json

 {
   "name": "termivolt",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "A simple utility to interact with the Revolt API via the command line.",
-  "main": "dist/src/index.js",
+  "main": "dist/index.cjs",
   "type": "module",
   "scripts": {
-    "prebuild": "rimraf dist",
-    "build": "tsc"
+    "bundle": "esbuild --bundle src/index.ts --outfile=dist/index.cjs --minify --sourcemap --platform=node --format=cjs",
+    "build": "yarn bundle && yarn injectData",
+    "injectData": "node scripts/versionInjector.js"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/rexovolt/termivolt.git"
+    "url": "git+https://github.com/rexovolt/november.git"
   },
@@ -24,25 +25,29 @@ "keywords": [
   },
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
-    "url": "https://github.com/rexovolt/termivolt/issues"
+    "url": "https://github.com/rexovolt/november/issues"
   },
-  "homepage": "https://github.com/rexovolt/termivolt#readme",
-  "dependencies": {
-    "chalk": "^5.0.1",
-    "revchiver": "^0.5.3",
-    "revolt.js": "^6.0.2"
-  },
+  "homepage": "https://github.com/rexovolt/november/tree/main/packages/termivolt#readme",
   "engines": {
-    "node": "^12.13.0 || ^14.15.0 || >=16"
+    "node": ">=18"
   },
-  "bin": "dist/src/index.js",
+  "bin": {
+    "termivolt": "dist/index.cjs"
+  },
   "files": [
     "dist/",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
   ],
   "devDependencies": {
-    "@types/node": "^17.0.42",
+    "@types/inquirer": "^9.0.3",
+    "@types/node": "^20.14.11",
     "@types/ws": "^8.5.3",
-    "rimraf": "^3.0.2"
+    "chalk": "^5.0.1",
+    "esbuild": "^0.23.0",
+    "inquirer": "^9.1.4",
+    "revchiver": "^0.6.0",
+    "revolt.js": "^6.0.20"
   }
-}
+}

README.md

@@ -7,3 +7,3 @@ # Termivolt
 
-You can install Termivolt via the following methods:
+Termivolt requires Node v18 or later. You can install Termivolt via the following methods:
 
@@ -28,2 +28,14 @@ ### npm
 
+## Development
+
+Make sure you've got Node and Corepack set up.
+
+Clone the repository, then open the project folder and run the following commands:
+
+```bash
+yarn install
+yarn build
+npm link
+```
+
 ## Usage
@@ -40,4 +52,10 @@
 
-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`).**
+In addition, 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`).**
 
+### Interactive usage (-interactive)
+
+Termivolt can be used interactively, allowing you to quickly view and send messages. To do so, run `termivolt -interactive`. Here's the full list of arguments:
+
+`termivolt -interactive <(--user/--bot)> <token> [custom API URL]`
+
 ### Sending messages (-send)
@@ -51,3 +69,3 @@
 
-In addtion to the required arguments:
+In addition to the required arguments:
 
@@ -57,2 +75,25 @@ - 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".
 
+### Use Termivolt as a TUI (-interactive)
+
+To use Termivolt as an interactive client, run `termivolt -interactive`. Here's the full list of arguments:
+
+`termivolt -interactive <(--user/--bot)> <token> [custom API URL]`
+
+#### Arguments
+
+Aside from the required arguments, this command does not take any extra arguments since, as the name suggests, it's designed for interactive use.
+
+### Fetching messages (-fetch)
+
+To fetch messages with Termivolt, run `termivolt -fetch`. Here's the full list of arguments:
+
+`termivolt -send <(--user/--bot)> <token> <channel id (in quotes)> [amount of messages to send] [custom API URL]`
+
+#### Arguments
+
+In addition 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".
+- If specified, the amount should be provided as a standard number - the maximum amount of messages you can fetch is 100, and the default is 10.
+
 ### Archiving messages (-archive)
@@ -66,3 +107,3 @@
 
-In addtion to the required arguments:
+In addition to the required arguments:
 
@@ -79,6 +120,6 @@ - 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".
 
-In addtion to the required arguments:
+In addition 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.
+- The user ID should also be provided as a string.
 
@@ -93,6 +134,6 @@ ### Banning users (-ban)
 
-In addtion to the required arguments:
+In addition 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.
+- The user ID should also be provided as a string.
 
@@ -107,6 +148,6 @@ ### Removing users from a group DM (-rmfromgroup)
 
-In addtion to the required arguments:
+In addition to the required arguments:
 
 - The group 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 groups's entry on the DM list and selecting "Copy server ID".
-- The user ID should aslo be provided as a string.
+- The user ID should also be provided as a string.
 
@@ -119,2 +160,2 @@ ### Help (-help)
 
-If you want to report a bug, suggest a feature or get help with using Termivolt, you can [open an issue](https://github.com/rexovolt/termivolt/issues/new) or join [Termivolt's support server](https://rvlt.gg/ra9dr2Rd) on Revolt.
+If you want to report a bug, suggest a feature or get help with using Termivolt, you can [open an issue](https://github.com/rexovolt/november/issues/new) or join [Termivolt's support server](https://rvlt.gg/ra9dr2Rd) on Revolt.

New alerts

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

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5156988

increased by14414.87%

Dependency count

0

decreased by-100%

Number of low license alerts

0

decreased by-100%

Lines of code

4724

increased by829.92%

Number of lines in readme file

152

increased by36.94%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

8

increased by166.67%

Number of package files

6

decreased by-80.65%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removedchalk@^5.0.1

• - Removedrevchiver@^0.5.3

• - Removedrevolt.js@^6.0.2

• - Removed@fastify/busboy@2.1.1(transitive)

• - Removed@insertish/exponential-backoff@3.1.0-patch.2(transitive)

• - Removed@insertish/isomorphic-ws@4.0.1(transitive)

• - Removed@insertish/oapi@0.1.150.1.18(transitive)

• - Removedargparse@2.0.1(transitive)

• - Removedaxios@0.21.40.26.1(transitive)

• - Removedchalk@5.4.1(transitive)

• - Removedeventemitter3@4.0.7(transitive)

• - Removedfollow-redirects@1.15.9(transitive)

• - Removedglobalyzer@0.1.0(transitive)

• - Removedglobrex@0.1.2(transitive)

• - Removedjs-yaml@4.1.0(transitive)

• - Removedlodash.defaultsdeep@4.6.1(transitive)

• - Removedlodash.flatten@4.4.0(transitive)

• - Removedlodash.isequal@4.5.0(transitive)

• - Removedlong@5.3.0(transitive)

• - Removedmime@3.0.0(transitive)

• - Removedmobx@6.13.6(transitive)

• - Removedopenapi-typescript@5.4.2(transitive)

• - Removedprettier@2.8.8(transitive)

• - Removedrevchiver@0.5.4(transitive)

• - Removedrevolt-api@0.5.30.5.7(transitive)

• - Removedrevolt.js@6.0.06.0.20(transitive)

• - Removedtiny-glob@0.2.9(transitive)

• - Removedtypescript@4.9.5(transitive)

• - Removedulid@2.3.0(transitive)

• - Removedundici@5.28.5(transitive)

• - Removedws@8.18.0(transitive)

• - Removedyargs-parser@21.1.1(transitive)