@dovenv/repo - API documentation

Classes

Contributors<ID, R>

Type Parameters

Type Parameter
ID extends string
R extends Role<ID>

Constructors

new Contributors()

new Contributors<ID, R>(opts?: {
  member: Contributor<Extract<keyof R, string>>[];
  role: R;
}): Contributors<ID, R>

Parameters

Parameter	Type
opts?	object
opts.member?	Contributor<Extract<keyof R, string>>[]
opts.role?	R

Returns

Contributors<ID, R>

Methods

filterByRole()

filterByRole(role: keyof ID[]): Promise<undefined | {
  member: Contributor<Extract<keyof R, string>>[];
  role: R;
}>

Parameters

Parameter	Type
role	keyof ID[]

Returns

Promise<undefined | { member: Contributor<Extract<keyof R, string>>[]; role: R; }>

filterByRolePattern()

filterByRolePattern(pattern: string[]): Promise<undefined | {
  member: Contributor<Extract<keyof R, string>>[];
  role: R;
}>

Parameters

Parameter	Type
pattern	string[]

Returns

Promise<undefined | { member: Contributor<Extract<keyof R, string>>[]; role: R; }>

getHtmlContent()

getHtmlContent(opts?: {
  member: Contributor<Extract<keyof R, string>>[];
  role: R;
}): Promise<string>

Parameters

Parameter	Type
opts?	object
opts.member?	Contributor<Extract<keyof R, string>>[]
opts.role?	R

Returns

Promise<string>

getMembers()

getMembers(): Promise<Contributor<Extract<keyof R, string>>[]>

Returns

Promise<Contributor<Extract<keyof R, string>>[]>

getRoles()

getRoles(): Promise<R>

Returns

Promise<R>

showTerminalOutput()

showTerminalOutput(opts?: {
  member: Contributor<Extract<keyof R, string>>[];
  role: R;
}): Promise<void>

Parameters

Parameter	Type
opts?	object
opts.member?	Contributor<Extract<keyof R, string>>[]
opts.role?	R

Returns

Promise<void>

Properties

Property	Type
opts	{ member: Contributor<Extract<keyof R, string>>[]; role: R; }
opts.member	Contributor<Extract<keyof R, string>>[]
opts.role	R

---

Git

Extends

• Repo<GitConfig>

Constructors

new Git()

new Git(opts?: GitConfig, config?: Config): Git

Parameters

Parameter	Type
opts?	GitConfig
config?	Config

Returns

Git

Overrides

Repo<GitConfig>.constructor

Methods

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

Repo.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

Repo.initGH

Properties

Property	Type	Default value	Description	Inherited from
add	GitAdd	undefined	-	-
branch	GitBranch	undefined	-	-
commit	GitCommit	undefined	-	-
config	undefined | Config	undefined	The dovenv configuration.	Repo.config
husky	Husky	undefined	-	-
initialize	GitInit	undefined	-	-
opts	undefined | GitConfig	undefined	Configuration options.	Repo.opts
pull	GitPull	undefined	-	-
push	GitPush	undefined	-	-
title	string	'repo'	-	Repo.title

---

GitAdd

Extends

• GitSuper

Constructors

new GitAdd()

new GitAdd(opts?: GitConfig, config?: Config): GitAdd

Parameters

Parameter	Type
opts?	GitConfig
config?	Config

Returns

GitAdd

Inherited from

GitSuper.constructor

Methods

ask()

ask(initialValue: string): Promise<string>

Parameters

Parameter	Type	Default value
initialValue	string	'.'

Returns

Promise<string>

exec()

exec(value: string): Promise<void>

Parameters

Parameter	Type
value	string

Returns

Promise<void>

getGitRemoteURL()

getGitRemoteURL(): Promise<undefined | string>

Returns

Promise<undefined | string>

Inherited from

GitSuper.getGitRemoteURL

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.initGH

run()

run(): Promise<void>

Returns

Promise<void>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	GitSuper.config
opts	undefined | GitConfig	undefined	Configuration options.	GitSuper.opts
title	string	'repo'	-	GitSuper.title

---

GitBranch

Extends

• GitSuper

Constructors

new GitBranch()

new GitBranch(opts?: GitConfig, config?: Config): GitBranch

Parameters

Parameter	Type
opts?	GitConfig
config?	Config

Returns

GitBranch

Inherited from

GitSuper.constructor

Methods

askSelectBranch()

askSelectBranch(defaultValue?: string, remote?: boolean): Promise<string>

