package
0.0.0-20240821194349-f2a29133d56e
Repository: https://github.com/googlecloudplatform/buildpacks.git
Documentation: pkg.go.dev

# Functions

AngularAdaptorVersion determines the version of Angular that is needed by an Angular project.
CheckOrClearCache checks whether cached dependencies exist and match.
DefaultStartCommand returns the default command that should be used to configure the application web process if the user has not explicitly configured one.
DetectSvelteKitAutoAdapter returns true if the given package.json file contains the @sveltejs/adapter-auto dependency and no others.
DetermineBuildCommands returns a list of "npm run" commands to be executed during the build and a bool representing whether this is a "custom build" (user-specified build scripts) or a system build step (default build behavior).
EnsureLockfile returns the name of the lockfile, generating a package-lock.json if necessary.
ExtractAngularStartCommand inspects the given package.json file for an idiomatic `serve:ssr:APP_NAME` command.
HasDevDependencies returns true if the given directory contains a package.json file that lists more one or more devDependencies.
HasGCPBuild returns true if the given package.json file includes a "gcp-build" script.
HasScript returns true if the given package.json file defines a script with the given name.
HasYarnWorkspacePlugin returns true if this project has Yarn2's workspaces plugin installed.
InstallAngularBuildAdaptor installs the angular build adaptor in the given layer if it is not already cached.
InstallNextJsBuildAdaptor installs the nextjs build adaptor in the given layer if it is not already cached.
InstallPNPM installs pnpm in the given layer if it is not already cached.
InstallYarn downloads a given version of Yarn into the provided directory.
InstallYarnLayer installs Yarn in the given layer if it is not already cached.
IsNodeJS8Runtime returns true when the GOOGLE_RUNTIME is nodejs8.
IsUsingVendoredDependencies returns true if the builder should be using the vendored dependencies.
IsYarn2 detects whether the given lockfile was generated with Yarn 2.
NodeEnv returns the value of NODE_ENV or `production`.
NPMInstallCommand returns the correct install command based on the version of Node.js.
NuxtStartCommand determines if this is a Nuxt application and returns the command to start the nuxt server.
OverrideAngularBuildScript overrides the build script to be the Angular build script.
OverrideNextjsBuildScript overrides the build script to be the Nextjs build script.
ReadNodeDependencies looks for a package.json and lockfile in either appDir or rootDir.
ReadNxJSONIfExists returns deserialized nx.json from the given dir.
ReadNxProjectJSONIfExists returns deserialized project.json from the given dir.
ReadPackageJSONIfExists returns deserialized package.json from the given dir.
RequestedNodejsVersion returns any customer provided Node.js version constraint by inspecting the environment and the package.json.
RequestedNPMVersion returns any customer provided NPM version constraint configured in the "engines" section of the package.json file in the given application dir.
SkipSyntaxCheck returns true if we should skip checking the user's function file for syntax errors if it is impacted by https://github.com/GoogleCloudPlatform/functions-framework-nodejs/issues/407.
SupportsNPMPrune returns true if the version of npm installed in the system supports the prune command.
SvelteKitStartCommand determines if this is a SvelteKit application and returns the command to start the SvelteKit server.
UseFrozenLockfile returns an true if the environment supporte Yarn's --frozen-lockfile flag.
Version tries to get the concrete package version used based on lock file.

# Constants

AppHostingBuildEnv is the env var that contains the build command to run for Firebase backends.
EnvDevelopment represents a NODE_ENV development value.
EnvNodeEnv is the name of the NODE_ENV environment variable.
EnvNodeVersion can be used to specify the version of Node.js is used for an app.
EnvProduction represents a NODE_ENV production value.
GoogleNodeRunScriptsEnv is the env var that can be used to configure a list of package.json scripts that should be run during the build process.
NPMShrinkwrap is the name of the npm shrinkwrap file.
PackageLock is the name of the npm lock file.
ScriptBuild is the name of npm build scripts.
ScriptGCPBuild is the name of "gcp-build" scripts.
SvelteAdapterEnv is an env var that enables SvelteKit to detect Google Cloud Buildpacks and use adapter-node when adapter-auto is detected https://github.com/sveltejs/kit/blob/main/packages/adapter-auto/adapters.js.
VendorNpmDeps for vendoring npm dependencies.
YarnLock is the name of the yarn lock file.

# Variables

PinnedAngularAdapterVersion is the version of the angular adapter that will be used.
PinnedNextjsAdapterVersion is the version of the nextjs adapter that will be used.
PNPMLock is the name of the pnpm lock file.

# Structs

NodeDependencies represents the dependencies of a Node package via its package.json and lockfile.
NpmLockfile represents the contents of a lock file generated with npm.
NxBuild specifies the structure of an Nx build target config.
NxJSON represents the contents of a nx.json file.
NxProjectJSON represents the contents of a project.json file.
NxTargets specifies configs for Nx execution targets.
PackageJSON represents the contents of a package.json file.
PnpmV6Lockfile represents the contents of a lock file v6 generated with pnpm.
PnpmV9Lockfile represents the contents of a lock file v9 generated with pnpm.