@kubb/core 1.1.6 → 1.1.8

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "@kubb/core",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "description": "Generator core",
+  "keywords": [
+    "typescript",
+    "plugins",
+    "kubb",
+    "codegen"
+  ],
   "repository": {
     "type": "git",
     "url": "git://github.com/kubb-project/kubb.git",
@@ -9,17 +15,8 @@
   },
   "license": "MIT",
   "author": "Stijn Van Hulle <stijn@stijnvanhulle.be",
-  "keywords": [
-    "typescript",
-    "plugins",
-    "kubb",
-    "codegen"
-  ],
   "sideEffects": false,
   "type": "module",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -29,6 +26,9 @@
     },
     "./package.json": "./package.json"
   },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {}
   },
@@ -43,29 +43,35 @@
     "change-case": "^4.1.2",
     "directory-tree": "^3.5.1",
     "rimraf": "^5.0.1",
-    "@kubb/ts-codegen": "1.1.6"
+    "@kubb/ts-codegen": "1.1.8"
   },
   "devDependencies": {
-    "tsup": "^6.7.0",
+    "eslint": "^8.42.0",
     "ora": "^6.3.1",
-    "typescript": "^5.1.3"
+    "tsup": "^6.7.0",
+    "typescript": "^5.1.3",
+    "@kubb/eslint-config": "0.1.0",
+    "@kubb/tsup-config": "0.1.0",
+    "@kubb/typescript-config": "0.1.0"
+  },
+  "packageManager": "pnpm@8.3.0",
+  "engines": {
+    "node": ">=18",
+    "pnpm": ">=8.3.0"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "engines": {
-    "node": ">=18",
-    "pnpm": ">=8"
-  },
   "scripts": {
     "build": "tsup",
-    "start": "tsup --watch",
+    "clean": "rimraf ./dist",
+    "lint": "eslint \"**/*.{ts,tsx}\"",
+    "lint-fix": "eslint \"**/*.{ts,tsx}\" --quiet --fix",
     "release": "pnpm publish --no-git-check",
-    "pre-commit": "echo 'pre-commit not configured'",
-    "pre-push": "pnpm typecheck",
+    "start": "tsup --watch",
     "test": "vitest --passWithNoTests",
-    "upgrade": "pnpm update",
-    "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
+    "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false",
+    "upgrade": "pnpm update"
   }
 }

package/src/build.ts

@@ -1,14 +1,14 @@
 /* eslint-disable no-async-promise-executor */
+import { getFileSource } from './managers/fileManager/index.ts'
 import { PluginManager } from './managers/pluginManager/index.ts'
 import { clean, isURL, read } from './utils/index.ts'
-import { getFileSource } from './managers/fileManager/index.ts'
 import { isPromise } from './utils/isPromise.ts'
 
-import type { OnExecute } from './managers/pluginManager/index.ts'
+import type { Ora } from 'ora'
 import type { File } from './managers/fileManager/index.ts'
+import type { OnExecute } from './managers/pluginManager/index.ts'
+import type { BuildOutput, KubbPlugin, LogLevel, PluginContext, TransformResult } from './types.ts'
 import type { QueueTask } from './utils/index.ts'
