Allow AdonisJS configuration via Ace command (#115)

Author: itssimon

README.md

@@ -205,43 +205,26 @@ _Note:_ Apitally only works with H3 v2 and currently doesn't support nested apps
 
 ### AdonisJS
 
-This is an example of how to use the Apitally middleware with a AdonisJS application.
-For further instructions, see our
-[setup guide for AdonisJS](https://docs.apitally.io/frameworks/adonisjs).
-
-Create a configuration file at `config/apitally.ts`:
-
-```javascript
-import { defineConfig } from "apitally/adonisjs";
+You can use the built-in Ace command to set up Apitally in your AdonisJS application:
 
-const apitallyConfig = defineConfig({
-  clientId: "your-client-id",
-  env: "dev", // or "prod" etc.
-});
-
-export default apitallyConfig;
+```bash
+node ace add apitally
 ```
 
-Register the Apitally provider in your `adonisrc.ts` file:
+This command will automatically:
 
-```javascript
-export default defineConfig({
-  // ... existing code ...
-  providers: [
-    // ... existing providers ...
-    () => import("apitally/adonisjs/provider"),
-  ],
-});
-```
+- Create the configuration file at `config/apitally.ts`
+- Register the Apitally provider in `adonisrc.ts`
+- Add the Apitally middleware to your `start/kernel.ts` file
+- Add environment variables to `.env` and validation to `start/env.ts`
 
-Register the Apitally middleware in your `start/kernel.ts` file:
+After running the command, you'll need to:
 
-```javascript
-router.use([
-  () => import("apitally/adonisjs/middleware"),
-  // ... other middleware ...
-]);
-```
+- Set your `APITALLY_CLIENT_ID` in the `.env` file
+- Modify our exception handler in `app/exceptions/handler.ts` to capture validation and server errors in Apitally
+
+For further instructions, see our
+[setup guide for AdonisJS](https://docs.apitally.io/frameworks/adonisjs).
 
 ## Getting help
 

configure.ts

@@ -0,0 +1,35 @@
+/**
+ * Allows users to add Apitally to their AdonisJS application using the built-in Ace command.
+ */
+
+import type Configure from "@adonisjs/core/commands/configure";
+import { stubsRoot } from "./stubs/main.js";
+
+export async function configure(command: Configure) {
+  const codemods = await command.createCodemods();
+
+  await codemods.makeUsingStub(stubsRoot, "config/apitally.stub", {});
+
+  await codemods.registerMiddleware("router", [
+    {
+      path: "apitally/adonisjs/middleware",
+    },
+  ]);
+
+  await codemods.updateRcFile((rcFile) => {
+    rcFile.addProvider("apitally/adonisjs/provider");
+  });
+
+  await codemods.defineEnvVariables({
+    APITALLY_CLIENT_ID: "",
+    APITALLY_ENV: "dev",
+  });
+
+  await codemods.defineEnvValidations({
+    leadingComment: "Variables for configuring the apitally package",
+    variables: {
+      APITALLY_CLIENT_ID: "Env.schema.string()",
+      APITALLY_ENV: "Env.schema.string.optional()",
+    },
+  });
+}

package.json

@@ -42,8 +42,10 @@
   },
   "files": [
     "dist/",
-    "README.md",
-    "LICENSE"
+    "stubs/",
+    "configure.ts",
+    "LICENSE",
+    "README.md"
   ],
   "exports": {
     "./adonisjs": {

stubs/config/apitally.stub

@@ -0,0 +1,15 @@
+{{{
+  exports({
+    to: app.configPath('apitally.ts')
+  })
+}}}
+import env from '#start/env'
+import app from '@adonisjs/core/services/app'
+import { defineConfig } from 'apitally/adonisjs'
+
+const apitallyConfig = defineConfig({
+  clientId: env.get('APITALLY_CLIENT_ID'),
+  env: env.get('APITALLY_ENV', app.inProduction ? 'prod' : 'dev'),
+})
+
+export default apitallyConfig

stubs/main.ts

@@ -0,0 +1,3 @@
+import { getDirname } from "@adonisjs/core/helpers";
+
+export const stubsRoot = getDirname(import.meta.url);