@kubb/cli 1.1.3 → 1.1.4

package/dist/index.cjs

@@ -309,19 +309,74 @@ async function getCosmiConfig(moduleName2, config) {
   }
   return result;
 }
+var presets = {
+  simple: {
+    "kubb.config": `
+import { defineConfig } from '@kubb/core'
+import createSwagger from '@kubb/swagger'
+import createSwaggerTS from '@kubb/swagger-ts'
+import createSwaggerTanstackQuery from '@kubb/swagger-tanstack-query'
+
+export default defineConfig({
+  root: '.',
+  input: {
+    path: './petStore.yaml',
+  },
+  output: {
+    path: './src/gen',
+    clean: true,
+  },
+  hooks: {
+    done: 'eslint --fix ./src/gen',
+  },
+  logLevel: 'info',
+  plugins: [createSwagger({}), createSwaggerTS({ output: 'models', enumType: 'enum' }), createSwaggerTanstackQuery({ output: './hooks' })],
+})
+  `,
+    packages: ["@kubb/core", "@kubb/cli", "@kubb/swagger", "@kubb/swagger-ts", "@kubb/swagger-tanstack-query"]
+  }
+};
+async function init({ spinner: spinner2, preset = "simple", logLevel = "silent", packageManager = "pnpm" }) {
+  try {
+    const presetMeta = presets[preset];
+    const path = pathParser__default.default.resolve(process.cwd(), "./kubb.config.js");
+    spinner2.start(`\u{1F4C0} Writing \`kubb.config.js\` ${pc__default.default.dim(path)}`);
+    await core.write(presetMeta["kubb.config"], path);
+    spinner2.succeed(`\u{1F4C0} Wrote \`kubb.config.js\` ${pc__default.default.dim(path)}`);
+    const data = await Promise.all(
+      presetMeta.packages.map(async (pack) => {
+        spinner2.start(`\u{1F4C0} Installing ${pc__default.default.dim(pack)}`);
+        const { stdout } = await execa.$({ preferLocal: false })`${packageManager} install ${pack}`;
+        spinner2.succeed(`\u{1F4C0} Installed ${pc__default.default.dim(pack)}`);
+        return stdout;
+      })
+    );
+    if (logLevel === "info") {
+      data.forEach((text) => console.log(text));
+    }
+  } catch (error) {
+    spinner2.fail(pc__default.default.red(`Something went wrong
+
+${error?.message}`));
+  }
+}
 
 // package.json
-var version = "1.1.3";
+var version = "1.1.4";
 
 // src/index.ts
 var moduleName = "kubb";
 var spinner = ora__default.default({
-  color: "blue",
-  text: pc__default.default.blue("\u{1F3CE}\uFE0F Kubb generation started"),
   spinner: "clock"
 }).start();
 var program = new commander.Command(moduleName).description("Kubb").action(async (options) => {
   try {
+    if (options.init) {
+      spinner.start("\u{1F4E6} Initializing Kubb");
+      await init({ spinner, logLevel: options.logLevel });
+      spinner.succeed(`\u{1F4E6} initialized Kubb`);
+      return;
+    }
     spinner.start("\u{1F4BE} Loading config");
     const result = await getCosmiConfig(moduleName, options.config);
     spinner.succeed(`\u{1F4BE} Config loaded(${pc__default.default.dim(pathParser__default.default.relative(process.cwd(), result.filepath))})`);
@@ -345,5 +400,5 @@ var program = new commander.Command(moduleName).description("Kubb").action(async
   } catch (e) {
     process.exit(1);
   }
-}).addOption(new commander.Option("-c, --config <path>", "Path to the Kubb config")).addOption(new commander.Option("-i, --input <path>", "Path of the input file(overrides the one in `kubb.config.js`)")).addOption(new commander.Option("-l, --logLevel <type>", "Type of the logging(overrides the one in `kubb.config.js`)").choices(["error", "info", "silent"])).addOption(new commander.Option("-d, --debug", "Debug mode").default(false)).addOption(new commander.Option("-w, --watch", "Watch mode based on the input file"));
+}).addOption(new commander.Option("-c, --config <path>", "Path to the Kubb config")).addOption(new commander.Option("-i, --input <path>", "Path of the input file(overrides the one in `kubb.config.js`)")).addOption(new commander.Option("-l, --logLevel <type>", "Type of the logging(overrides the one in `kubb.config.js`)").choices(["error", "info", "silent"])).addOption(new commander.Option("--init", "Init Kubb")).addOption(new commander.Option("-d, --debug", "Debug mode").default(false)).addOption(new commander.Option("-w, --watch", "Watch mode based on the input file"));
 program.name(moduleName).description("Generate").version(version, "-v").parse();

package/dist/index.js

@@ -4,10 +4,10 @@ import pathParser from 'node:path';
 import { Command, Option } from 'commander';
 import pc from 'picocolors';
 import ora from 'ora';
-import { execa } from 'execa';
+import { $, execa } from 'execa';
 import { parseArgsStringToArgv } from 'string-argv';
 import PrettyError from 'pretty-error';