-import type { PluginContext, TransformResult, LogLevel, KubbPlugin, BuildOutput } from './types.ts'
-import type { Ora } from 'ora'
 
 export type Logger = {
   log: (message: string, logLevel: LogLevel) => void
@@ -36,7 +36,7 @@ export async function build(options: BuildOptions): Promise<BuildOutput> {
       await read(config.input.path)
     }
   } catch (e: any) {
-    throw new Error('Cannot read file defined in `input.path` or set with --input in the CLI of your Kubb config', { cause: e })
+    throw new Error('Cannot read file/URL defined in `input.path` or set with --input in the CLI of your Kubb config', { cause: e })
   }
 
   if (config.output.clean) {

package/src/config.ts

@@ -1,4 +1,4 @@
-import type { MaybePromise, KubbUserConfig, CLIOptions } from './types.ts'
+import type { CLIOptions, KubbUserConfig, MaybePromise } from './types.ts'
 
 /**
  * Type helper to make it easier to use kubb.config.js

package/src/generators/SchemaGenerator.ts

@@ -1,4 +1,5 @@
 import { Generator } from './Generator.ts'
+
 /**
  * Abstract class that contains the building blocks for plugins to create their own SchemaGenerator
  */

package/src/managers/fileManager/FileManager.ts

@@ -1,9 +1,9 @@
 import crypto from 'node:crypto'
 
-import { write, read } from '../../utils/index.ts'
+import { read, write } from '../../utils/index.ts'
 
-import type { QueueTask, Queue } from '../../utils/index.ts'
-import type { CacheStore, UUID, Status, File } from './types.ts'
+import type { Queue, QueueTask } from '../../utils/index.ts'
+import type { CacheStore, File, Status, UUID } from './types.ts'
 
 export class FileManager {
   private cache: Map<CacheStore['id'], CacheStore> = new Map()

package/src/managers/fileManager/utils.ts

@@ -1,29 +1,31 @@
 import pathParser from 'node:path'
 
-import { createImportDeclaration, createExportDeclaration, print } from '@kubb/ts-codegen'
+import { createExportDeclaration, createImportDeclaration, print } from '@kubb/ts-codegen'
 
 import { TreeNode } from '../../utils/index.ts'
 
-import type { PathMode, TreeNodeOptions } from '../../utils/index.ts'
-import type { Path } from '../../types.ts'
 import type ts from 'typescript'
+import type { Path } from '../../types.ts'
+import type { PathMode, TreeNodeOptions } from '../../utils/index.ts'
 import type { File } from './types.ts'
 
-export function writeIndexes(root: string, options: TreeNodeOptions) {
-  const tree = TreeNode.build<{ type: PathMode; path: Path; name: string }>(root, { extensions: /\.ts/, ...options })
+type TreeNodeData = { type: PathMode; path: Path; name: string }
+
+export function writeIndexes(root: string, options: TreeNodeOptions = {}): File[] | null {
+  const tree = TreeNode.build<TreeNodeData>(root, { extensions: /\.ts/, ...options })
 
   if (!tree) {
-    return undefined
+    return null
   }
 
-  const fileReducer = (files: File[], item: typeof tree) => {
-    if (!item.children) {
+  const fileReducer = (files: File[], currentTree: typeof tree) => {
+    if (!currentTree.children) {
       return []
     }
 
-    if (item.children?.length > 1) {
-      const path = pathParser.resolve(item.data.path, 'index.ts')
-      const exports = item.children
+    if (currentTree.children?.length > 1) {
+      const path = pathParser.resolve(currentTree.data.path, 'index.ts')
+      const exports = currentTree.children
         .map((file) => {
           if (!file) {
             return undefined
@@ -47,8 +49,8 @@ export function writeIndexes(root: string, options: TreeNodeOptions) {
         exports,
       })
     } else {
-      item.children?.forEach((child) => {
-        const path = pathParser.resolve(item.data.path, 'index.ts')
+      currentTree.children?.forEach((child) => {
+        const path = pathParser.resolve(currentTree.data.path, 'index.ts')
         const importPath = child.data.type === 'directory' ? `./${child.data.name}` : `./${child.data.name.replace(/\.[^.]*$/, '')}`
 
         files.push({
@@ -60,7 +62,7 @@ export function writeIndexes(root: string, options: TreeNodeOptions) {
       })
     }
 
-    item.children.forEach((childItem) => {
+    currentTree.children.forEach((childItem) => {
       fileReducer(files, childItem)
     })
 
@@ -72,11 +74,8 @@ export function writeIndexes(root: string, options: TreeNodeOptions) {
   return files
 }
 
-export function combineFiles(files: Array<File | null>) {
-  return files.filter(Boolean).reduce((acc, curr: File | null) => {
-    if (!curr) {
-      return acc
-    }
+export function combineFiles(files: Array<File | null>): File[] {
+  return (files.filter(Boolean) as File[]).reduce((acc, curr: File) => {
     const prevIndex = acc.findIndex((item) => item.path === curr.path)
 
     if (prevIndex !== -1) {
@@ -95,7 +94,7 @@ export function combineFiles(files: Array<File | null>) {
   }, [] as File[])
 }
 
-export function getFileSource(file: File) {
+export function getFileSource(file: File): string {
   let { source } = file
 
   // TODO make generic check
@@ -106,21 +105,22 @@ export function getFileSource(file: File) {
   const exports: File['exports'] = []
 
   file.imports?.forEach((curr) => {
-    const exists = imports.find((imp) => imp.path === curr.path)
-    if (!exists) {
+    const existingImport = imports.find((imp) => imp.path === curr.path)
+
+    if (!existingImport) {
       imports.push({
         ...curr,
         name: Array.isArray(curr.name) ? [...new Set(curr.name)] : curr.name,
       })
     }
 
-    if (exists && !Array.isArray(exists.name) && exists.name !== curr.name) {
+    if (existingImport && !Array.isArray(existingImport.name) && existingImport.name !== curr.name) {
       imports.push(curr)
     }
 
-    if (exists && Array.isArray(exists.name)) {
+    if (existingImport && Array.isArray(existingImport.name)) {
       if (Array.isArray(curr.name)) {
-        exists.name = [...new Set([...exists.name, ...curr.name])]
+        existingImport.name = [...new Set([...existingImport.name, ...curr.name])]
       }
     }
   })
@@ -151,7 +151,7 @@ export function getFileSource(file: File) {
   const importSource = print(importNodes)
 
   const exportNodes = exports.reduce((prev, curr) => {
-    return [...prev, createExportDeclaration({ name: curr.name, path: curr.path, asAlias: curr.asAlias })]
+    return [...prev, createExportDeclaration({ name: curr.name, path: curr.path, isTypeOnly: curr.isTypeOnly, asAlias: curr.asAlias })]
   }, [] as ts.ExportDeclaration[])
   const exportSource = print(exportNodes)
 

package/src/managers/pluginManager/PluginManager.ts

@@ -2,18 +2,17 @@
 /* eslint-disable no-await-in-loop */
 /* eslint-disable no-restricted-syntax */
 
-import { PluginError } from './PluginError.ts'
-import { ParallelPluginError } from './ParallelPluginError.ts'
-
 import { definePlugin } from '../../plugin.ts'
-import { FileManager } from '../fileManager/FileManager.ts'
-import { Queue } from '../../utils/Queue.ts'
 import { isPromise } from '../../utils/isPromise.ts'
+import { Queue } from '../../utils/Queue.ts'
+import { FileManager } from '../fileManager/FileManager.ts'
+import { ParallelPluginError } from './ParallelPluginError.ts'
+import { PluginError } from './PluginError.ts'
 
-import type { QueueTask } from '../../utils/Queue.ts'
-import type { Argument0, Strategy, Executer, OnExecute, ParseResult, SafeParseResult } from './types.ts'
-import type { KubbConfig, KubbPlugin, PluginLifecycleHooks, PluginLifecycle, MaybePromise, ResolvePathParams, ResolveNameParams } from '../../types.ts'
 import type { CorePluginOptions } from '../../plugin.ts'
+import type { KubbConfig, KubbPlugin, MaybePromise, PluginLifecycle, PluginLifecycleHooks, ResolveNameParams, ResolvePathParams } from '../../types.ts'
+import type { QueueTask } from '../../utils/Queue.ts'
+import type { Argument0, Executer, OnExecute, ParseResult, SafeParseResult, Strategy } from './types.ts'
 
 // inspired by: https://github.com/rollup/rollup/blob/master/src/utils/PluginDriver.ts#
 
@@ -218,7 +217,7 @@ export class PluginManager {
         break
       }
     }
-    return parseResult as SafeParseResult<H>
+    return parseResult
   }
 
   /**

package/src/managers/pluginManager/types.ts

@@ -1,5 +1,6 @@
-import type { PluginManager } from './PluginManager.ts'
 import type { KubbPlugin, PluginLifecycle, PluginLifecycleHooks } from '../../types.ts'
+import type { PluginManager } from './PluginManager.ts'
+
 /**
  * Get the type of the first argument in a function.
  * @example Arg0<(a: string, b: number) => void> -> string

package/src/plugin.ts

@@ -2,9 +2,9 @@ import pathParser from 'node:path'
 
 import { createPluginCache, getStackTrace, transformReservedWord } from './utils/index.ts'
 
-import type { Executer } from './managers/index.ts'
 import type { FileManager } from './managers/fileManager/FileManager.ts'
-import type { PluginContext, KubbPlugin, PluginFactoryOptions, PluginLifecycleHooks } from './types.ts'
+import type { Executer } from './managers/index.ts'
+import type { KubbPlugin, PluginContext, PluginFactoryOptions, PluginLifecycleHooks } from './types.ts'
 
 type KubbPluginFactory<T extends PluginFactoryOptions = PluginFactoryOptions> = (
   options: T['options']

package/src/types.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
+import type { File, FileManager } from './managers/fileManager/index.ts'
 import type { PluginManager, SafeParseResult } from './managers/index.ts'
-import type { FileManager, File } from './managers/fileManager/index.ts'
 import type { Cache } from './utils/cache.ts'
 
 export interface Register {}

package/src/utils/TreeNode.ts

@@ -1,5 +1,7 @@
 import dirTree from 'directory-tree'
 
+import { getPathMode } from '../utils/read.ts'
+
 import type { DirectoryTree, DirectoryTreeOptions } from 'directory-tree'
 
 export type TreeNodeOptions = DirectoryTreeOptions
@@ -26,13 +28,17 @@ export class TreeNode<T = unknown> {
     return child
   }
 
-  find(data: T) {
+  find(data?: T): TreeNode<T> | null {
+    if (!data) {
+      return null
+    }
+
     if (data === this.data) {
       return this
     }
 
-    if (this.children) {
-      for (let i = 0, { length } = this.children, target: unknown = null; i < length; i++) {
+    if (this.children?.length) {
+      for (let i = 0, { length } = this.children, target: TreeNode<T> | null = null; i < length; i++) {
         target = this.children[i].find(data)
         if (target) {
           return target
@@ -43,7 +49,7 @@ export class TreeNode<T = unknown> {
     return null
   }
 
-  leaves(): TreeNode<T>[] {
+  get leaves(): TreeNode<T>[] {
     if (!this.children || this.children.length === 0) {
       // this is a leaf
       return [this]
@@ -54,17 +60,17 @@ export class TreeNode<T = unknown> {
     if (this.children) {
       for (let i = 0, { length } = this.children; i < length; i++) {
         // eslint-disable-next-line prefer-spread
-        leaves.push.apply(leaves, this.children[i].leaves())
+        leaves.push.apply(leaves, this.children[i].leaves)
       }
     }
     return leaves
   }
 
-  root(): TreeNode<T> {
+  get root(): TreeNode<T> {
     if (!this.parent) {
       return this
     }
-    return this.parent.root()
+    return this.parent.root
   }
 
   forEach(callback: (treeNode: TreeNode<T>) => void): this {
@@ -86,26 +92,31 @@ export class TreeNode<T = unknown> {
   }
 
   public static build<T = unknown>(path: string, options: TreeNodeOptions = {}): TreeNode<T> | null {
-    const filteredTree = dirTree(path, { extensions: options?.extensions, exclude: options.exclude })
+    try {
+      const exclude = Array.isArray(options.exclude) ? options.exclude : ([options.exclude].filter(Boolean) as RegExp[])
+      const filteredTree = dirTree(path, { extensions: options.extensions, exclude: [/node_modules/, ...exclude] })
 
-    if (!filteredTree) {
-      return null
-    }
+      if (!filteredTree) {
+        return null
+      }
 
-    const treeNode = new TreeNode({ name: filteredTree.name, path: filteredTree.path, type: filteredTree.type })
+      const treeNode = new TreeNode({ name: filteredTree.name, path: filteredTree.path, type: filteredTree.type || getPathMode(filteredTree.path) })
 
-    const recurse = (node: typeof treeNode, item: DirectoryTree) => {
-      const subNode = node.addChild({ name: item.name, path: item.path, type: item.type })
+      const recurse = (node: typeof treeNode, item: DirectoryTree) => {
+        const subNode = node.addChild({ name: item.name, path: item.path, type: item.type || getPathMode(item.path) })
 
-      if (item.children?.length) {
-        item.children?.forEach((child) => {
-          recurse(subNode, child)
-        })
+        if (item.children?.length) {
+          item.children?.forEach((child) => {
+            recurse(subNode, child)
+          })
+        }
       }
-    }
 
-    filteredTree.children?.forEach((child) => recurse(treeNode, child))
+      filteredTree.children?.forEach((child) => recurse(treeNode, child))
 
-    return treeNode as TreeNode<T>
+      return treeNode as TreeNode<T>
+    } catch (e) {
+      throw new Error('Something went wrong with creating index files with the TreehNode class', { cause: e })
+    }
   }
 }

package/src/utils/getStackTrace.ts

@@ -9,7 +9,7 @@ export function getStackTrace(belowFn?: Function): NodeJS.CallSite[] {
   Error.prepareStackTrace = function prepareStackTrace(dummyObject, v8StackTrace) {
     return v8StackTrace
   }
-  Error.captureStackTrace(dummyObject, belowFn || getStackTrace)
+  Error.captureStackTrace(dummyObject as object, belowFn || getStackTrace)
 
   const v8StackTrace = dummyObject.stack
   Error.prepareStackTrace = v8Handler

package/src/utils/index.ts

@@ -15,3 +15,4 @@ export * from './clean.ts'
 export * from './TreeNode.ts'
 export * from './transformReservedWord.ts'
 export * from './getStackTrace.ts'
+export * from './uniqueId.ts'

package/src/utils/read.ts

@@ -1,17 +1,19 @@
-import pathParser from 'node:path'
 import { promises as fs } from 'node:fs'
+import pathParser from 'node:path'
 
-function slash(path: string) {
+function slash(path: string, platform: 'windows' | 'mac' | 'linux' = 'linux') {
   const isExtendedLengthPath = /^\\\\\?\\/.test(path)
 
-  if (isExtendedLengthPath) {
-    return path
+  if (isExtendedLengthPath || platform === 'linux' || platform === 'mac') {
+    // linux and mac
+    return path.replace('../', '').trimEnd()
   }
 
-  return path.replace(/\\/g, '/')
+  // windows
+  return path.replace(/\\/g, '/').replace('../', '').trimEnd()
 }
 
-export function getRelativePath(rootDir?: string | null, filePath?: string | null) {
+export function getRelativePath(rootDir?: string | null, filePath?: string | null, platform: 'windows' | 'mac' | 'linux' = 'linux') {
   if (!rootDir || !filePath) {
     throw new Error(`Root and file should be filled in when retrieving the relativePath, ${rootDir} ${filePath}`)
   }
@@ -20,7 +22,7 @@ export function getRelativePath(rootDir?: string | null, filePath?: string | nul
 
   // On Windows, paths are separated with a "\"
   // However, web browsers use "/" no matter the platform
-  const path = slash(relativePath).replace('../', '').trimEnd()
+  const path = slash(relativePath, platform)
 
   if (path.startsWith('../')) {
     return path.replace(pathParser.basename(path), pathParser.basename(path, pathParser.extname(filePath)))
@@ -39,10 +41,5 @@ export function getPathMode(path: string | undefined | null): PathMode {
 }
 
 export async function read(path: string) {
-  try {
-    return fs.readFile(path, { encoding: 'utf8' })
-  } catch (err) {
-    console.error(err)
-    throw err
-  }
+  return fs.readFile(path, { encoding: 'utf8' })
 }

package/src/utils/uniqueId.ts

@@ -0,0 +1,5 @@
+export const uniqueId = (
+  (counter) =>
+  (str = '') =>
+    `${str}${++counter}`
+)(0)