Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Lints

Groups

groupdescriptionlints
allAll lints.artwork-missing, audio-embedded-artwork-aspect-ratio, audio-embedded-artwork-missing, case-conflict, creator-missing, item-title-missing, junk, media-items-missing, media-missing, metadata-missing, mixed-formats, not-generated, package-creator-missing, package-missing, path-component-length, time-missing, title-missing, video-placeholder-dimensions, video-placeholder-missing, windows-leading-space, windows-reserved-character, windows-reserved-filename, windows-trailing-period, windows-trailing-space
compatibilityPaths that may not work on all platforms.case-conflict, path-component-length, windows-leading-space, windows-reserved-character, windows-reserved-filename, windows-trailing-period, windows-trailing-space
distributionLints in the compatibility and hygiene groups.case-conflict, junk, path-component-length, windows-leading-space, windows-reserved-character, windows-reserved-filename, windows-trailing-period, windows-trailing-space
hygieneFiles that shouldn’t be in a package.junk
metadataMissing or inconsistent metadata.artwork-missing, audio-embedded-artwork-aspect-ratio, audio-embedded-artwork-missing, creator-missing, item-title-missing, media-items-missing, media-missing, metadata-missing, mixed-formats, not-generated, package-creator-missing, package-missing, time-missing, title-missing, video-placeholder-dimensions, video-placeholder-missing

Lints

lintdescription
artwork-missingMetadata has artwork.
audio-embedded-artwork-aspect-ratioAudio files’ embedded front cover art is square.
audio-embedded-artwork-missingAudio files have embedded front cover art.
case-conflictPaths do not conflict on case-insensitive filesystems.
creator-missingMetadata has a creator.
item-title-missingMedia items have titles.
junkPackage contains no junk files.
media-items-missingMedia has items.
media-missingMetadata has media.
metadata-missingPackage has metadata.
mixed-formatsMedia items have the same format.
not-generatedDerived assets have been generated.
package-creator-missingPackage metadata has a creator.
package-missingMetadata has a package.
path-component-lengthPath components are at most 255 bytes.
time-missingMetadata has a time.
title-missingMetadata has a title.
video-placeholder-dimensionsPlaceholder images have the same resolution as their videos.
video-placeholder-missingVideos have placeholder images.
windows-leading-spaceFilenames do not begin with a space, which Windows does not allow.
windows-reserved-characterFilenames do not contain characters Windows does not allow.
windows-reserved-filenameFilenames are not reserved by Windows.
windows-trailing-periodFilenames do not end with a period, which Windows does not allow.
windows-trailing-spaceFilenames do not end with a space, which Windows does not allow.

Junk Files

The junk lint fails if the package contains a file with one of the following names: .DS_Store, .filepack, .localized.

Windows Reserved Characters

The windows-reserved-character lint fails if a filename contains one of the following characters: ", *, :, <, >, ?, |.

Windows Reserved Names

The windows-reserved-filename lint fails if a filename , ignoring case, is one of the following names, or one of the following names followed by a period: AUX, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, COM¹, COM², COM³, CON, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9, LPT¹, LPT², LPT³, NUL, PRN.