-import { build, PluginError, ParallelPluginError, isPromise } from '@kubb/core';
+import { build, PluginError, ParallelPluginError, isPromise, write } from '@kubb/core';
 import { pathToFileURL } from 'node:url';
 import mod from 'node:module';
 import { cosmiconfig } from 'cosmiconfig';
@@ -298,19 +298,74 @@ async function getCosmiConfig(moduleName2, config) {
   }
   return result;
 }
+var presets = {
+  simple: {
+    "kubb.config": `
+import { defineConfig } from '@kubb/core'
+import createSwagger from '@kubb/swagger'
+import createSwaggerTS from '@kubb/swagger-ts'
+import createSwaggerTanstackQuery from '@kubb/swagger-tanstack-query'
+
+export default defineConfig({
+  root: '.',
+  input: {
+    path: './petStore.yaml',
+  },
+  output: {
+    path: './src/gen',
+    clean: true,
+  },
+  hooks: {
+    done: 'eslint --fix ./src/gen',
+  },
+  logLevel: 'info',
+  plugins: [createSwagger({}), createSwaggerTS({ output: 'models', enumType: 'enum' }), createSwaggerTanstackQuery({ output: './hooks' })],
+})
+  `,
+    packages: ["@kubb/core", "@kubb/cli", "@kubb/swagger", "@kubb/swagger-ts", "@kubb/swagger-tanstack-query"]
+  }
+};
+async function init({ spinner: spinner2, preset = "simple", logLevel = "silent", packageManager = "pnpm" }) {
+  try {
+    const presetMeta = presets[preset];
+    const path = pathParser.resolve(process.cwd(), "./kubb.config.js");
+    spinner2.start(`\u{1F4C0} Writing \`kubb.config.js\` ${pc.dim(path)}`);
+    await write(presetMeta["kubb.config"], path);
+    spinner2.succeed(`\u{1F4C0} Wrote \`kubb.config.js\` ${pc.dim(path)}`);
+    const data = await Promise.all(
+      presetMeta.packages.map(async (pack) => {
+        spinner2.start(`\u{1F4C0} Installing ${pc.dim(pack)}`);
+        const { stdout } = await $({ preferLocal: false })`${packageManager} install ${pack}`;
+        spinner2.succeed(`\u{1F4C0} Installed ${pc.dim(pack)}`);
+        return stdout;
+      })
+    );
+    if (logLevel === "info") {
+      data.forEach((text) => console.log(text));
+    }
+  } catch (error) {
+    spinner2.fail(pc.red(`Something went wrong
+
+${error?.message}`));
+  }
+}
 
 // package.json
-var version = "1.1.3";
+var version = "1.1.4";
 
 // src/index.ts
 var moduleName = "kubb";
 var spinner = ora({
-  color: "blue",
-  text: pc.blue("\u{1F3CE}\uFE0F Kubb generation started"),
   spinner: "clock"
 }).start();
 var program = new Command(moduleName).description("Kubb").action(async (options) => {
   try {
+    if (options.init) {
+      spinner.start("\u{1F4E6} Initializing Kubb");
+      await init({ spinner, logLevel: options.logLevel });
+      spinner.succeed(`\u{1F4E6} initialized Kubb`);
+      return;
+    }
     spinner.start("\u{1F4BE} Loading config");
     const result = await getCosmiConfig(moduleName, options.config);
     spinner.succeed(`\u{1F4BE} Config loaded(${pc.dim(pathParser.relative(process.cwd(), result.filepath))})`);
@@ -334,5 +389,5 @@ var program = new Command(moduleName).description("Kubb").action(async (options)
   } catch (e) {
     process.exit(1);
   }
-}).addOption(new Option("-c, --config <path>", "Path to the Kubb config")).addOption(new Option("-i, --input <path>", "Path of the input file(overrides the one in `kubb.config.js`)")).addOption(new Option("-l, --logLevel <type>", "Type of the logging(overrides the one in `kubb.config.js`)").choices(["error", "info", "silent"])).addOption(new Option("-d, --debug", "Debug mode").default(false)).addOption(new Option("-w, --watch", "Watch mode based on the input file"));
+}).addOption(new Option("-c, --config <path>", "Path to the Kubb config")).addOption(new Option("-i, --input <path>", "Path of the input file(overrides the one in `kubb.config.js`)")).addOption(new Option("-l, --logLevel <type>", "Type of the logging(overrides the one in `kubb.config.js`)").choices(["error", "info", "silent"])).addOption(new Option("--init", "Init Kubb")).addOption(new Option("-d, --debug", "Debug mode").default(false)).addOption(new Option("-w, --watch", "Watch mode based on the input file"));
 program.name(moduleName).description("Generate").version(version, "-v").parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/cli",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Generator cli",
   "repository": {
     "type": "git",
@@ -43,13 +43,13 @@
     "yaml": "^2.3.1",
     "@swc/core": "^1.3.62",
     "pretty-error": "^4.0.0",
-    "@kubb/core": "1.1.3"
+    "@kubb/core": "1.1.4"
   },
   "devDependencies": {
     "@types/node": "^20.2.5",
     "tsup": "^6.7.0",
     "typescript": "^5.1.3",
-    "@kubb/swagger": "1.1.3"
+    "@kubb/swagger": "1.1.4"
   },
   "publishConfig": {
     "access": "public",
@@ -66,8 +66,7 @@
     "pre-commit": "echo 'pre-commit not configured'",
     "pre-push": "pnpm typecheck",
     "test": "vitest --passWithNoTests",
-    "upgrade": "ncu -u",
-    "upgrade:local": "ncu --interactive --doctor",
+    "upgrade": "pnpm update",
     "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
   }
 }

