Class BintasticProject

Hierarchy

Project
- BintasticProject

Index

Constructors

constructor

new BintasticProject(
    name?: string,
    version?: string,
    cb?: (project: Project) => void,
): BintasticProject
Constructs an instance of a BintasticProject.
Parameters
- name: string = 'fake-project'
  The name of the project. Used within the package.json as the name property.
- Optionalversion: string
  The version of the project. Used within the package.json as the version property.
- Optionalcb: (project: Project) => void
  An optional callback for additional setup steps after the project is constructed.
Returns BintasticProject
Overrides Project.constructor
- Defined in src/project.ts:16

Properties

files

files: DirJSON

`Readonly`isDependency

isDependency: true

pkg

pkg: PackageJson

Accessors

baseDir

get baseDir(): string
Gets the base directory path, usually a tmp directory unless a baseDir has been explicitly set.

Returns string
Memberof
Project
Inherited from Project.baseDir
- Defined in node_modules/fixturify-project/dist/index.d.ts:47

name

get name(): string
Gets the package name from the package.json.

Returns string
Memberof
Project
Inherited from Project.name
- Defined in node_modules/fixturify-project/dist/index.d.ts:54
set name(value: string): void
Sets the package name in the package.json.
Parameters
- value: string
Returns void
Memberof
Project
Inherited from Project.name
- Defined in node_modules/fixturify-project/dist/index.d.ts:60

version

get version(): string
Gets the version number from the package.json.

Returns string
Memberof
Project
Inherited from Project.version
- Defined in node_modules/fixturify-project/dist/index.d.ts:67
set version(value: string): void
Sets the version number in the package.json.
Parameters
- value: string
Returns void
Memberof
Project
Inherited from Project.version
- Defined in node_modules/fixturify-project/dist/index.d.ts:73

Methods

addDependency

addDependency(
    name?: string,
    version?: string,
    args?: Omit<ProjectArgs, "name" | "version">,
    projectCallback?: ProjectCallback,
): Project
Parameters
- Optionalname: string
- Optionalversion: string
- Optionalargs: Omit<ProjectArgs, "name" | "version">
- OptionalprojectCallback: ProjectCallback
Returns Project
Inherited from Project.addDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:96
addDependency(
    name?: string,
    version?: string,
    projectCallback?: ProjectCallback,
): Project
Parameters
- Optionalname: string
- Optionalversion: string
- OptionalprojectCallback: ProjectCallback
Returns Project
Inherited from Project.addDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:97
addDependency(
    name?: string,
    args?: Omit<ProjectArgs, "name">,
    projectCallback?: ProjectCallback,
): Project
Parameters
- Optionalname: string
- Optionalargs: Omit<ProjectArgs, "name">
- OptionalprojectCallback: ProjectCallback
Returns Project
Inherited from Project.addDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:98
addDependency(args?: ProjectArgs, projectCallback?: ProjectCallback): Project
Parameters
- Optionalargs: ProjectArgs
- OptionalprojectCallback: ProjectCallback
Returns Project
Inherited from Project.addDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:99
addDependency(args?: Project, projectCallback?: ProjectCallback): Project
Parameters
- Optionalargs: Project
- OptionalprojectCallback: ProjectCallback
Returns Project
Inherited from Project.addDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:100

addDevDependency

addDevDependency(
    name?: string,
    version?: string,
    args?: Omit<ProjectArgs, "name" | "version">,
    projectCallback?: ProjectCallback,
): Project
Adds a devDependency to the Project's package.json.
Parameters
- Optionalname: string
- Optionalversion: string
- Optionalargs: Omit<ProjectArgs, "name" | "version">
- OptionalprojectCallback: ProjectCallback
Returns Project
- The Project instance.
Inherited from Project.addDevDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:106
addDevDependency(
    name?: string,
    version?: string,
    projectCallback?: ProjectCallback,
): Project
Adds a devDependency to the Project's package.json.
Parameters
- Optionalname: string
- Optionalversion: string
- OptionalprojectCallback: ProjectCallback
Returns Project
- The Project instance.
Inherited from Project.addDevDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:107
addDevDependency(
    name?: string,
    args?: Omit<ProjectArgs, "name">,
    projectCallback?: ProjectCallback,
): Project
Adds a devDependency to the Project's package.json.
Parameters
- Optionalname: string
- Optionalargs: Omit<ProjectArgs, "name">
- OptionalprojectCallback: ProjectCallback
Returns Project
- The Project instance.
Inherited from Project.addDevDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:108
addDevDependency(args?: ProjectArgs, projectCallback?: ProjectCallback): Project
Adds a devDependency to the Project's package.json.
Parameters
- Optionalargs: ProjectArgs
- OptionalprojectCallback: ProjectCallback
Returns Project
- The Project instance.
Inherited from Project.addDevDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:109
addDevDependency(args?: Project, projectCallback?: ProjectCallback): Project
Adds a devDependency to the Project's package.json.
Parameters
- Optionalargs: Project
- OptionalprojectCallback: ProjectCallback
Returns Project
- The Project instance.
Inherited from Project.addDevDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:110

