Kubb@kubb/core 🦙 ​
The core contains the building blocks for all plugins.
Features ​
- Read and write to the file-system(Windows, Mac and Linux support).
- Format code/source with Prettier.
- Types needed to create a plugin and the types needed for the lifecycle/pluginManager.
- Basic utilities as
isPromise,isURL,createJSDocBlockText,cache, ... createPluginfunctionality to setup a plugin.defineConfigfunctionality to setup thekubb.config.jsfile.- Abstract classes for plugins
Generatorwhich contains the base with getter foroptionsand abuildfunction.SchemaGeneratorwhich is a layer on top ofGenerator.
- Managers classes as the base for all logic
FileManagerwhich is used to store all files before those are getting saved to the file-system.PluginManagerwhich contains the logic of when which plugin can be triggerd, see pluginManager.
Installation ​
shell
bun add @kubb/corebun add @kubb/coreshell
pnpm add @kubb/corepnpm add @kubb/coreshell
npm install @kubb/corenpm install @kubb/coreshell
yarn add @kubb/coreyarn add @kubb/coreUsage ​
Simple example ​
typescript
import { build } from '@kubb/core'
import type { File } from '@kubb/core'
const files: File[] = await build({ config })import { build } from '@kubb/core'
import type { File } from '@kubb/core'
const files: File[] = await build({ config })Advanced example ​
typescript
import { build } from '@kubb/core'
import type { BuildOptions, File } from '@kubb/core'
const spinner = ora({
color: 'blue',
text: pc.blue('Generating files'),
}).start()
const logger: BuildOptions['logger'] = {
log(message, logLevel) {
if (logLevel === 'error') {
spinner.fail(message)
}
spinner[logLevel](message)
},
spinner,
}
const files: File[] = await build({
config: {
...config,
root: config.root || process.cwd(),
},
mode: options.mode || 'development',
logger,
})import { build } from '@kubb/core'
import type { BuildOptions, File } from '@kubb/core'
const spinner = ora({
color: 'blue',
text: pc.blue('Generating files'),
}).start()
const logger: BuildOptions['logger'] = {
log(message, logLevel) {
if (logLevel === 'error') {
spinner.fail(message)
}
spinner[logLevel](message)
},
spinner,
}
const files: File[] = await build({
config: {
...config,
root: config.root || process.cwd(),
},
mode: options.mode || 'development',
logger,
})Start the build process based on a defined config(see UserConfig type). This will trigger the different plugins and their created lifecycle methods.