Simply put, to give flexibility to the developers. I believe that you should build your own structures however you might like and customize to your liking. In addition, **decorators now unofficially work with modules!** -Feel free to use TypeScript experimental decorators to augment and customize your classes. +Feel free to use TypeScript experimental decorators to augment and customize your classes. ### Deprecation Warnings - The next update will bring sern v2 with some important features. Here are some things to watch out for. - [Wrapper#client](docs/api/interfaces/Wrapper) will be deprecated @@ -81,6 +75,5 @@ The next update will bring sern v2 with some important features. Here are some t - [Sern#addExternal](docs/api/classes/SernEmitter) will be deprecated in favor of a better way. ### Dependencies Update - - TypeScript has been updated to 4.8.3 - Discord.js has been upgraded to 14.5 diff --git a/src/content/docs/blog/2022-09-30.md b/blog/2022-09-30-mdx-blog-post.md similarity index 91% rename from src/content/docs/blog/2022-09-30.md rename to blog/2022-09-30-mdx-blog-post.md index cf9340863..1d7aad5a5 100644 --- a/src/content/docs/blog/2022-09-30.md +++ b/blog/2022-09-30-mdx-blog-post.md @@ -1,9 +1,8 @@ --- -slug: blog/getting-started +slug: getting-started title: How to get started with sern! -authors: [ethan] +authors: [Sr Izan] tags: [guides] -date: 2022-09-30 --- ## Hello everyone! @@ -15,17 +14,13 @@ Today I'm going to show you how to get started with sern and all its cool featur ### Step 1: Install the CLI. Install the CLI: - ``` npm i -g @sern/cli ``` - and then run - ``` sern init ``` - :::tip You can also run `sern init -y` if you want to use the default options. ::: @@ -55,14 +50,13 @@ Yes, that's it. Here's a little FAQ to get you started. You can also join the [D ## FAQ **Q**: How do I publish a slash command? -**A**: Install the publish extension. Little video: - +**A**: Install the publish extension. Little video: **Q**: Any snippet VSCode extension? -**A**: Yeah, just search `sern Snippets` made by a verified publisher called Sr Izan (haha yeah me funny!) +**A**: Yeah, just search `sern Snippets` made by a verified publisher called Sr Izan (haha yeah me funny!) **Q**: HEEEELLLPPPP!!!! **A**: Hey, don't panic! We're here to help so, join the [Discord](https://sern.dev/discord). We're trying to get to 100 members! diff --git a/src/content/docs/blog/2022-12-13.md b/blog/2022-12-13-mdx-blog-post.md similarity index 68% rename from src/content/docs/blog/2022-12-13.md rename to blog/2022-12-13-mdx-blog-post.md index f092564b9..30588296d 100644 --- a/src/content/docs/blog/2022-12-13.md +++ b/blog/2022-12-13-mdx-blog-post.md @@ -1,51 +1,45 @@ --- -slug: blog/2.0.0 +slug: 2.0.0 title: Release 2.0.0 authors: [jacoobes] tags: [release] -date: 2022-12-13 --- ## 2.0 Release - Join our [discord](https://sern.dev/discord)!
Wow! We're finally increasing our semantic versioning by +`1.7.9.`
What does this mean? ### Plugin Support for Event Modules - -You can now use plugins for event modules. Previous version would throw an error if the +You can now use plugins for event modules. Previous version would throw an error if the `plugins` field was populated. -```typescript -export function commandPlTest(): SernEmitterPlugin { - return { - type: PluginType.Command, - execute: ({ mod }, controller) => { - if (mod.name === "module.register") { - console.log("Event Module created correctly"); - return controller.next(); - } - console.log("event name is wrong"); - return controller.stop(); - }, - }; +```typescript +export function commandPlTest() : SernEmitterPlugin { + return { + type: PluginType.Command, + execute: ({ mod}, controller) => { + if(mod.name === 'module.register') { + console.log('Event Module created correctly') + return controller.next() + } + console.log('event name is wrong') + return controller.stop() + } + } } ``` - -Applying this plugin to some `eventModule`: - +Applying this plugin to some `eventModule`: ```typescript export default eventModule({ - name: "error", - type: EventType.Sern, - plugins: [commandPlTest()], - execute(m) { - console.log(m); - }, -}); + name: 'error', + type: EventType.Sern, + plugins: [commandPlTest()], + execute(m) { + console.log(m) + }, +}) ``` - ## Dependency Injection and Decoupling The powerful npm package `iti` decouples sern even more. @@ -53,63 +47,57 @@ Decoupling data structures with the Inversion of Control pattern separates data and make sern even more customizable than before. ### How do I start? - ```typescript title="src/index.ts" //With typescript, you can customize / augment your typings. interface MyDependencies extends Dependencies { - "@sern/client": Singleton
Post 2.0: @@ -149,14 +131,12 @@ Post 2.0:
CommandPlugin
All deprecation warnings from previous versions have taken effect, and are removed in 2.0. -```diff lang="ts" showLineNumbers=false +```diff - type Module = EventModule | CommandModule + type AnyModule = EventModule | CommandModule @@ -164,9 +144,7 @@ All deprecation warnings from previous versions have taken effect, and are remov - args: Parameters
- - Thank you for using sern in your projects. It's only going to get better! - I apologize for the sudden small breaking change. After this update, there won't be any for a while. - Wow! We're increasing our semantic versioning by `+0.3.9`
- What does this mean? - +Wow! We're increasing our semantic versioning by `+0.3.9`
+What does this mean? ### Breaking changes - - [controller](../docs/api/modules#controller) parameter for plugins has been removed - - You'll need to import it instead - - This **breaks** old [CommandPlugin](../docs/api/interfaces/CommandPlugin), but **not** old [EventPlugin](../docs/api/interfaces/EventPlugin) - + - You'll need to import it instead + - This **breaks** old [CommandPlugin](../docs/api/interfaces/CommandPlugin), but **not** old [EventPlugin](../docs/api/interfaces/EventPlugin) ### Deprecations - - [CommandPlugin](../docs/api/interfaces/CommandPlugin) and [EventPlugin](../docs/api/interfaces/EventPlugin) have been renamed [InitPlugin](../docs/api/interfaces/InitPlugin) and [ControlPlugin](../docs/api/interfaces/ControlPlugin) ### Reason - - The naming of plugins was getting too complex. For example, plugin naming evolved into CommandModuleCommandPlugin, CommandModuleEventPlugin and more. - I realize that this affects all plugins. I have updated all [plugins](https://github.com/sern-handler/awesome-plugins/pull/68) to match these changes - The old way of declaring plugins has been deprecated in favor of newer functions that facilitate and ease typings @@ -35,4 +28,4 @@ date: 2023-01-12 - [EventControlPlugin](../docs/api/modules#eventcontrolplugin) - [EventInitPlugin](../docs/api/modules#eventinitplugin) - [DiscordEventControlPlugin](../docs/api/modules#discordeventcontrolplugin) - This will probably be the last breaking change in a while. Thanks for using sern! + This will probably be the last breaking change in a while. Thanks for using sern! \ No newline at end of file diff --git a/src/content/docs/blog/2023-06-18.md b/blog/2023-06-18-mdx-blog-post.md similarity index 54% rename from src/content/docs/blog/2023-06-18.md rename to blog/2023-06-18-mdx-blog-post.md index e79b03db1..4bcbc5fcd 100644 --- a/src/content/docs/blog/2023-06-18.md +++ b/blog/2023-06-18-mdx-blog-post.md @@ -1,9 +1,8 @@ --- -slug: blog/3.0.0 +slug: 3.0.0 title: Release 3.0.0 authors: [jacoobes] tags: [release] -date: 2023-06-18 --- ## 3.0 Release @@ -13,22 +12,20 @@ date: 2023-06-18 ### Features #### Dependency Management - - `Service` API (recommended to use this over useContainer hooks) - - Dependencies type must be globally augmented in order for Services api to function properly + - Dependencies type must be globally augmented in order for Services api to function properly - new methods on ModuleManager - - getPublishableCommands() -- Init Hooks - - implement starting behavior for dependencies - - To enforce and type check this, use the `Initializable` type when making your Dependencies type! + - getPublishableCommands() +- Init Hooks + - implement starting behavior for dependencies + - To enforce and type check this, use the `Initializable` type when making your Dependencies type! - Emitter interface - - More generic interface to define any event emitter - - You can now swap out the SernEmitter with whatever emitter now. - -```ts + - More generic interface to define any event emitter + - You can now swap out the SernEmitter with whatever emitter now. +```ts class DatabaseService implements Init { //some hypothetical database - _pgsql : database() + _pgsql : database() async init() { await _pgsql.load() @@ -36,74 +33,70 @@ class DatabaseService implements Init { } -await makeDependencies({ +await makeDependencies({ build: root => root.add({ db: new DatabaseService() //will be init'ed automatically }) }) ``` - - new SernEmitter event `modulesLoaded` , which allows users to customize behavior after all modules are loaded! - ```ts + export default eventModule({ - name: "modulesLoaded", - type: EventType.Sern, - execute: () => { - console.log("All modules loaded"); - }, -}); + name: 'modulesLoaded', + type: EventType.Sern, + execute: () => { + console.log('All modules loaded') + } +}) + + ``` #### Quality of Life - - faster module loading - - I utilize async generators for reading files now. A lot faster than the first iteration. + - I utilize async generators for reading files now. A lot faster than the first iteration. - better error handling - Less boilerplate - - Services api cleans up v2 boilerplate + - Services api cleans up v2 boilerplate - class modules devex got upgraded and work better than before - automatically ignore any files not ending in (mts, cts, mjs, cjs, ts, js) - - - ignore commands and events with `!` prefix on filename or directory (ie: `!filename.ts` or `!directory` will be ignored by sern) + - ignore commands and events with `!` prefix on filename or directory (ie: `!filename.ts` or `!directory` will be ignored by sern) - `Service` API (recommended to use this over useContainer hooks) - - Dependencies type must be globally augmented in order for Services api to function properly + - Dependencies type must be globally augmented in order for Services api to function properly - Less boilerplate - new methods on ModuleManager - automatically ignore any files not ending in (mts, cts, mjs, cjs, ts, js) - - ignore commands / events with `!` prefix on filename or directory (ie: `!filename.ts` or `!directory`) + - ignore commands / events with `!` prefix on filename or directory (ie: `!filename.ts` or `!directory`) - new SernEmitter event `modulesLoaded` , which allows users to customize behavior after all modules are loaded! -- Init Hooks - - implement starting behavior for dependencies +- Init Hooks + - implement starting behavior for dependencies ### Experimental - - Experimental things may be subject to removal, need feedback and are not guaranteed stable -- dev / prod mode - - sern will behave differently depending on mode set +- dev / prod mode + - sern will behave differently depending on mode set - init sern from `file` option - - reads from local sern.config.json + - reads from local sern.config.json -```js -Sern.init("file"); +```js +Sern.init('file'); ``` - ### Breaking changes - - Sern.makeDependencies -> makeDependencies - - it is asynchronous and top level function now. Make sure to await it before initing for proper synchronization. -- module store and manager internally changed, so those using them may recieve breaking changes + - it is asynchronous and top level function now. Make sure to await it before initing for proper synchronization. +- module store and manager internally changed, so those using them may recieve breaking changes - BaseOptions type removed -```diff lang="ts" showLineNumbers=false +```diff - Sern.makeDependencies({ build: () => {} }) + await makeDependencies({ build: () => {} }) ``` ### Deprecations - - Removed all previous marked deprecations in v3 - ModuleStore will be removed as a dependency in v4. The only way to access modules should be through ModuleManager - Default Dependencies will be made internal in the v4. Users should only have access to its interface / contract + diff --git a/src/content/docs/blog/2023-7-4.md b/blog/2023-7-4-mdx-blog-post.md similarity index 86% rename from src/content/docs/blog/2023-7-4.md rename to blog/2023-7-4-mdx-blog-post.md index 7873cbdb8..0288cc5b2 100644 --- a/src/content/docs/blog/2023-7-4.md +++ b/blog/2023-7-4-mdx-blog-post.md @@ -1,9 +1,8 @@ --- -slug: blog/new-logo +slug: newlogo title: New logo! authors: [sern] tags: [branding] -date: 2023-07-04 --- Hey everyone! Today we have very special news for you all: We're changing our logo! @@ -18,11 +17,11 @@ And here we are! [Ropox](https://github.com/Murtatrxx)! Bro's the GOAT. This website is maintained by him, the domain costs are funded by him and also he started brainstorming how the logo would be on paper: - + And there it all clicked: - + seren tried by the way! - + # Anyways, here it is: @@ -32,4 +31,4 @@ Pretty nice! By the way, we have animations and variations on the way, so make sure to stay updated in the [discord server](https://sern.dev/discord)! -# Finally, from the entire sern team, thank you for sticking around ❤️ +# Finally, from the entire sern team, thank you for sticking around ❤️ \ No newline at end of file diff --git a/src/content/docs/blog/2024-02-23.md b/blog/2024-02-23-mdx-blog-post.md similarity index 97% rename from src/content/docs/blog/2024-02-23.md rename to blog/2024-02-23-mdx-blog-post.md index b8f3842dd..c163a56b6 100644 --- a/src/content/docs/blog/2024-02-23.md +++ b/blog/2024-02-23-mdx-blog-post.md @@ -1,9 +1,8 @@ --- -slug: blog/railway-deploy +slug: railway-deploy title: Deploying sern with Railway -authors: [duro] +authors: [Duro] tags: [guides] -date: 2024-02-23 --- In this guide, I'll be showing you how to deploy your sern bot with [Railway](https://railway.app/). diff --git a/blog/authors.yml b/blog/authors.yml new file mode 100644 index 000000000..c522ede2d --- /dev/null +++ b/blog/authors.yml @@ -0,0 +1,24 @@ +jacoobes: + name: jacoobes + title: Head Dev + url: https://github.com/jacoobes + image_url: https://github.com/jacoobes.png +Sr Izan: + name: Sr Izan + title: Developer + url: https://github.com/SrIzan10 + image_url: https://github.com/SrIzan10.png +sern: + name: sern Team + url: https://github.com/sern-handler + image_url: https://github.com/sernbot.png +Murtatrxx: + name: Murtatrxx + title: Developer + url: https://github.com/Murtatrxx + image_url: https://github.com/Murtatrxx.png +Duro: + name: Duro + title: Developer + url: https://github.com/DuroCodes + image_url: https://github.com/DuroCodes.png diff --git a/bun.lockb b/bun.lockb deleted file mode 100755 index b3bfc5c516805829baae2dd6591824638c4dab8d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 282300 zcmeF430zHW^zV-((VP+ysmPR~WNwm>6seG;=`?5_H5f7`Q^}Yzr6QS$5Sc0>v%E>> zvB*4=yH