npm-pkg
Installation
Entrypoint
Types
NpmPkg

npm-pkg

CI pipeline for publishable npm packages (`@oriz/*` scope).
Missing scripts are no-ops via `pnpm run --if-present`.

Installation

dagger install github.com/chirag127/workflows/dagger/npm-pkg@2bd56fd853ba69f656415285cb4d10d80e4bb15b

Entrypoint

Return Type

NpmPkg

Example

dagger -m github.com/chirag127/workflows/dagger/npm-pkg@2bd56fd853ba69f656415285cb4d10d80e4bb15b call \

func (m *MyModule) Example() *dagger.NpmPkg  {
	return dag.
			Npmpkg()
}

@function
def example() -> dagger.NpmPkg:
	return (
		dag.npm_pkg()
	)

@func()
example(): NpmPkg {
	return dag
		.npmPkg()
}

Types

NpmPkg 🔗

lint() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/chirag127/workflows/dagger/npm-pkg@2bd56fd853ba69f656415285cb4d10d80e4bb15b call \
 lint --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Npmpkg().
			Lint(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.npm_pkg()
		.lint(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.npmPkg()
		.lint(source)
}

typecheck() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/chirag127/workflows/dagger/npm-pkg@2bd56fd853ba69f656415285cb4d10d80e4bb15b call \
 typecheck --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Npmpkg().
			Typecheck(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.npm_pkg()
		.typecheck(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.npmPkg()
		.typecheck(source)
}

test() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/chirag127/workflows/dagger/npm-pkg@2bd56fd853ba69f656415285cb4d10d80e4bb15b call \
 test --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Npmpkg().
			Test(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.npm_pkg()
		.test(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.npmPkg()
		.test(source)
}

build() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/chirag127/workflows/dagger/npm-pkg@2bd56fd853ba69f656415285cb4d10d80e4bb15b call \
 build --source DIR_PATH

func (m *MyModule) Example(source *dagger.Directory) *dagger.Directory  {
	return dag.
			Npmpkg().
			Build(source)
}

@function
def example(source: dagger.Directory) -> dagger.Directory:
	return (
		dag.npm_pkg()
		.build(source)
	)

@func()
example(source: Directory): Directory {
	return dag
		.npmPkg()
		.build(source)
}

megalint() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/chirag127/workflows/dagger/npm-pkg@2bd56fd853ba69f656415285cb4d10d80e4bb15b call \
 megalint --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Npmpkg().
			Megalint(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.npm_pkg()
		.megalint(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.npmPkg()
		.megalint(source)
}

ci() 🔗

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/chirag127/workflows/dagger/npm-pkg@2bd56fd853ba69f656415285cb4d10d80e4bb15b call \
 ci --source DIR_PATH

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Npmpkg().
			Ci(ctx, source)
}

@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.npm_pkg()
		.ci(source)
	)

@func()
async example(source: Directory): Promise<string> {
	return dag
		.npmPkg()
		.ci(source)
}

publish() 🔗

Publish to npm. Umbrella-only.

Return Type

String !

Arguments

Name	Type	Default Value	Description
source	Directory !	-	No description provided
npmToken	Secret !	-	No description provided

Example

dagger -m github.com/chirag127/workflows/dagger/npm-pkg@2bd56fd853ba69f656415285cb4d10d80e4bb15b call \
 publish --source DIR_PATH --npm-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, npmToken *dagger.Secret) string  {
	return dag.
			Npmpkg().
			Publish(ctx, source, npmToken)
}

@function
async def example(source: dagger.Directory, npmtoken: dagger.Secret) -> str:
	return await (
		dag.npm_pkg()
		.publish(source, npmtoken)
	)

@func()
async example(source: Directory, npmToken: Secret): Promise<string> {
	return dag
		.npmPkg()
		.publish(source, npmToken)
}