📄 Configuration Files Documentation: angular.json
The angular.json file is a core configuration file in Angular projects. It defines various settings for building, serving, and testing the application. Below is a detailed breakdown of the structure and purpose of the angular.json file in this project.
📚 Overview
The angular.json file configures:
- Build and Serve Configurations: Specifies how the application is built and served.
- Environment-Specific Settings: File replacements for different environments.
- Asset Management: Includes assets like images, styles, and scripts.
- Optimization Settings: Controls build optimization, source maps, and more.
🎯 Key Sections
1. Project Structure
{
"$schema": "./node_modules/@angular/cli/lib/config/schema.json",
"version": 1,
"newProjectRoot": "projects",
"projects": {
"volley-app": {
"projectType": "application",
"schematics": {
"@schematics/angular:component": {
"style": "scss"
}
},
"root": "",
"sourceRoot": "src",
"prefix": "app",
...
}
}
}
newProjectRoot: Specifies the directory for new projects.projects: Contains configurations for thevolley-appAngular project.sourceRoot: Points to the main source folder (src).style: Defines SCSS as the default styling format.
2. Build Configuration
"build": {
"builder": "@angular-devkit/build-angular:browser",
"options": {
"outputPath": "dist/volley-app",
"index": "src/index.html",
"main": "src/main.ts",
"polyfills": "src/polyfills.ts",
"tsConfig": "tsconfig.app.json",
"aot": true,
"assets": [
"src/favicon.ico",
"src/assets"
],
"styles": [
"src/styles.scss",
"src/assets/scss/style.scss",
"node_modules/ngx-toastr/toastr.css",
"node_modules/intl-tel-input/build/css/intlTelInput.css"
],
"scripts": []
}
}
builder: Uses Angular CLI's browser builder for building the application.outputPath: Specifies the directory for build output (dist/volley-app).index,main,polyfills: Points to the main entry files for the application.assets: Includes static files like the favicon and other assets.styles: Lists global stylesheets, including SCSS files and third-party libraries (e.g.,ngx-toastr).aot: Enables Ahead-of-Time compilation for better performance.
3. Environment Configurations
"configurations": {
"production": {
"fileReplacements": [
{
"replace": "src/environments/environment.ts",
"with": "src/environments/environment.prod.ts"
}
],
"optimization": true,
"outputHashing": "all",
"sourceMap": false,
"extractCss": true,
"namedChunks": false,
"extractLicenses": true,
"vendorChunk": false,
"buildOptimizer": true,
"budgets": [
{
"type": "initial",
"maximumWarning": "2mb",
"maximumError": "5mb"
},
{
"type": "anyComponentStyle",
"maximumWarning": "6kb",
"maximumError": "10kb"
}
]
}
}
fileReplacements: Replacesenvironment.tswithenvironment.prod.tsfor production builds.- Optimization Settings:
optimization: Enables production optimizations.outputHashing: Adds hashes to filenames for cache busting.sourceMap: Disabled for production to reduce file size.extractCss: Extracts CSS into separate files.
- Build Budgets:
- Warns if the initial build exceeds
2MBor fails if it exceeds5MB. - Limits component styles to
6KB(warning) and10KB(error).
- Warns if the initial build exceeds
4. Serve Configuration
"serve": {
"builder": "@angular-devkit/build-angular:dev-server",
"options": {
"browserTarget": "volley-app:build"
},
"configurations": {
"production": {
"browserTarget": "volley-app:build:production"
}
}
}
browserTarget: Links the serve command to the build configuration.- Production Mode: Uses the production build settings when serving.
5. Testing Configuration
"test": {
"builder": "@angular-devkit/build-angular:karma",
"options": {
"main": "src/test.ts",
"polyfills": "src/polyfills.ts",
"tsConfig": "tsconfig.spec.json",
"karmaConfig": "karma.conf.js",
"assets": [
"src/favicon.ico",
"src/assets"
],
"styles": [
"src/styles.scss"
],
"scripts": []
}
}
builder: Uses Karma as the testing framework.karmaConfig: Points to the Karma configuration file.- Assets and Styles: Includes assets and global styles for testing.
🎨 Highlights
- SCSS Styling: The project uses SCSS for consistent and modular styles.
- Third-Party Libraries: Includes styles for libraries like
ngx-toastrandintl-tel-input. - Environment-Specific Builds: Supports different configurations for development and production.
- Performance Optimization: Enables build optimizations like Ahead-of-Time (AOT) compilation and CSS extraction.
🛠️ Usage Tips
- Add New Styles/Scripts:
- Update the
stylesorscriptsarray underbuildto include new files.
- Update the
- Environment-Specific Settings:
- Use
fileReplacementsto swap files for different environments.
- Use
- Build Budgets:
- Modify
budgetsto adjust size limits for your application.
- Modify
This configuration ensures a well-structured, optimized, and scalable Angular application. 🚀