marmotte

Appearance

marmotte / vite/docs/context

vite/docs/context ​

Classes ​

Context ​

Defined in: src/vite/docs/context.ts:3

Extends ​

Constructors ​

Constructor ​

new Context(options): Context

Defined in: src/vite/lib/context.ts:50

Parameters ​
options ​

UserVitePluginOptions<"sourceDir" | "docsDir">

Returns ​

Context

Inherited from ​

contextFactory({ paths: { sourceDir: "./src", docsDir: "./docs", }, }).constructor

Properties ​

generator ​

readonly generator: object

Defined in: src/vite/docs/context.ts:9

Defined the generator info used when calling VitePluginContext.writeAutoGeneratedFile and VitePluginContext.writeDefaultFile You can (and should) override this when extending context

name ​

name: string = "marmotte/vite/docs"

version ​

version: string = "0.0.0"

Overrides ​

VitePluginContext.generator

options ​

readonly options: UserVitePluginOptions<"sourceDir" | "docsDir">

Defined in: src/vite/lib/context.ts:50

Inherited from ​

VitePluginContext.options

Methods ​

resolve() ​

resolve(base, ...paths): string

Defined in: src/vite/lib/context.ts:72

Parameters ​
base ​

"root" | "sourceDir" | "docsDir"

paths ​

...string[]

Returns ​

string

Absolute path to desired resource

Inherited from ​

VitePluginContext.resolve

resolveBase() ​

resolveBase(base): string

Defined in: src/vite/lib/context.ts:60

resolves a base path using options or defaults

Parameters ​
base ​

"root" | "sourceDir" | "docsDir"

Returns ​

string

Inherited from ​

VitePluginContext.resolveBase

resolvePackageJson() ​

resolvePackageJson(): Promise<{[key: string]: unknown; dependencies: Record<string, string>; description: string; name: string; version: string; }>

Defined in: src/vite/lib/context.ts:77

Returns ​

Promise<{[key: string]: unknown; dependencies: Record<string, string>; description: string; name: string; version: string; }>

Inherited from ​

VitePluginContext.resolvePackageJson

writeAutoGeneratedFile() ​

writeAutoGeneratedFile(file, content, ctx?): Promise<void>

Defined in: src/vite/lib/context.ts:85

Parameters ​
file ​

string

content ​

string

ctx? ​

Partial<CodeGenContext>

Returns ​

Promise<void>

Inherited from ​

VitePluginContext.writeAutoGeneratedFile

writeDefaultFile() ​

writeDefaultFile(file, content, options?, ctx?): Promise<void>

Defined in: src/vite/lib/context.ts:92

Parameters ​
file ​

string

content ​

string

options? ​
force? ​

boolean

still writes even if file exists

noHeader? ​

boolean

don't write the default header

ctx? ​

Partial<CodeGenContext>

Returns ​

Promise<void>

Inherited from ​

VitePluginContext.writeDefaultFile