Skip to main content

prefer-correct-screenshots

added in: 1.2.0
warning

Warns when a screenshots section has incorrect entries.

You can find all requirements toward this section on the official website.

Example​

❌ Bad:

screenshots:
  - description: 'This screenshot shows the transformation of a number of bytes
  to a human-readable expression.'
    path: path/to/image/in/package/500x500.mp4 # LINT, incorrect format
  - description: 'This screenshot shows a stack trace returning a human-readable
  representation. A stack trace returning a human-readable
  representation.' # LINT, too long
    path: path/to/image/in/package.png

✅ Good:

screenshots:
  - description: 'This screenshot shows the transformation of a number of bytes
  to a human-readable expression.'
    path: path/to/image/in/package/500x500.webp
  - description: 'This screenshot shows a stack trace returning a human-readable
  representation.'
    path: path/to/image/in/package.png