chdir

chdir(): Promise<void>
Changes a directory from inside the project.

Returns Promise<void>
- Defined in src/project.ts:45

clone

clone(): Project
Returns Project
- The cloned Project.
Inherited from Project.clone
- Defined in node_modules/fixturify-project/dist/index.d.ts:146

dependencyProjects

dependencyProjects(): Project[]
Returns Project[]
- An array of the dependencies for this Projct.
Inherited from Project.dependencyProjects
- Defined in node_modules/fixturify-project/dist/index.d.ts:138

devDependencyProjects

devDependencyProjects(): Project[]
Returns Project[]
- An array of the devDependencies for this Projct.
Inherited from Project.devDependencyProjects
- Defined in node_modules/fixturify-project/dist/index.d.ts:142

dispose

dispose(): void
Correctly disposes of the project, observing when the directory has been changed.

Returns void
Overrides Project.dispose
- Defined in src/project.ts:57

gitInit

gitInit(): ResultPromise
Runs git init inside a project.

Returns ResultPromise
{ResultPromise}
- Defined in src/project.ts:30

linkDependency

linkDependency(name: string, opts: LinkParams): void
Links a dependency.
Parameters
- name: string
  The name of the dependency to link.
- opts: LinkParams
Returns void
Inherited from Project.linkDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:128

linkDevDependency

linkDevDependency(name: string, opts: LinkParams): void
Links a devDependency.
Parameters
- name: string
  The name of the dependency to link.
- opts: LinkParams
Returns void
Inherited from Project.linkDevDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:134

mergeFiles

mergeFiles(dirJSON: DirJSON): void
Merges an object containing a directory represention with the existing files.
Parameters
- dirJSON: DirJSON
  An object containing a directory representation to merge.
Returns void
Inherited from Project.mergeFiles
- Defined in node_modules/fixturify-project/dist/index.d.ts:89

removeDependency

removeDependency(name: string): void
Removes a dependency to the Project's package.json.
Parameters
- name: string
  The name of the dependency to remove.
Returns void
Inherited from Project.removeDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:116

removeDevDependency

removeDevDependency(name: string): void
Removes a devDependency.
Parameters
- name: string
  The name of the devDependency to remove.
Returns void
Inherited from Project.removeDevDependency
- Defined in node_modules/fixturify-project/dist/index.d.ts:122

write

write(dirJSON?: DirJSON): Promise<void>
Writes the project files to disk.
Parameters
- OptionaldirJSON: DirJSON
  Optional directory JSON to merge before writing.
Returns Promise<void>
Overrides Project.write
- Defined in src/project.ts:38

`Static`fromDir

fromDir(baseDir: string, opts?: ReadDirOpts): Project
Reads an existing project from the specified base dir.
Parameters
- baseDir: string
  The base directory to read the project from.
- Optionalopts: ReadDirOpts
  An options object.
  - linkDeps
    Include linking dependencies from the Project's node_modules.
  - linkDevDeps
    Include linking devDependencies from the Project's node_modules.
Returns Project
- The deserialized Project.
Inherited from Project.fromDir
- Defined in node_modules/fixturify-project/dist/index.d.ts:83

Class BintasticProject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BintasticProject

Properties

files

ReadonlyisDependency

pkg

Accessors

baseDir

Returns string

Memberof

name

Returns string

Memberof

Parameters

Returns void

Memberof

version

Returns string

Memberof

Parameters

Returns void

Memberof

Methods

addDependency

Parameters

Returns Project

Parameters

Returns Project

Parameters

Returns Project

Parameters

Returns Project

Parameters

Returns Project

addDevDependency

Parameters

Returns Project

Parameters

Returns Project

Parameters

Returns Project

Parameters

Returns Project

Parameters

Returns Project

chdir

Returns Promise<void>

clone

Returns Project

dependencyProjects

Returns Project[]

devDependencyProjects

Returns Project[]

dispose

Returns void

gitInit

Returns ResultPromise

linkDependency

Parameters

Returns void

linkDevDependency

Parameters

Returns void

mergeFiles

Parameters

Returns void

removeDependency

Parameters

Returns void

removeDevDependency

Parameters

`Readonly`isDependency

`Static`fromDir