Home Reference Source Test

import Linker from 'shinka-cli/src/Linker/Linker.js'

public class | source

Linker

Handles creating and destroying symlinks.

Test:

Linker

Constructor Summary

Public Constructor
public	constructor(cmd: Cmd, config: Config, logger: LogObject)

Member Summary

Public Members
public	bar: ProgressBar Progress bar.
public	cmd: Cmd Command arguments.
public	config: Config Config to pull linkables from.
public	cwd: string Current working directory, used to build absolute paths.
public	destroyLink(path: string): * Destroys symlink and outputs progress.
public	errorList: LinkError[] Paths and associated errors.
public	logger: LogObject logger#log is used to output progress, e.g.
public	makeLink(path: string, type: string): * Creates symlink and outputs progress.
public	maxLength: number Length of longest path.
public	total: number Number of files and directories.
public	verbs: Verbs Verbs to use in composing messages.

Method Summary

Public Methods
public	errors(): string[] Builds error messages.
public	getMaxLength(): number Calculates length of longest file or directory name.
public	link(config: Config): Linker Links items and outputs progress.
public	outputErrors() Outputs error messages.
public	outputProgress(path: string, error: Error) Outputs status message and updates progress bar.
public	outputSuccess() Outputs success message.
public	progress(path: string, error: Error): string Builds progress message in format `(Un)Linking...
public	success(): string Builds success message.
public	unlink(config: Config): Linker Unlinks items and outputs progress.

Public Constructors

public constructor(cmd: Cmd, config: Config, logger: LogObject) source

Params:

Name	Type	Attribute	Description
cmd	Cmd
config	Config	optional default: this.config
logger	LogObject	optional default: new Logger()

Test:

Public Members

public bar: ProgressBar source

Progress bar.

public cmd: Cmd source

Command arguments.

public config: Config source

Config to pull linkables from.

public cwd: string source

Current working directory, used to build absolute paths.

public destroyLink(path: string): * source

Destroys symlink and outputs progress.

Test:

Linker linking destroyLink()

public errorList: LinkError[] source

Paths and associated errors.

public logger: LogObject source

logger#log is used to output progress, e.g. Logger#log or console#log.

public makeLink(path: string, type: string): * source

Creates symlink and outputs progress.

Test:

Linker linking makeLink()

public maxLength: number source

Length of longest path.

public total: number source

Number of files and directories.

public verbs: Verbs source

Verbs to use in composing messages.

Public Methods

public errors(): string[] source

Builds error messages.

Return:

Test:

Linker errors()

public getMaxLength(): number source

Calculates length of longest file or directory name.

Return:

public link(config: Config): Linker source

Links items and outputs progress.

Params:

Name	Type	Attribute	Description
config	Config

Return:

Return Properties:

Name	Type	Attribute	Description
config.files	string[]
config.directories	string[]

Test:

Linker linking commands link()

public outputErrors() source

Outputs error messages.

public outputProgress(path: string, error: Error) source

Outputs status message and updates progress bar.

Params:

Name	Type	Attribute	Description
path	string
error	Error	optional nullable: true

public outputSuccess() source

Outputs success message.

public progress(path: string, error: Error): string source

Builds progress message in format (Un)Linking... to/a/path Status

Params:

Name	Type	Attribute	Description
path	string
error	Error	optional nullable: true

Return:

Test:

Linker progress()

public success(): string source

Builds success message.

Return:

Test:

Linker success()

public unlink(config: Config): Linker source

Unlinks items and outputs progress.

Params:

Name	Type	Attribute	Description
config	Config

Return:

Return Properties:

Name	Type	Attribute	Description
config.files	string[]
config.directories	string[]

Test:

Linker linking commands unlink()