diff --git a/.npmignore b/.npmignore
index 290f8e5..d9da6cb 100644
--- a/.npmignore
+++ b/.npmignore
@@ -52,6 +52,7 @@ typings/
.node_repl_history
# Output of 'npm pack'
+
*.tgz
# Yarn Integrity file
@@ -108,6 +109,8 @@ tsup.config.js
tsconfig-base.json
-tsconfig.cjs.json
+tsconfig-cjs.json
-tsconfig.esm.json
\ No newline at end of file
+tsconfig-esm.json
+
+renovate.json
diff --git a/README.md b/README.md
index 4b2150e..1feb58f 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@
## Why?
- Most handlers don't support discord.js 14.7+
-- Customizable commands
+- Customizable, composable commands
- Plug and play or customize to your liking
- Embraces reactive programming for consistent and reliable backend
- Customizable logger, error handling, and more
@@ -44,27 +44,54 @@ pnpm add @sern/handler
```
## 👶 Basic Usage
+ping.ts
-#### ` index.js (CommonJS)`
-
-```js
-// Import the discord.js Client and GatewayIntentBits
-const { Client, GatewayIntentBits } = require('discord.js');
-
-// Import Sern namespace
-const { Sern, single } = require('@sern/handler');
-
-const client = new Client({
- intents: [
- GatewayIntentBits.Guilds,
- GatewayIntentBits.GuildMembers,
- GatewayIntentBits.GuildMessages
- ]
+```ts
+export default commandModule({
+ type: CommandType.Slash,
+ //Installed plugin to publish to discord api and allow access to owners only.
+ plugins: [publish(), ownerOnly()],
+ description: 'A ping pong command',
+ execute(ctx) {
+ ctx.reply('Hello owner of the bot');
+ }
});
-export const useContainer = Sern.makeDependencies({
+```
+modal.ts
+
+```ts
+export default commandModule({
+ type: CommandType.Modal,
+ //Installed a plugin to make sure modal fields pass a validation.
+ plugins : [
+ assertFields({
+ fields: {
+ name: /^([^0-9]*)$/
+ },
+ failure: (errors, modal) => modal.reply('your submission did not pass the validations')
+ })
+ ],
+ execute : (modal) => {
+ modal.reply('thanks for the submission!');
+ }
+})
+```
+index.ts
+
+```ts
+import { Client, GatewayIntentBits } from 'discord.js';
+import { Sern, single, type Dependencies } from '@sern/handler';
+
+//client has been declared previously
+
+interface MyDependencies extends Dependencies {
+ '@sern/client': Singleton;
+}
+export const useContainer = Sern.makeDependencies({
build: root => root
.add({ '@sern/client': single(() => client) })
- .upsert({ '@sern/logger': single(() => new DefaultLogging()) })
});
//View docs for all options
@@ -73,26 +100,13 @@ Sern.init({
commands: 'src/commands',
// events: 'src/events' (optional),
containerConfig : {
- get: useContainer
+ get: useContainer
}
});
client.login("YOUR_BOT_TOKEN_HERE");
```
-
-#### ` ping.js (CommonJS)`
-
-```js
-const { CommandType, commandModule } = require('@sern/handler');
-
-exports.default = commandModule({
- type: CommandType.Slash,
- description: 'A ping pong command',
- execute(ctx) {
- ctx.reply('pong!');
- }
-});
-```
+