Skip to content

✅ Check

Checks whether composer.json and composer.lock are in sync and whether dependencies meet the requirements (runs composer check).

When to use

Use for consistency validation after installing or updating dependencies, or to assert in CI that the lock file is not outdated.

Signature

go
func (c *Composer) Check() (string, error)

Parameters

ParameterTypeDescription
NoneThis method takes no parameters

Return value

  • string: Raw output text of composer check
  • error: Returned when the command fails

Example

go
package main

import (
    "fmt"
    "log"

    "github.com/scagogogo/composer-skills/pkg/composer"
)

func main() {
    comp, err := composer.New(composer.DefaultOptions())
    if err != nil {
        log.Fatal(err)
    }

    output, err := comp.Check()
    if err != nil {
        log.Fatalf("check failed: %v", err)
    }
    fmt.Println(output)
}

Advanced

  • For structured results (Valid + error/warning lists), use CheckStructured
  • To attach options, use CheckWithOptions (see diagnosis.go)
  • To specifically validate the composer.json schema, use the Validate family (see validate.go / config.go)

Released under the MIT License