Go to repository

Interface FileDefinition

Models a project type's file definition and the expected behavior of the file.

interface FileDefinition {
    copyOnEject: boolean;
    copyOnInit: boolean;
    copyOnUpdate: boolean;
    gobstonesScriptsLocation: string[];
    isOverridable: boolean;
    name: keyof ProjectTypeDefinition;
    projectLocation: string[];
    requiresReferenceUpdate: boolean;
    requiresTestDataInjection: boolean;
}

Hierarchy (view full)

Properties

copyOnEject copyOnInit copyOnUpdate gobstonesScriptsLocation isOverridable name projectLocation requiresReferenceUpdate requiresTestDataInjection

Properties

copyOnEject

copyOnEject: boolean

Whether this file should be copied on project ejection.

copyOnInit

copyOnInit: boolean

Whether this file should be copied on project initialization.

copyOnUpdate

copyOnUpdate: boolean

Whether this file should be copied on project update.

gobstonesScriptsLocation

gobstonesScriptsLocation: string[]

The location of one or more files in the gobstones-script's path.

isOverridable

isOverridable: boolean

Whether this file represents tooling configuration files that can be overwritten with local configurations.

name

name: keyof ProjectTypeDefinition

The internal name for this file descriptor. Will automatically be set to the key name when creating the list of files.

projectLocation

projectLocation: string[]

The location that the files should have in the local project's folder.

requiresReferenceUpdate

requiresReferenceUpdate: boolean

Whether this file contains reference to the generic project name that should be updates.

requiresTestDataInjection

requiresTestDataInjection: boolean

Whether this file requires the data for testing (verdaccio server data) to be inserted to it.

Settings

Member Visibility

On This Page

Properties