DubComponent

Undocumented in source.

Members

Functions

archType
string archType()

Returns the current selected arch type

archTypes
string[] archTypes()

List all possible arch types for current set compiler

build
Future!(BuildIssue[]) build()

Asynchroniously builds the project WITHOUT OUTPUT. This is intended for linting code and showing build errors quickly inside the IDE.

buildType
string buildType()

Returns the current selected build type

buildTypes
string[] buildTypes()

Lists all build types defined in the package description AND the predefined ones from dub ("plain", "debug", "release", "release-debug", "release-nobounds", "unittest", "docs", "ddox", "profile", "profile-gc", "cov", "unittest-cov")

canBuild
bool canBuild()

Returns whether there is a target set to build. If this is false then build will throw an exception.

compiler
string compiler()

Returns the current selected compiler

configuration
string configuration()

Gets the current selected configuration

configurations
string[] configurations()

Lists all configurations defined in the package description

convertRecipe
string convertRecipe(string format)

Converts the root package recipe to another format.

dependencies
auto dependencies()

Lists all dependencies. This will go through all dependencies and contain the dependencies of dependencies. You need to create a tree structure from this yourself.

fileImports
string[] fileImports()

Lists all import paths to files

imports
string[] imports()

Lists all import paths

isRunning
bool isRunning()
Undocumented in source. Be warned that the author may not have intended to support it.
load
void load()
Undocumented in source. Be warned that the author may not have intended to support it.
name
string name()

Returns the project name

path
auto path()

Returns the project path

recipePath
string recipePath()

Returns the path to the root package recipe (dub.json/dub.sdl)

rootDependencies
string[] rootDependencies()

Lists dependencies of the root package. This can be used as a base to create a tree structure.

setArchType
bool setArchType(JSONValue request)

Selects a new arch type and updates the import paths accordingly

setBuildType
bool setBuildType(JSONValue request)

Selects a new build type and updates the import paths accordingly

setCompiler
bool setCompiler(string compiler)

Selects a new compiler for building

setConfiguration
bool setConfiguration(string configuration)

Selects a new configuration and updates the import paths accordingly

stringImports
string[] stringImports()

Lists all string import paths

update
Future!bool update()

Reloads the dub.json or dub.sdl file from the cwd

updateImportPaths
bool updateImportPaths(bool restartDub)
Undocumented in source. Be warned that the author may not have intended to support it.
upgrade
void upgrade(bool save)

Calls dub upgrade

validateBuildConfiguration
void validateBuildConfiguration()

Throws if configuration is invalid or targetType is none or source library, otherwise does nothing.

validateConfiguration
void validateConfiguration()

Throws if configuration is invalid, otherwise does nothing.

Mixins

__anonymous
mixin DefaultComponentWrapper
Undocumented in source.

Static functions

registered
void registered()
Undocumented in source. Be warned that the author may not have intended to support it.

Mixed In Members

From mixin DefaultComponentWrapper

workspaced
WorkspaceD workspaced;
Undocumented in source.
refInstance
WorkspaceD.Instance refInstance;
Undocumented in source.
_threads
TaskPool _threads;
Undocumented in source.
~this
~this()
Undocumented in source.
gthreads
TaskPool gthreads()
Undocumented in source. Be warned that the author may not have intended to support it.
threads
TaskPool threads(int minSize, int maxSize)
Undocumented in source. Be warned that the author may not have intended to support it.
instance
WorkspaceD.Instance instance()
Undocumented in source. Be warned that the author may not have intended to support it.
instance
WorkspaceD.Instance instance(WorkspaceD.Instance instance)
Undocumented in source. Be warned that the author may not have intended to support it.
importPaths
string[] importPaths()
Undocumented in source. Be warned that the author may not have intended to support it.
stringImportPaths
string[] stringImportPaths()
Undocumented in source. Be warned that the author may not have intended to support it.
importFiles
string[] importFiles()
Undocumented in source. Be warned that the author may not have intended to support it.
importPathProvider
ImportPathProvider importPathProvider()
Undocumented in source. Be warned that the author may not have intended to support it.
stringImportPathProvider
ImportPathProvider stringImportPathProvider()
Undocumented in source. Be warned that the author may not have intended to support it.
importFilesProvider
ImportPathProvider importFilesProvider()
Undocumented in source. Be warned that the author may not have intended to support it.
config
Configuration config()
Undocumented in source. Be warned that the author may not have intended to support it.
has
bool has()
Undocumented in source. Be warned that the author may not have intended to support it.
get
T get()
Undocumented in source. Be warned that the author may not have intended to support it.
cwd
string cwd()
Undocumented in source. Be warned that the author may not have intended to support it.
shutdown
void shutdown(bool dtor)
Undocumented in source. Be warned that the author may not have intended to support it.
bind
void bind(WorkspaceD workspaced, WorkspaceD.Instance instance)
Undocumented in source. Be warned that the author may not have intended to support it.
run
Future!JSONValue run(string method, JSONValue[] args)
Undocumented in source. Be warned that the author may not have intended to support it.
runMethod
Future!JSONValue runMethod(JSONValue[] args)
Undocumented in source. Be warned that the author may not have intended to support it.
runOverload
Future!JSONValue runOverload(JSONValue[] args)
Undocumented in source. Be warned that the author may not have intended to support it.
generateOverloadCall
string generateOverloadCall()
Undocumented in source. Be warned that the author may not have intended to support it.

Inherited Members

From ComponentWrapper

bind
void bind(WorkspaceD workspaced, WorkspaceD.Instance instance)
Undocumented in source.
run
Future!JSONValue run(string method, JSONValue[] args)
Undocumented in source.
shutdown
void shutdown(bool dtor)
Undocumented in source.

Meta