libnodejs

README

libnodejs

Common code shared between Node.js buildpacks

Documentation

Overview

Package libnodejs provides common capabilities for buildpacks interacting with Node.js ecosystem files and configuraton.

Index

• Constants
• func FindNodeApplication(workingDir string) (string, error)
• func FindProjectPath(workingDir string) (string, error)
• func ResolveNodeVersion(resolver nodeResolver, plan packit.BuildpackPlan) (packit.BuildpackPlanEntry, []packit.BuildpackPlanEntry)
• type PackageJSON
  • func ParsePackageJSON(path string) (PackageJSON, error)
  • func (pj PackageJSON) GetVersion() string
  • func (pj PackageJSON) HasStartScript() bool

Constants

const LaunchPointEnvName = "BP_LAUNCHPOINT"

const ProjectPathEnvName = "BP_NODE_PROJECT_PATH"

const StartScriptNameEnvName = "BP_NPM_START_SCRIPT"

const VerifyLaunchPointEnvName = "BP_VERIFY_LAUNCHPOINT"

Functions

func FindNodeApplication

func FindNodeApplication(workingDir string) (string, error)

func FindProjectPath

func FindProjectPath(workingDir string) (string, error)

FindProjectPath will validate that project path exists and is valid relative to the working directory.

func ResolveNodeVersion

func ResolveNodeVersion(resolver nodeResolver, plan packit.BuildpackPlan) (packit.BuildpackPlanEntry, []packit.BuildpackPlanEntry)

Types

type PackageJSON

type PackageJSON struct {
	Engines struct {
		Node string `json:"node"`
	} `json:"engines"`
	Scripts struct {
		PostStart string
		PreStart  string
		Start     string
	}
	Dependencies    map[string]string `json:"dependencies"`
	DevDependencies map[string]string `json:"devDependencies"`

	AllScripts map[string]string `json:"scripts"`
}

PackageJSON represents the contents of a package.json file.

func ParsePackageJSON

func ParsePackageJSON(path string) (PackageJSON, error)

ParsePackageJSON parses the contents of a package.json file.

func (PackageJSON) GetVersion

func (pj PackageJSON) GetVersion() string

func (PackageJSON) HasStartScript

func (pj PackageJSON) HasStartScript() bool

HasStartScript indicates the presence of a start script in the package.json file or as defined by .