pubspec.yaml (SchemaStore) JSON Schema

Type	object
File match	`pubspec.yaml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/pubspec-yaml/latest.json
Source	https://www.schemastore.org/pubspec.json

Validate with Lintel

npx @lintel/lintel check

Type: object

Dart Pubspec file

Properties

name string required

The name of this package. The name is how other packages refer to yours, should you publish it. Learn more

Examples: "path", "convert", "http"

pattern=[a-z0-9_]

version string

pattern=^\d+\.\d+\.\d+(?:[+-]\S+)?$

description string

A short, plain text sales-pitch for your package in English. Learn More

Examples:

"A string-based path manipulation library. All of the path operations you know and love, with solid support for Windows, POSIX (Linux and Mac OS X), and the web."

, "Utilities for converting between data representations. Provides a number of Sink, Codec, Decoder, and Encoder types.", "A composable, multi-platform, Future-based API for HTTP requests."

homepage string | null

A URL pointing to the website for your package. Learn more

Examples: "https://flutter.dev", "https://dart.dev/"

format=uri

repository string

The optional repository field should contain the URL for your package's source code repository. Learn more

Examples: "https://github.com/flutter/flutter"

format=uri

issue_tracker string

A URL for the package's issue tracker, where existing bugs can be viewed and new bugs can be filed. Learn more

Examples: "https://github.com/flutter/flutter/issues"

format=uri

documentation string

A site that hosts documentation, separate from the main homepage and from the Pub-generated API reference. Learn more

Examples: "https://flutter.dev/docs", "https://dart.dev/guides"

format=uri

executables Record<string, string | null>

A package may expose one or more of its scripts as executables that can be run directly from the command line. Learn more

Examples: {"dartfmt":"bin/dartfmt.dart","dartdoc":null}

platforms object

The platforms field specifies which platforms the package supports. Learn more

6 nested properties

android null

ios null

linux null

macos null

web null

windows null

publish_to string

Can be used to specify a custom pub package server to publish. Specify none to prevent a package from being published. Learn more.

One of: string string, string string

funding string[]

List of URLs where users can sponsor development of the package. Learn more.

Examples: ["https://www.buymeacoffee.com/example_user","https://www.patreon.com/some-account"]

false_secrets array

Gitignore style list of files where pub will not search for accidentally exposed keys. Learn more.

Examples: ["/lib/src/hardcoded_api_key.dart","/test/localhost_certificates/*.pem"]

screenshots object[]

Showcase widgets or other visual elements using screenshots displayed that will be displayed on pub.dev. Learn more.

maxItems=10

topics string[]

Pub.dev displays the topics on the package page as well as in the search results. See the list of available topics Learn more.

Examples: ["network","http"], ["graphql","langchain","wasm"]

maxItems=5

ignored_advisories string[]

A list of security advisory identifiers that are ignored for this package. See pub.dev Security Advisories Learn more.

environment Record<string, string | version | string | string>

Examples: {"sdk":">=1.19.0 <3.0.0","flutter":"^0.1.2"}

workspace string[]

resolution string

Values: "external" "local" "workspace"

flutter object | null

Flutter-specific metadata. Learn more.

5 nested properties

uses-material-design boolean

Whether this project uses the Material Design package. Required if you use the Material icon font

Default: true

generate boolean

Enables generation of localized strings from arb files

Default: false

assets string | object[]

A list of directories or files that contain images or other assets. Learn more.

Examples: ["images/","fonts/"],

["my_icon.png",{"path":"svg/","transformers":[{"package":"vector_graphics_compiler","args":["--tessellate","--font-size=14"]}]}]

fonts object[]

A list of font families and their fonts. Learn more.

shaders string[]

Shaders, in the form of GLSL files with the .frag extension. The Flutter command-line tool compiles the shader to its appropriate backend format, and generates its necessary runtime metadata. The compiled shader is then included in the application just like an asset. Learn more

Examples: ["shaders/triangle.frag","glsl/motion_blur.frag"]

Definitions

version string

versionConstraint string | version | string | string

Version range of the package or SDK to use