Skip to content

Commit e5637ef

Browse files
committed
docs: update commandkit readme
1 parent 3cdd9b7 commit e5637ef

4 files changed

Lines changed: 19 additions & 22 deletions

File tree

packages/commandkit/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,21 @@ CommandKit is a library that makes it easy to handle commands and events in your
1515
## Features
1616

1717
- Beginner friendly 🚀
18-
- Slash + context menu commands support ✅
19-
- Multiple dev guilds, users, & roles support 🤝
20-
- Automatic command updates 🤖
21-
- REST registration behaviour 📍
22-
- Easy command line interface 🖥️
23-
- And much more! 🧪
18+
- Suitable for both beginners and advanced users 👶👨‍💻
19+
- Slash + context menu commands + prefix commands support ✅
20+
- Automatic command registration and updates 🤖
21+
- Command middlewares for easy command management 🛠️
22+
- Localization support through `@commandkit/i18n` plugin 🌍
23+
- Plugin system to extend functionality 🔌
24+
- Built-in command line interface for easy development 🖥️
25+
- Out-of-the-box support for TypeScript and JavaScript 📜
26+
- Built-in customizable cache system for speedy data storage and retrieval 🗄️
27+
- User installable/guild scoped commands 🔧
28+
- Custom events support 🔔
29+
- JSX support for declaring Discord interaction components and modals 🎨
30+
- Easy to use interaction components and modals system (forget about collectors) 🧩
31+
- Less boilerplate code, more productivity 💪
32+
- and much more...
2433

2534
## Documentation
2635

packages/commandkit/src/cli/information.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ export async function showInformation() {
8686
'@commandkit/redis',
8787
'@commandkit/legacy',
8888
'@commandkit/devtools',
89+
'@commandkit/i18n',
8990
];
9091

9192
const runtimeName: string = (() => {

packages/i18n/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@commandkit/i18n",
3-
"version": "0.1.1",
3+
"version": "0.1.2",
44
"description": "CommandKit plugin that adds command localizations backed by i18next",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",
@@ -36,4 +36,4 @@
3636
"tsconfig": "workspace:*",
3737
"typescript": "^5.7.3"
3838
}
39-
}
39+
}

packages/i18n/src/i18n.ts

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@ import {
1717
CommandSource,
1818
PreparedAppCommandExecution,
1919
CommandBuilderLike,
20-
PreRegisterCommandsEvent,
2120
CommandKitHMREvent,
2221
} from 'commandkit';
2322
import FsBackend from 'i18next-fs-backend';
2423
import { basename, extname, join } from 'path';
2524
import { FsBackendOptions } from 'i18next-fs-backend';
2625
import { Locale } from 'discord.js';
27-
import { existsSync, writeFileSync } from 'fs';
26+
import { existsSync } from 'fs';
2827
import { CommandTranslation, CommandTranslationMetadata } from './types';
2928
import { COMMAND_METADATA_KEY, DISCORD_LOCALES } from './constants';
3029
import { applyTranslations } from './utils';
@@ -315,16 +314,4 @@ export class I18nPlugin extends RuntimePlugin<LocalizationPluginOptions> {
315314

316315
return data;
317316
}
318-
319-
public async onBeforeRegisterCommands(
320-
ctx: CommandKitPluginRuntime,
321-
event: PreRegisterCommandsEvent,
322-
): Promise<void> {
323-
event.preventDefault();
324-
325-
writeFileSync(
326-
`./.commandkit/cmd.json`,
327-
JSON.stringify(event.commands, null, 2),
328-
);
329-
}
330317
}

0 commit comments

Comments
 (0)