feat: cli templates api

Author: twlite

apps/test-bot/package.json

@@ -10,15 +10,15 @@
     "node": "node"
   },
   "dependencies": {
-    "commandkit": "workspace:*",
     "@commandkit/cache": "workspace:*",
     "@commandkit/devtools": "workspace:*",
     "@commandkit/i18n": "workspace:*",
     "@commandkit/legacy": "workspace:*",
+    "commandkit": "workspace:*",
     "discord.js": "^14.19.1",
     "dotenv": "^16.4.7"
   },
   "devDependencies": {
     "tsx": "^4.7.0"
   }
-}
+}

apps/test-bot/src/app/commands/(general)/help.ts

@@ -1,6 +1,6 @@
 import { CommandData, ChatInputCommand } from 'commandkit';
-import { redEmbedColor } from '../../../feature-flags/red-embed-color';
-import { Colors, MessageFlags } from 'discord.js';
+import { redEmbedColor } from '@/feature-flags/red-embed-color';
+import { Colors } from 'discord.js';
 
 export const command: CommandData = {
   name: 'help',

apps/test-bot/tsconfig.json

@@ -14,7 +14,11 @@
     "alwaysStrict": false,
     "checkJs": false,
     "strict": true,
-    "strictNullChecks": true
+    "strictNullChecks": true,
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
   },
   "include": ["src", "commandkit.config.ts", "commandkit-env.d.ts"]
 }

apps/website/docs/api-reference/classes/CompilerPluginRuntime.mdx

@@ -31,7 +31,7 @@ new CompilerPluginRuntime(plugins)
 
 
 - [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/plugins/plugin-runtime/CompilerPluginRuntime.ts#L148)
-### public toEsbuildPlugin(): \{
+### public toJSON(): \{
   name | : [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ;
   setup | : (
   build: Setup

apps/website/docs/guide/01-getting-started/04-commandkit-config.mdx

@@ -41,17 +41,17 @@ export default defineConfig({
 });
 ```
 
-### ESBuild Plugins
+### Rolldown Plugins
 
-Customize your build process with esbuild plugins:
+Customize your build process with rolldown plugins:
 
 ```ts title="commandkit.config.ts"
 import { defineConfig } from 'commandkit';
-import { someEsbuildPlugin } from 'some-esbuild-plugin';
+import { someRolldownPlugin } from 'some-rolldown-plugin';
 
 export default defineConfig({
-  esbuildPlugins: [
-    someEsbuildPlugin({
+  rolldownPlugins: [
+    someRolldownPlugin({
       // Plugin specific options
     }),
   ],
@@ -120,11 +120,11 @@ Here's a comprehensive configuration example:
 ```ts title="commandkit.config.ts"
 import { defineConfig } from 'commandkit';
 import { somePlugin } from '@commandkit/some-plugin';
-import { someEsbuildPlugin } from 'some-esbuild-plugin';
+import { someRolldownPlugin } from 'some-rolldown-plugin';
 
 export default defineConfig({
   plugins: [somePlugin()],
-  esbuildPlugins: [someEsbuildPlugin()],
+  rolldownPlugins: [someRolldownPlugin()],
   compilerOptions: {
     macro: {
       development: true,

apps/website/docs/guide/06-plugins/02-creating-a-compiler-plugin.mdx

@@ -7,16 +7,16 @@ CommandKit Compiler Plugins are a powerful way to extend the functionality of yo
 
 ## Creating a Compiler Plugin
 
-### Using esbuild plugins
+### Using rolldown plugins
 
-You can also use esbuild plugins as compiler plugins. This is useful if you want to use esbuild plugins to transform your source code.
+You can also use rolldown plugins as compiler plugins. This is useful if you want to use rolldown plugins to transform your source code.
 
 ```ts title="commandkit.config.ts"
 import { defineConfig } from 'commandkit';
-import { someEsbuildPlugin } from 'some-esbuild-plugin';
+import { someRolldownPlugin } from 'some-rolldown-plugin';
 
 export default defineConfig({
-  esbuildPlugins: [someEsbuildPlugin()],
+  rolldownPlugins: [someRolldownPlugin()],
 });
 ```
 
@@ -76,3 +76,43 @@ export class MyPlugin extends CompilerPlugin {
   }
 }
 ```
+
+## Extending commandkit templates
+
+CommandKit templates are a way to autogenerate files and other contents through `commandkit create` command. CommandKit by default comes with `command` and `event` templates. Compiler plugins can register custom templates to be used by the `commandkit create` command.
+
+```ts title="my-plugin.ts"
+import { CompilerPlugin, CompilerPluginRuntime } from 'commandkit';
+
+export class MyPlugin extends CompilerPlugin {
+  public readonly name = 'my-plugin';
+
+  public async activate(ctx: CompilerPluginRuntime): Promise<void> {
+    // Registers `commandkit create event <name> <path>` template
+    ctx.registerTemplate('event', async (args: string[]) => {
+      const [name, path] = args;
+
+      const template = `
+      export default async function on${name[0].toUpperCase() + name.slice(1)}() {
+        console.log('${name} event fired!');
+      };
+      `.trim();
+
+      await writeFile(join(path, 'event.ts'), template);
+    });
+  }
+
+  public async deactivate(ctx: CompilerPluginRuntime): Promise<void> {
+    // remove the template from the registry when the plugin is deactivated
+    ctx.unregisterTemplate('event');
+  }
+}
+```
+
+:::warning
+The `registerTemplate` method must be called inside the `activate` method, and the `unregisterTemplate` method must be called inside the `deactivate` method.
+:::
+
+:::info
+Plugins may override the default templates by registering their own templates with the same name.
+:::

package.json

@@ -59,4 +59,4 @@
       "vite@>=6.2.0 <6.2.6": ">=6.2.6"
     }
   }
-}
+}

packages/commandkit/cache.cjs

@@ -0,0 +1,13 @@
+const {
+  cacheTag,
+  cacheLife,
+  invalidate,
+  revalidate,
+} = require('@commandkit/cache');
+
+module.exports = {
+  cacheTag,
+  cacheLife,
+  invalidate,
+  revalidate,
+};

packages/commandkit/cache.d.ts

@@ -0,0 +1 @@
+export { cacheTag, cacheLife, invalidate, revalidate } from '@commandkit/cache';

packages/commandkit/config.cjs

@@ -1,5 +1,5 @@
 const { defineConfig } = require('./dist/config/config.js');
 
 module.exports = {
-    defineConfig,
+  defineConfig,
 };