pubspec.yaml is one of the most important configuration files in a Flutter project. It is written using YAML syntax and is normally located at the root of the Flutter project. It contains project metadata, Dart and Flutter SDK constraints, dependencies, development dependencies, assets, fonts, and other project configuration.
The pubspec.yaml file describes important information about a Flutter application or package. When a Flutter project is created, Flutter automatically generates a basic pubspec.yaml file.
Flutter uses this file to understand which packages, assets, fonts, and Flutter-specific configurations are required by the application.
Flutter Project
|
v
pubspec.yaml
|
+-- Project Information
+-- SDK Version
+-- Dependencies
+-- Dev Dependencies
+-- Assets
+-- Fonts
+-- Flutter Configuration
|
v
flutter pub get
|
v
Dependencies and Resources AvailableThe pubspec.yaml file is located in the root directory of a Flutter project.
my_flutter_app/
├── android/
├── ios/
├── lib/
│ └── main.dart
├── test/
├── web/
├── pubspec.yaml
├── pubspec.lock
└── README.mdname: my_flutter_app
description: A Flutter application
publish_to: 'none'
version: 1.0.0+1
environment:
sdk: ^3.0.0
dependencies:
flutter:
sdk: flutter
dev_dependencies:
flutter_test:
sdk: flutter
flutter_lints: ^6.0.0
flutter:
uses-material-design: true
pubspec.yaml uses YAML syntax. YAML is indentation-sensitive, so spaces are important.
dependencies:
flutter:
sdk: flutter
http: ^1.0.0In YAML, indentation represents the relationship between keys and values. Incorrect indentation can cause configuration errors.
Use consistent spaces for indentation. Avoid using tabs in YAML configuration.
The name field specifies the package or application name.
name: my_flutter_appThe name should follow Dart package naming conventions, typically using lowercase letters and underscores.
name: ecommerce_appThe description field provides a short description of the project.
description: A Flutter e-commerce applicationThis field is particularly useful for packages that may be published and shared.
The publish_to field can be used to specify where a package should be published.
For an application that should not be published to pub.dev, it is commonly set to:
publish_to: 'none'This indicates that the project is not intended to be published to pub.dev.
The version field defines the application or package version.
version: 1.0.0+1The version commonly contains a semantic version followed by a build number.
| Part | Example | Purpose |
|---|---|---|
| Major | 1 | Major release version. |
| Minor | 0 | Minor feature release. |
| Patch | 0 | Bug-fix version. |
| Build | 1 | Build number. |
The environment section defines SDK compatibility requirements.
environment:
sdk: ^3.0.0This tells Dart which SDK versions are compatible with the project according to the specified constraint.
environment:
sdk: '>=3.0.0 <4.0.0'The dependencies section contains packages required by the application at runtime.
dependencies:
flutter:
sdk: flutter
http: ^1.0.0
provider: ^6.0.0Here, flutter, http, and provider are dependencies.
A standard Flutter application normally includes the Flutter SDK as a dependency.
dependencies:
flutter:
sdk: flutterThe sdk: flutter syntax tells Dart to use the Flutter SDK package rather than downloading a package with that name from pub.dev.
External packages can be added to the dependencies section.
dependencies:
flutter:
sdk: flutter
http: ^1.0.0
shared_preferences: ^2.0.0After adding dependencies, run:
flutter pub getInstead of manually editing pubspec.yaml, a package can be added using the Flutter command-line tool.
flutter pub add httpThe command updates the project's dependency configuration and retrieves the package.
The dev_dependencies section contains packages mainly used during development, testing, analysis, and code generation.
dev_dependencies:
flutter_test:
sdk: flutter
flutter_lints: ^6.0.0| Package | Purpose |
|---|---|
| flutter_test | Unit and widget testing. |
| integration_test | Integration testing on target devices or emulators. |
| flutter_lints | Recommended linting rules for Flutter projects. |
The flutter_test package provides testing utilities for Flutter applications.
dev_dependencies:
flutter_test:
sdk: flutterThe flutter_lints package provides recommended linting rules for Flutter projects.
dev_dependencies:
flutter_lints: ^6.0.0Linting helps developers identify potential problems and maintain consistent Dart and Flutter code.
The flutter section contains Flutter-specific project configuration.
flutter:
uses-material-design: trueThis section can also contain assets, fonts, localization-related generation settings, shaders, licenses, and other Flutter-specific options.
The uses-material-design` field enables the Material icon font for applications that use Material icons.
flutter:
uses-material-design: trueIcon(
Icons.home,
)Assets are files that are bundled with the Flutter application. Common assets include images, JSON files, icons, and other static resources.
Assets are declared inside the flutter section.
flutter:
assets:
- assets/images/logo.png
- assets/images/banner.pngInstead of listing every file individually, a directory can be included.
flutter:
assets:
- assets/images/The directory path should end with /.
After registering an image in pubspec.yaml, it can be loaded using Image.asset().
Image.asset(
'assets/images/logo.png',
)flutter:
uses-material-design: true
assets:
- assets/images/logo.pngJSON files can also be registered as assets.
flutter:
assets:
- assets/data/products.jsonThe application can then read the file using Dart's asset-loading APIs.
Custom fonts can be registered through the fonts section inside flutter.
flutter:
fonts:
- family: RobotoCustom
fonts:
- asset: fonts/Roboto-Regular.ttf
- asset: fonts/Roboto-Bold.ttf
weight: 700After registering a font, the family name can be used in a Flutter TextStyle.
Text(
'Hello Flutter',
style: TextStyle(
fontFamily: 'RobotoCustom',
),
)Different font files can be associated with weights and styles.
flutter:
fonts:
- family: MyFont
fonts:
- asset: fonts/MyFont-Regular.ttf
- asset: fonts/MyFont-Bold.ttf
weight: 700
- asset: fonts/MyFont-Italic.ttf
style: italicThe Flutter SDK provides the flutter_localizations package for localization support.
dependencies:
flutter:
sdk: flutter
flutter_localizations:
sdk: flutter
intl: anyThis can be used when an application needs to support multiple languages and locales.
The integration_test package provides tools for running integration tests on target devices or emulators.
dev_dependencies:
integration_test:
sdk: flutterThe cupertino_icons package provides Apple's Cupertino-style icons.
dependencies:
cupertino_icons: ^1.0.0Icon(
CupertinoIcons.home,
)Package dependencies normally include version constraints.
dependencies:
http: ^1.0.0Version constraints allow the Dart package manager to determine compatible versions.
| Constraint | Example | Purpose |
|---|---|---|
| Exact | 1.2.0 | Specifies one exact version. |
| Caret | ^1.2.0 | Allows compatible versions according to Dart's constraint rules. |
| Range | >=1.0.0 <2.0.0 | Defines a minimum and maximum boundary. |
The pubspec.lock file records the specific versions selected for direct and transitive dependencies.
For Flutter application projects, the lock file is normally committed to version control so that development and build environments use the same resolved package versions.
| Feature | pubspec.yaml | pubspec.lock |
|---|---|---|
| Purpose | Defines project configuration and dependency constraints. | Records resolved dependency versions. |
| Created | Usually created with the project. | Generated during dependency resolution. |
| Dependencies | Declares requested dependencies. | Records selected versions. |
| Editing | Frequently edited by developers. | Normally generated and updated by package tooling. |
name: ecommerce_app
description: A Flutter e-commerce application
publish_to: 'none'
version: 1.0.0+1
environment:
sdk: ^3.0.0
dependencies:
flutter:
sdk: flutter
cupertino_icons: ^1.0.0
http: ^1.0.0
provider: ^6.0.0
shared_preferences: ^2.0.0
dev_dependencies:
flutter_test:
sdk: flutter
flutter_lints: ^6.0.0
flutter:
uses-material-design: true
assets:
- assets/images/
fonts:
- family: CustomFont
fonts:
- asset: fonts/CustomFont-Regular.ttf
- asset: fonts/CustomFont-Bold.ttf
weight: 700
ecommerce_app/
├── android/
├── ios/
├── lib/
│ ├── main.dart
│ ├── screens/
│ ├── widgets/
│ ├── models/
│ └── services/
├── assets/
│ ├── images/
│ └── data/
├── fonts/
│ ├── CustomFont-Regular.ttf
│ └── CustomFont-Bold.ttf
├── test/
├── pubspec.yaml
├── pubspec.lock
└── README.mdpubspec.yaml.flutter pub get.After changing dependencies in pubspec.yaml, run:
flutter pub getThis resolves and retrieves the packages specified by the project.
A package can be added from the terminal using:
flutter pub add httpThis is generally easier than manually entering the package and version constraint.
A dependency can be removed using:
flutter pub remove httpThe command updates the project's dependency configuration.
To inspect dependency versions and available updates, use:
flutter pub outdatedDependencies can be updated within their declared constraints using:
flutter pub upgradeMajor-version constraint updates can be attempted using:
flutter pub upgrade --major-versionsMajor upgrades should be tested carefully because they can introduce breaking API changes.
dependencies:
flutter:
sdk: flutterThe above structure is incorrectly indented. The correct structure is:
dependencies:
flutter:
sdk: flutterflutter:
assets:
- image/logo.pngMake sure the file actually exists at the specified location.
Run:
flutter pub getVerify that the package name and dependency declaration are correct.
flutter pub get after dependency changes.Suppose an e-commerce application requires API communication, local storage, state management, custom fonts, and product images.
name: ecommerce_app
environment:
sdk: ^3.0.0
dependencies:
flutter:
sdk: flutter
http: ^1.0.0
provider: ^6.0.0
shared_preferences: ^2.0.0
dev_dependencies:
flutter_test:
sdk: flutter
flutter_lints: ^6.0.0
flutter:
uses-material-design: true
assets:
- assets/images/
fonts:
- family: AppFont
fonts:
- asset: fonts/AppFont-Regular.ttf
- asset: fonts/AppFont-Bold.ttf
weight: 700
This configuration allows the application to organize external packages, development tools, images, and fonts in one central configuration file.
pubspec.yaml is the YAML configuration file used to define Flutter project metadata, dependencies, assets, fonts, SDK constraints, and Flutter-specific settings.
It is normally located in the root directory of the Flutter project.
It contains packages required by the application.
It contains packages mainly required during development, testing, analysis, and related development tasks.
flutter pub add package_nameflutter pub getflutter:
assets:
- assets/images/flutter:
fonts:
- family: MyFont
fonts:
- asset: fonts/MyFont-Regular.ttfIt records the specific versions selected for the project's direct and transitive dependencies.
YAML uses indentation to represent the structure of configuration data, so incorrect indentation can cause parsing or configuration errors.
pubspec.yaml is a central configuration file in Flutter projects.flutter pub get retrieves and resolves dependencies.flutter pub add can add packages from the command line.pubspec.lock records resolved dependency versions.JustAcademy Flutter Training Course
Register for Flutter Course Demo