package/src/index.ts

@@ -10,14 +10,13 @@ import type { CLIOptions } from '@kubb/core'
 
 import { run } from './run.ts'
 import { startWatcher, getConfig, getCosmiConfig } from './utils/index.ts'
+import { init } from './init.ts'
 
 import { version } from '../package.json'
 
 const moduleName = 'kubb'
 
 const spinner = ora({
-  color: 'blue',
-  text: pc.blue('🏎️ Kubb generation started'),
   spinner: 'clock',
 }).start()
 
@@ -25,6 +24,13 @@ const program = new Command(moduleName)
   .description('Kubb')
   .action(async (options: CLIOptions) => {
     try {
+      if (options.init) {
+        spinner.start('📦 Initializing Kubb')
+        await init({ spinner, logLevel: options.logLevel })
+        spinner.succeed(`📦 initialized Kubb`)
+        return
+      }
+
       // CONFIG
       spinner.start('💾 Loading config')
       const result = await getCosmiConfig(moduleName, options.config)
@@ -58,6 +64,7 @@ const program = new Command(moduleName)
   .addOption(new Option('-c, --config <path>', 'Path to the Kubb config'))
   .addOption(new Option('-i, --input <path>', 'Path of the input file(overrides the one in `kubb.config.js`)'))
   .addOption(new Option('-l, --logLevel <type>', 'Type of the logging(overrides the one in `kubb.config.js`)').choices(['error', 'info', 'silent']))
+  .addOption(new Option('--init', 'Init Kubb'))
   .addOption(new Option('-d, --debug', 'Debug mode').default(false))
   .addOption(new Option('-w, --watch', 'Watch mode based on the input file'))
 

package/src/init.ts

@@ -0,0 +1,88 @@
+import pathParser from 'node:path'
+import pc from 'picocolors'
+import { $ } from 'execa'
+
+import type { LogLevel } from '@kubb/core'
+import { write } from '@kubb/core'
+
+import type { Ora } from 'ora'
+
+export type Preset = 'simple'
+
+export type PackageManager = 'pnpm' | 'npm' | 'yarn'
+
+export type PresetMeta = {
+  'kubb.config': string
+  packages: string[]
+}
+
+type RunProps = {
+  spinner: Ora
+  /**
+   * @default `'silent'`
+   */
+  logLevel?: LogLevel
+  /**
+   * @default `'simple'`
+   */
+  preset?: Preset
+  /**
+   * @default `'pnpm'`
+   */
+  packageManager?: PackageManager
+}
+
+const presets: Record<Preset, PresetMeta> = {
+  simple: {
+    'kubb.config': `
+import { defineConfig } from '@kubb/core'
+import createSwagger from '@kubb/swagger'
+import createSwaggerTS from '@kubb/swagger-ts'
+import createSwaggerTanstackQuery from '@kubb/swagger-tanstack-query'
+
+export default defineConfig({
+  root: '.',
+  input: {
+    path: './petStore.yaml',
+  },
+  output: {
+    path: './src/gen',
+    clean: true,
+  },
+  hooks: {
+    done: 'eslint --fix ./src/gen',
+  },
+  logLevel: 'info',
+  plugins: [createSwagger({}), createSwaggerTS({ output: 'models', enumType: 'enum' }), createSwaggerTanstackQuery({ output: './hooks' })],
+})
+  `,
+    packages: ['@kubb/core', '@kubb/cli', '@kubb/swagger', '@kubb/swagger-ts', '@kubb/swagger-tanstack-query'],
+  },
+}
+
+export async function init({ spinner, preset = 'simple', logLevel = 'silent', packageManager = 'pnpm' }: RunProps): Promise<void> {
+  try {
+    const presetMeta = presets[preset]
+    const path = pathParser.resolve(process.cwd(), './kubb.config.js')
+
+    spinner.start(`📀 Writing \`kubb.config.js\` ${pc.dim(path)}`)
+    await write(presetMeta['kubb.config'], path)
+    spinner.succeed(`📀 Wrote \`kubb.config.js\` ${pc.dim(path)}`)
+
+    const data = await Promise.all(
+      presetMeta.packages.map(async (pack) => {
+        spinner.start(`📀 Installing ${pc.dim(pack)}`)
+        const { stdout } = await $({ preferLocal: false })`${packageManager} install ${pack}`
+        spinner.succeed(`📀 Installed ${pc.dim(pack)}`)
+
+        return stdout
+      })
+    )
+
+    if (logLevel === 'info') {
+      data.forEach((text) => console.log(text))
+    }
+  } catch (error) {
+    spinner.fail(pc.red(`Something went wrong\n\n${(error as Error)?.message}`))
+  }
+}