Module "pack/docker/support/name"

cleanImageName

• cleanImageName(name: string, hubOwner?: boolean): string

• Remove any invalid characters from Docker image name component name to make it a valid Docker image name component. If hubOwner is true, it ensures the name contains only alphanumeric characters.

  From https://docs.docker.com/engine/reference/commandline/tag/:

  An image name is made up of slash-separated name components, optionally prefixed by a registry hostname. The hostname must comply with standard DNS rules, but may not contain underscores. If a hostname is present, it may optionally be followed by a port number in the format :8080. If not present, the command uses Docker’s public registry located at registry-1.docker.io by default. Name components may contain lowercase letters, digits and separators. A separator is defined as a period, one or two underscores, or one or more dashes. A name component may not start or end with a separator.

  A tag name must be valid ASCII and may contain lowercase and uppercase letters, digits, underscores, periods and dashes. A tag name may not start with a period or a dash and may contain a maximum of 128 characters.

  Parameters

  • name: string

    Name component to clean up.

  • Default value hubOwner: boolean = false

    If true only allow characters valid for a Docker Hub user/org

  Returns string

  Valid Docker image name component.