Method Install

core/schema/modulesource.go:64–290

(dag *dagql.Server)

var _ SchemaResolvers = &moduleSourceSchema{}

func (s *moduleSourceSchema) Install(dag *dagql.Server) {
	dagql.Fields[*core.Query]{
		dagql.NodeFunc("moduleSource", s.moduleSource).
			WithInput(dagql.PerClientInput).
			Doc(`Create a new module source instance from a source ref string`).
			Args(
				dagql.Arg("refString").Doc(`The string ref representation of the module source`),
				dagql.Arg("refPin").Doc(`The pinned version of the module source`),
				dagql.Arg("disableFindUp").Doc(`If true, do not attempt to find dagger.json in a parent directory of the provided path. Only relevant for local module sources.`),
				dagql.Arg("allowNotExists").Doc(`If true, do not error out if the provided ref string is a local path and does not exist yet. Useful when initializing new modules in directories that don't exist yet.`),
				dagql.Arg("requireKind").Doc(`If set, error out if the ref string is not of the provided requireKind.`),
			),
	}.Install(dag)

	dagql.Fields[*core.Directory]{
		dagql.NodeFunc("asModule", s.directoryAsModule).
			Doc(`Load the directory as a Dagger module source`).
			Args(
				dagql.Arg("sourceRootPath").Doc(
					`An optional subpath of the directory which contains the module's configuration file.`,
					`If not set, the module source code is loaded from the root of the directory.`),
			),
		dagql.NodeFunc("asModuleSource", s.directoryAsModuleSource).
			Doc(`Load the directory as a Dagger module source`).
			Args(
				dagql.Arg("sourceRootPath").Doc(
					`An optional subpath of the directory which contains the module's configuration file.`,
					`If not set, the module source code is loaded from the root of the directory.`),
			),
	}.Install(dag)

	dagql.Fields[*core.ModuleSource]{
		// sync is used by external dependencies like daggerverse
		Syncer[*core.ModuleSource]().
			Doc(`Forces evaluation of the module source, including any loading into the engine and associated validation.`),

		dagql.Func("sourceSubpath", s.moduleSourceSubpath).
			Doc(`The path to the directory containing the module's source code, relative to the context directory.`),

		dagql.Func("originalSubpath", s.moduleSourceOriginalSubpath).
			Doc(`The original subpath used when instantiating this module source, relative to the context directory.`),

		dagql.Func("digest", s.moduleSourceDigest).
			Doc(`A content-hash of the module source. Module sources with the same digest will output the same generated context and convert into the same module instance.`),

		// NOTE: if/when this turns public, think about a less confusing and future proof name: `includes`, `includePaths`, `includePatterns`
		// which would be relative to the context directory, while the same suggestions with an `original` prefix could mean the `Include` field
		// as it was in the dagger.json.
		dagql.Func("_rebasedIncludePaths", s.moduleSourceRebasedIncludePaths).
			Doc(`List of include paths from dagger.json, relative to the context directory.`),

		dagql.Func("withSourceSubpath", s.moduleSourceWithSourceSubpath).
			WithInput(dagql.PerClientInput).
			Doc(`Update the module source with a new source subpath.`).
			Args(
				dagql.Arg("path").Doc(`The path to set as the source subpath. Must be relative to the module source's source root directory.`),
			),