Feat: defineConfig and default config for configure hook

package.json

@@ -25,6 +25,8 @@
 	"scripts": {
 		"prepare": "husky",
 		"build": "tsc",
+		"copy:templates": "cp -r src/stubs/ dist/src",
+		"postbuild": "pnpm run copy:templates",
 		"build:clean": "rm -rf ./dist && pnpm run build",
 		"format": "biome format --write ./",
 		"check-format": "biome check ./",

src/configure.ts

@@ -1,8 +1,14 @@
 import type Configure from '@adonisjs/core/commands/configure';
+import { STUBS_ROOT } from './stubs/index.js';
 
 export async function configure(command: Configure) {
 	const codemods = await command.createCodemods();
 
+	/**
+	 * Create openapi config file
+	 */
+	await codemods.makeUsingStub(STUBS_ROOT, 'config/openapi.stub', {});
+
 	/**
 	 * Register OpenapiServiceProvider to the rcfile
 	 */

src/define_config.ts

@@ -0,0 +1,5 @@
+import type { OpenAPIConfig } from './types/openapi.js';
+
+export function defineConfig(config: OpenAPIConfig): OpenAPIConfig {
+	return config;
+}

src/index.ts

@@ -1 +1,2 @@
 export { configure } from './configure.js';
+export { defineConfig } from './define_config.js';

src/stubs/config/openapi.stub

@@ -0,0 +1,13 @@
+{{{
+  exports({ to: app.configPath('openapi.ts') })
+}}}
+import { defineConfig } from 'adonis-openapi'
+
+const openapiConfig = defineConfig({
+	infos: {
+		title: 'My AdonisJs API',
+		version: '0.0.1',
+	},
+});
+
+export default openapiConfig

src/stubs/index.ts

@@ -0,0 +1,3 @@
+import { joinToURL } from '@poppinss/utils';
+
+export const STUBS_ROOT = joinToURL(import.meta.url, './');

src/types/openapi.ts

@@ -0,0 +1,5 @@
+import type { OpenAPIV3_1 } from 'openapi-types';
+
+export type OpenAPIConfig = {
+	infos: OpenAPIV3_1.InfoObject;
+};

tests/configure.test.ts

@@ -24,7 +24,10 @@ test.group('Configure', (group) => {
 
 		await command.exec();
 
+		await assert.fileExists('config/openapi.ts');
 		await assert.fileExists('adonisrc.ts');
+
+		await assert.fileContains('config/openapi.ts', 'defineConfig({');
 		await assert.fileContains('adonisrc.ts', 'adonis-openapi/openapi_provider');
 	}).disableTimeout();
 });

tests/openapi_provider.test.ts

@@ -1,10 +1,18 @@
 import { test } from '@japa/runner';
+import { defineConfig } from '../src/define_config.js';
 import OpenApiStore from '../src/features/openapi_store.js';
 import { createApp } from './test-utils/app.js';
 
 test.group('OpenAPI Provider', () => {
 	test('register openapi provider', async ({ assert }) => {
-		const app = await createApp();
+		const app = await createApp(
+			defineConfig({
+				infos: {
+					title: 'Test',
+					version: '1.0.0',
+				},
+			}),
+		);
 		assert.instanceOf(await app.container.make('openapi.store'), OpenApiStore);
 	});
 

tests/test-utils/app.ts

@@ -1,5 +1,6 @@
 import { IgnitorFactory } from '@adonisjs/core/factories';
 import { BASE_URL } from '../../bin/test.js';
+import type { OpenAPIConfig } from '../../src/types/openapi.js';
 
 const IMPORTER = (filePath: string) => {
 	if (filePath.startsWith('./') || filePath.startsWith('../')) {
@@ -8,7 +9,7 @@ const IMPORTER = (filePath: string) => {
 	return import(filePath);
 };
 
-export const createApp = async () => {
+export const createApp = async (openapiConfig?: OpenAPIConfig) => {
 	const ignitor = new IgnitorFactory()
 		.merge({
 			rcFileContents: {
@@ -17,6 +18,11 @@ export const createApp = async () => {
 		})
 		.withCoreConfig()
 		.withCoreProviders()
+		.merge({
+			config: {
+				openapi: openapiConfig,
+			},
+		})
 		.create(BASE_URL, { importer: IMPORTER });
 
 	const app = ignitor.createApp('web');