Parameters

Parameter	Type	Default value
defaultValue?	string	undefined
remote?	boolean	true

Returns

Promise<string>

change()

change(branchName?: string, force?: boolean): Promise<void>

Change to a specified branch.

Parameters

Parameter	Type	Default value	Description
branchName?	string	undefined	The name of the branch to switch to.
force?	boolean	false	If true, force switches to the branch, discarding local changes.

Returns

Promise<void>

create()

create(branchName?: string): Promise<void>

Create a new branch without switching to it.

Parameters

Parameter	Type	Description
branchName?	string	The name of the branch to create.

Returns

Promise<void>

createAndSwitch()

createAndSwitch(branchName?: string): Promise<void>

Create a new branch and switch to it.

Parameters

Parameter	Type	Description
branchName?	string	The name of the branch to create and switch to.

Returns

Promise<void>

delete()

delete(branchName?: string, force?: boolean): Promise<void>

Delete a branch.

Parameters

Parameter	Type	Default value	Description
branchName?	string	undefined	The name of the branch to delete.
force?	boolean	false	If true, forces deletion of the branch.

Returns

Promise<void>

getAll()

getAll(remote: boolean): Promise<string[]>

Get all branches in the repository.

Parameters

Parameter	Type	Default value	Description
remote	boolean	true	If true, shows remote branches as well.

Returns

Promise<string[]>

• An array of branch names.

getCurrent()

getCurrent(): Promise<string>

Get the current branch name.

Returns

Promise<string>

• The name of the current branch.

getGitRemoteURL()

getGitRemoteURL(): Promise<undefined | string>

Returns

Promise<undefined | string>

Inherited from

GitSuper.getGitRemoteURL

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.initGH

showAll()

showAll(remote: boolean): Promise<void>

Show all branches in the repository.

Parameters

Parameter	Type	Default value	Description
remote	boolean	true	If true, shows remote branches as well.

Returns

Promise<void>

showCurrent()

showCurrent(): Promise<void>

Shows the current branch name.

Returns

Promise<void>

switch()

switch(branchName?: string): Promise<void>

Switch to an existing branch.

Parameters

Parameter	Type	Description
branchName?	string	The name of the branch to switch to.

Returns

Promise<void>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	GitSuper.config
opts	undefined | GitConfig	undefined	Configuration options.	GitSuper.opts
title	string	'repo'	-	GitSuper.title

---

GitCommit

Extends

• GitSuper

Constructors

new GitCommit()

new GitCommit(opts?: GitConfig, config?: Config): GitCommit

Parameters

Parameter	Type
opts?	GitConfig
config?	Config

Returns

GitCommit

Inherited from

GitSuper.constructor

Methods

ask()

ask(execute: boolean): Promise<string>

Parameters

Parameter	Type	Default value
execute	boolean	true

Returns

Promise<string>

exec()

exec(message: string): Promise<void>

Parameters

Parameter	Type
message	string

Returns

Promise<void>

getGitRemoteURL()

getGitRemoteURL(): Promise<undefined | string>

Returns

Promise<undefined | string>

Inherited from

GitSuper.getGitRemoteURL

getLastCommit()

getLastCommit(): Promise<string>

Get the last commit message.

Returns

Promise<string>

The last commit message.

getStagedFiles()

getStagedFiles(): Promise<string>

Returns

Promise<string>

getStagedFilesList()

getStagedFilesList(): Promise<string[]>

Get list of staged files.

Returns

Promise<string[]>

List of staged files

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.initGH

isStageEmpty()

isStageEmpty(): Promise<boolean>

Returns

Promise<boolean>

run()

run(): Promise<undefined | string>

Returns

Promise<undefined | string>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	GitSuper.config
opts	undefined | GitConfig	undefined	Configuration options.	GitSuper.opts
scopes	undefined | { desc: string; title: string; value: string; }[]	undefined	-	-
title	string	'repo'	-	GitSuper.title
types	undefined | { desc: string; title: string; value: string; }[]	undefined	-	-

---

GitHub

Extends

• PluginCore<GitHubConfig>

Constructors

new GitHub()

new GitHub(opts?: GitHubConfig, config?: Config): GitHub

Parameters

Parameter	Type
opts?	GitHubConfig
config?	Config

Returns

GitHub

Overrides

PluginCore<GitHubConfig>.constructor

Methods

download()

download(input: string, output: string): Promise<void>

Parameters

