@dovenv/workspace - API documentation

Classes

Workspace

Constructors

new Workspace()

new Workspace(__namedParameters: {
  opts: Config;
  utils: CommandSuper;
 }): Workspace

Parameters

Parameter	Type
__namedParameters	object
__namedParameters.opts?	Config
__namedParameters.utils	CommandSuper

Returns

Workspace

Methods

audit()

audit(fix?: boolean): Promise<void>

Parameters

Parameter	Type
fix?	boolean

Returns

Promise<void>

check()

check(): Promise<void>

Returns

Promise<void>

donate()

donate(open: boolean): Promise<void>

Parameters

Parameter	Type	Default value
open	boolean	true

Returns

Promise<void>

getPkgPaths()

getPkgPaths(): Promise<any>

Returns

Promise<any>

info()

info(): Promise<void>

Returns

Promise<void>

instructions()

instructions(): Promise<void>

Returns

Promise<void>

outdated()

outdated(): Promise<void>

Returns

Promise<void>

reinstall()

reinstall(): Promise<void>

Returns

Promise<void>

scripts()

scripts(opts?: string[]): Promise<void>

Parameters

Parameter	Type
opts?	string[]

Returns

Promise<void>

size()

size(): Promise<void>

Returns

Promise<void>

structure()

structure(): Promise<void>

Returns

Promise<void>

usefulCmds()

usefulCmds(): Promise<void>

Returns

Promise<void>

Properties

Property	Type
opts	undefined | Config

Functions

workspacePlugin()

function workspacePlugin(params?: Config): Config

Workspace plugin for Dovenv.

Parameters

Parameter	Type	Description
params?	Config	Plugin config.

Returns

Config

• A config with commands for workspace.

Example

import { defineConfig } from '@dovenv/core'
import { workspacePlugin } from '@dovenv/workspace'

export default defineConfig( workspacePlugin() )

Type Aliases

Config

type Config: {
  check: {
     pkg: Record<string, Prettify<Sharedcheck & {
        schema: (opts: {
           content: PackageJSON;
           path: string;
           utils: CommandUtils;
           v: Validate;
          }) => Promise<ValidateAnyType | void> | ValidateAnyType | void;
       }>>;
    };
  custom: NonNullable<CommandUtils["config"]>["custom"];
  info: {
     instructions: string;
     structure: Parameters<typeof setDirTree>[0]["structure"];
     usefulCmds: {
        cmd: string;
        desc: string;
        info: string;
       }[];
    };
  reinstall: {
     hook: {
        after: () => Promise<void>;
        before: () => Promise<void>;
       };
    };
};

Type declaration

Name	Type	Description
check?	{ pkg: Record<string, Prettify<Sharedcheck & { schema: (opts: { content: PackageJSON; path: string; utils: CommandUtils; v: Validate; }) => Promise<ValidateAnyType | void> | ValidateAnyType | void; }>>; }	-
check.pkg?	Record<string, Prettify<Sharedcheck & { schema: (opts: { content: PackageJSON; path: string; utils: CommandUtils; v: Validate; }) => Promise<ValidateAnyType | void> | ValidateAnyType | void; }>>	Checks for workspace package(s).
custom?	NonNullable<CommandUtils["config"]>["custom"]	Custom configration for ws
info?	{ instructions: string; structure: Parameters<typeof setDirTree>[0]["structure"]; usefulCmds: { cmd: string; desc: string; info: string; }[]; }	Information for the workspace.
info.instructions?	string	Instructions for the workspace. Must be markdown format. Accepts string, URL or path. Example ## Pre-requisites project needs the following tools to work: - node> 20 installed -pnpm> 9 installed -gh> 2 installed -git > 2 installed ## Init workspace pnpm install
info.structure?	Parameters<typeof setDirTree>[0]["structure"]	Structure of the workspace.
info.usefulCmds?	{ cmd: string; desc: string; info: string; }[]	Add more commands to the list of useful commands. Example usefullCmds : [ { desc : 'Checks for outdated packages.', cmd : 'pnpm -r outdated', }, ]
reinstall?	{ hook: { after: () => Promise<void>; before: () => Promise<void>; }; }	Reinstall the workspace options
reinstall.hook?	{ after: () => Promise<void>; before: () => Promise<void>; }	-
reinstall.hook.after?	() => Promise<void>	Hook after reinstallation
reinstall.hook.before?	() => Promise<void>	Hook before reinstallation

References

default

Renames and re-exports workspacePlugin