Parameter	Type
input	string
output	string

Returns

Promise<void>

Properties

Property	Type	Description	Inherited from
config	undefined | Config	The dovenv configuration.	PluginCore.config
create	GitHubCreate	-	-
info	GitHubInfo	-	-
opts	undefined | GitHubConfig	Configuration options.	PluginCore.opts
title	string	The title of the application. Use in internal logs and functions.	PluginCore.title
workflow	GitHubWorkflow	-	-

---

GitHubInfo

Extends

• GHSuper

Constructors

new GitHubInfo()

new GitHubInfo(opts?: GitHubConfig, config?: Config): GitHubInfo

Parameters

Parameter	Type
opts?	GitHubConfig
config?	Config

Returns

GitHubInfo

Inherited from

GHSuper.constructor

Methods

getRepoList()

getRepoList(opts?: {
  archived: boolean;
  fork: boolean;
  visibility: "public" | "private" | "internal";
 }): Promise<{
  desc: undefined | string;
  homepage: undefined | string;
  name: r.name;
  owner: r.owner.login;
  topics: undefined | string[];
  url: r.url;
}[]>

Parameters

Parameter	Type
opts?	object
opts.archived?	boolean
opts.fork?	boolean
opts.visibility?	"public" | "private" | "internal"

Returns

Promise<{ desc: undefined | string; homepage: undefined | string; name: r.name; owner: r.owner.login; topics: undefined | string[]; url: r.url; }[]>

Inherited from

GHSuper.getRepoList

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

GHSuper.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

GHSuper.initGH

update()

update(): Promise<void>

Returns

Promise<void>

view()

view(): Promise<void>

Returns

Promise<void>

viewAll()

viewAll(): Promise<void>

Returns

Promise<void>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	GHSuper.config
opts	undefined | GitHubConfig	undefined	Configuration options.	GHSuper.opts
title	string	'repo'	-	GHSuper.title

---

GitHubWorkflow

Extends

• GHSuper

Constructors

new GitHubWorkflow()

new GitHubWorkflow(opts?: GitHubConfig, config?: Config): GitHubWorkflow

Parameters

Parameter	Type
opts?	GitHubConfig
config?	Config

Returns

GitHubWorkflow

Inherited from

GHSuper.constructor

Methods

getRepoList()

getRepoList(opts?: {
  archived: boolean;
  fork: boolean;
  visibility: "public" | "private" | "internal";
 }): Promise<{
  desc: undefined | string;
  homepage: undefined | string;
  name: r.name;
  owner: r.owner.login;
  topics: undefined | string[];
  url: r.url;
}[]>

Parameters

Parameter	Type
opts?	object
opts.archived?	boolean
opts.fork?	boolean
opts.visibility?	"public" | "private" | "internal"

Returns

Promise<{ desc: undefined | string; homepage: undefined | string; name: r.name; owner: r.owner.login; topics: undefined | string[]; url: r.url; }[]>

Inherited from

GHSuper.getRepoList

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

GHSuper.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

GHSuper.initGH

list()

list(): Promise<void>

Returns

Promise<void>

run()

run(): Promise<void>

Returns

Promise<void>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	GHSuper.config
opts	undefined | GitHubConfig	undefined	Configuration options.	GHSuper.opts
title	string	'repo'	-	GHSuper.title

---

GitInit

Extends

• GitSuper

Constructors

new GitInit()

new GitInit(opts?: GitConfig, config?: Config): GitInit

Parameters

Parameter	Type
opts?	GitConfig
config?	Config

Returns

GitInit

Inherited from

GitSuper.constructor

Methods

getGitRemoteURL()

getGitRemoteURL(): Promise<undefined | string>

Returns

Promise<undefined | string>

Inherited from

GitSuper.getGitRemoteURL

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.initGH

isInit()

isInit(): Promise<boolean>

Returns

Promise<boolean>

run()

run(silent: boolean): Promise<void>

Parameters

Parameter	Type	Default value
silent	boolean	false

Returns

Promise<void>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	GitSuper.config
opts	undefined | GitConfig	undefined	Configuration options.	GitSuper.opts
title	string	'repo'	-	GitSuper.title

---

GitPull

Extends

• GitSuper

Constructors

new GitPull()

new GitPull(opts?: GitConfig, config?: Config): GitPull

Parameters

Parameter	Type
opts?	GitConfig
config?	Config

Returns

GitPull

Inherited from

GitSuper.constructor

Methods

getGitRemoteURL()

getGitRemoteURL(): Promise<undefined | string>

Returns

Promise<undefined | string>

Inherited from

GitSuper.getGitRemoteURL

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.initGH

run()

run(): Promise<void>

Returns

Promise<void>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	GitSuper.config
opts	undefined | GitConfig	undefined	Configuration options.	GitSuper.opts
title	string	'repo'	-	GitSuper.title

---

GitPush

Extends

• GitSuper

Constructors

new GitPush()

new GitPush(opts?: GitConfig, config?: Config): GitPush

Parameters

Parameter	Type
opts?	GitConfig
config?	Config

Returns

GitPush

Inherited from

GitSuper.constructor

Methods

exec()

exec(branch: string): Promise<void>

Parameters

Parameter	Type
branch	string

Returns

Promise<void>

getGitRemoteURL()

getGitRemoteURL(): Promise<undefined | string>

Returns

Promise<undefined | string>

Inherited from

GitSuper.getGitRemoteURL

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.initGH

run()

run(): Promise<void>

Returns

Promise<void>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	GitSuper.config
opts	undefined | GitConfig	undefined	Configuration options.	GitSuper.opts
title	string	'repo'	-	GitSuper.title

---

Husky

Extends

• GitSuper

Constructors

new Husky()

new Husky(opts?: GitConfig, config?: Config): Husky

Parameters

Parameter	Type
opts?	GitConfig
config?	Config

Returns

Husky

Inherited from

GitSuper.constructor

Methods

getGitRemoteURL()

getGitRemoteURL(): Promise<undefined | string>

Returns

Promise<undefined | string>

Inherited from

GitSuper.getGitRemoteURL

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

GitSuper.initGH

run()

run(): Promise<void>

Returns

Promise<void>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	GitSuper.config
opts	undefined | GitConfig	undefined	Configuration options.	GitSuper.opts
title	string	'repo'	-	GitSuper.title

---

Packages

Extends

• Repo

Constructors

new Packages()

new Packages(opts?: GitHubConfig, config?: Config): Packages

Parameters

Parameter	Type
opts?	GitHubConfig
config?	Config

Returns

Packages

Inherited from

Repo.constructor

Methods

ask()

ask(): Promise<{}>

Returns

Promise<{}>

getPkgVersion()

getPkgVersion(npm: boolean): Promise<{
  name: string;
  npm: string;
  version: string;
}[]>

Parameters

Parameter	Type	Default value
npm	boolean	true

Returns

Promise<{ name: string; npm: string; version: string; }[]>

init()

init(): Promise<void>

Returns

Promise<void>

Overrides

Repo.init

initGH()

initGH(): Promise<void>

Returns

Promise<void>

Inherited from

Repo.initGH

prepare()

prepare(): Promise<undefined | number>

Returns

Promise<undefined | number>

publish()

publish(preCmd?: string): Promise<undefined | number>

Parameters

Parameter	Type
preCmd?	string

Returns

Promise<undefined | number>

release()

release(): Promise<void>

Returns

Promise<void>

showPackageVersion()

showPackageVersion(npm: boolean): Promise<void>

Parameters

Parameter	Type	Default value
npm	boolean	true

Returns

Promise<void>

version()

version(): Promise<undefined | number>

Returns

Promise<undefined | number>

Properties

Property	Type	Default value	Description	Inherited from
config	undefined | Config	undefined	The dovenv configuration.	Repo.config
opts	undefined | GitHubConfig	undefined	Configuration options.	Repo.opts
title	string	'repo'	-	Repo.title

Functions

contributorsPlugin()

function contributorsPlugin<ID, R>(conf?: ContributorsConfig<ID, R>): Config

Type Parameters

Type Parameter
ID extends string
R extends Role<ID>

Parameters

Parameter	Type
conf?	ContributorsConfig<ID, R>

Returns

Config

---

ghPlugin()

function ghPlugin(conf?: GitHubConfig): Config

Parameters

Parameter	Type
conf?	GitHubConfig

Returns

Config

---

gitPlugin()

function gitPlugin(conf?: GitConfig): Config

Parameters

Parameter	Type
conf?	GitConfig

Returns

Config

---

pkgPlugin()

function pkgPlugin(conf?: GitHubConfig): Config

Parameters

Parameter	Type
conf?	GitHubConfig

Returns

Config

---

repoPlugin()

function repoPlugin<Contr, R>(opts?: Config<Contr, R>): Config

Dovenv plugin for managing a repository.

Type Parameters

Type Parameter
Contr extends string
R extends Role<Contr>

Parameters

Parameter	Type	Description
opts?	Config<Contr, R>	Optional configuration.

Returns

Config

• The plugin configuration.

Type Aliases

Config<I, R>

type Config<I, R>: GitHubConfig & GitConfig & {
  contributors: ContributorsConfig<I, R>;
};

Type declaration

Name	Type	Description
contributors?	ContributorsConfig<I, R>	Contributors configuration

Type Parameters

Type Parameter
I extends string
R extends Role<I>

---

ContributorsConfig<ID, R>

type ContributorsConfig<ID, R>: {
  member: Contributor<Extract<keyof R, string>>[];
  role: R;
};

Type Parameters

Type Parameter
ID extends string
R extends Role<ID>

Type declaration

Name	Type	Description
member	Contributor<Extract<keyof R, string>>[]	Set contributor members Example [ { ghUsername: 'angelespejo', name: 'Angelo', role: 'author' }, { ghUsername: 'pigeonposse', name: 'PigeonPosse', role: 'organization' }, ]
role	R	Set contributor roles Example { * owner: { name: 'Owner', emoji: '👑' }, * developer: { name: 'Developer', emoji: '🤝' }, * organization: { name: 'Organization', emoji: '🏢' }, * sponsor: { name: 'Sponsor', emoji: '🤝' }, * translator: { name: 'Translator', emoji: '🌏' } * },

---

GitHubConfig

type GitHubConfig: {
  defaultBranch: string;
  desc: string;
  homepageURL: string;
  ID: string;
  tags: string[];
  URL: string;
  userID: string;
  workflowDefaultInputs: string;
  workflowsDir: string;
};

Type declaration

Name	Type	Description
defaultBranch?	string	Primary branch from the repository Example "main"
desc?	string	Description of the repository Example "This is a cool project"
homepageURL?	string	The URL of the project's homepage. Example "https://pigeonposse.com"
ID?	string	Name of the repository Example "dovenv"
tags?	string[]	Tags or topics associated with the repository Example [ "web", "api", "rest-api", "openapi", "library", "node", "js"]
URL?	string	URL of the repopository Example "https://github.com/pigeonposse/dovenv"
userID?	string	GitHub user
workflowDefaultInputs?	string	Workflow default inputs
workflowsDir?	string	Path to .github/workflows directory

References

default

Renames and re-exports repoPlugin

Variables

CONTRIBUTOR_ROLE

const CONTRIBUTOR_ROLE: {
  author: {
     desc: 'Author of the project.';
     emoji: '👑';
     name: 'Author';
    };
  designer: {
     desc: 'Contributor for the design of the project. Images, icons, etc.';
     emoji: '💄';
     name: 'Designer';
    };
  developer: {
     desc: 'Contributor for the development of the project. Code, docs, etc.';
     emoji: '👨‍💻';
     name: 'Developer';
    };
  organization: {
     emoji: '🏢';
     name: 'Organization';
    };
  sponsor: {
     emoji: '🤝';
     name: 'Sponsor';
    };
  translator: {
     emoji: '🌏';
     name: 'Translator';
    };
};

Type declaration

Name	Type	Default value
author	{ desc: 'Author of the project.'; emoji: '👑'; name: 'Author'; }	-
author.desc	string	'Author of the project.'
author.emoji	string	'👑'
author.name	string	'Author'
designer	{ desc: 'Contributor for the design of the project. Images, icons, etc.'; emoji: '💄'; name: 'Designer'; }	-
designer.desc	string	'Contributor for the design of the project. Images, icons, etc.'
designer.emoji	string	'💄'
designer.name	string	'Designer'
developer	{ desc: 'Contributor for the development of the project. Code, docs, etc.'; emoji: '👨‍💻'; name: 'Developer'; }	-
developer.desc	string	'Contributor for the development of the project. Code, docs, etc.'
developer.emoji	string	'👨‍💻'
developer.name	string	'Developer'
organization	{ emoji: '🏢'; name: 'Organization'; }	-
organization.emoji	string	'🏢'
organization.name	string	'Organization'
sponsor	{ emoji: '🤝'; name: 'Sponsor'; }	-
sponsor.emoji	string	'🤝'
sponsor.name	string	'Sponsor'
translator	{ emoji: '🌏'; name: 'Translator'; }	-
translator.emoji	string	'🌏'
translator.name	string	'Translator'