Skip to content

Commit d72475b

Browse files
committed
chore: rename "blueprint" to "booster" in documentation and scripts
1 parent fe49b4a commit d72475b

File tree

9 files changed

+43
-43
lines changed

9 files changed

+43
-43
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Blueprint
1+
# Booster
22

33
A curated collection of tools and best practices for PHP development.
44

@@ -10,7 +10,7 @@ A curated collection of tools and best practices for PHP development.
1010

1111
## Requirements
1212

13-
You can use this blueprint with or without [DDEV](https://ddev.com/).
13+
You can use this booster with or without [DDEV](https://ddev.com/).
1414
If you wish to use DDEV for local development, please install it by following their [installation instructions](https://ddev.com/).
1515

1616
## Documentation
@@ -19,11 +19,11 @@ The documentation is available at [https://terrorsquad.github.io/php-blueprint/]
1919

2020
## Adding to an Existing PHP Project
2121

22-
To integrate the blueprint into your existing PHP project:
22+
To integrate the booster into your existing PHP project:
2323

2424
1. In your PHP project root, check out a new branch and make sure you have no uncommitted changes.
2525

26-
2. Run the following command to integrate the blueprint into your project:
26+
2. Run the following command to integrate the booster into your project:
2727

2828
```bash
2929
curl -sSL https://raw.githubusercontent.com/TerrorSquad/php-blueprint/main/blueprint/integrate_blueprint.sh | bash

blueprint/integrate_blueprint.sh

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ function download_php_blueprint() {
8585
rm -rf "$BLUEPRINT_TARGET_DIR" # Remove target dir if it exists
8686

8787
# Clone only the main branch and only the latest commit for speed
88-
git clone --depth 1 --branch main "$BLUEPRINT_REPO_URL" "$BLUEPRINT_TARGET_DIR" || error "Failed to clone blueprint repository."
88+
git clone --depth 1 --branch main "$BLUEPRINT_REPO_URL" "$BLUEPRINT_TARGET_DIR" || error "Failed to clone booster repository."
8989

9090
if [ ! -d "$BLUEPRINT_TARGET_DIR" ]; then
9191
error "Target directory '$BLUEPRINT_TARGET_DIR' not found after clone."
@@ -121,7 +121,7 @@ function update_ddev_files() {
121121
# Copy the source directory *into* the destination directory
122122
cp -R $src_path/. "$dest_path" || warn "Failed to copy '$src_path'. Check permissions."
123123
else
124-
log " Blueprint DDEV subdirectory '$subdir' not found at '$src_path'. Skipping."
124+
log " Booster DDEV subdirectory '$subdir' not found at '$src_path'. Skipping."
125125
fi
126126
done
127127
success "ddev files updated."
@@ -143,8 +143,8 @@ function update_ddev_config() {
143143
return
144144
fi
145145

146-
# 1. Extract hooks from blueprint config (handle potential errors)
147-
log " Extracting hooks from blueprint config..."
146+
# 1. Extract hooks from booster config (handle potential errors)
147+
log " Extracting hooks from booster config..."
148148
if ! yq '.hooks' "$blueprint_config" >"$hooks_tmp"; then
149149
warn "Failed to extract hooks using yq from '$blueprint_config'. Skipping hook merge."
150150
rm -f "$hooks_tmp"
@@ -186,7 +186,7 @@ function copy_files() {
186186
# Use standard recursive copy -R. This copies the source item into the dest dir.
187187
cp -R "$src_path" "${dest_path}" || warn "Failed to copy '$src_path'. Check permissions."
188188
else
189-
log " Blueprint item '$item' not found at '$src_path'. Skipping."
189+
log " Booster item '$item' not found at '$src_path'. Skipping."
190190
fi
191191
done
192192
success "Common files copied. Verify the copied files and their paths."
@@ -206,11 +206,11 @@ function update_package_json() {
206206

207207
if [ ! -f "$project_pkg" ]; then
208208
log "'$project_pkg' not found. Copying from blueprint..."
209-
cp "$blueprint_pkg" "$project_pkg" || error "Failed to copy blueprint package.json."
209+
cp "$blueprint_pkg" "$project_pkg" || error "Failed to copy booster package.json."
210210
success "package.json copied from blueprint."
211211
else
212212
log "'$project_pkg' already exists. Merging scripts, devDependencies, and volta sections..."
213-
# Merge using jq: project + blueprint (blueprint overwrites simple keys, merges objects)
213+
# Merge using jq: project + booster (blueprint overwrites simple keys, merges objects)
214214
# This merges top-level objects like scripts, devDependencies, volta
215215
jq -s '
216216
.[0] as $proj | .[1] as $blue |
@@ -237,7 +237,7 @@ function update_package_json() {
237237
# --- Updated merge_scripts Function ---
238238
function merge_scripts() {
239239
local COMPOSER1="composer.json" # Project composer.json
240-
local COMPOSER2="${BLUEPRINT_INTERNAL_PATH}/composer.json" # Blueprint composer.json
240+
local COMPOSER2="${BLUEPRINT_INTERNAL_PATH}/composer.json" # Booster composer.json
241241
local OUTPUT="composer.json.merged.tmp"
242242

243243
# Ensure jq is available
@@ -252,10 +252,10 @@ function merge_scripts() {
252252
# Create a temporary copy to work on
253253
cp "$COMPOSER1" "$OUTPUT"
254254

255-
# Get script keys from blueprint composer.json, handle null/missing scripts section
255+
# Get script keys from booster composer.json, handle null/missing scripts section
256256
# Use jq -e to check exit status if .scripts is null or not an object
257257
if ! jq -e '(.scripts // {}) | type == "object"' "$COMPOSER2" >/dev/null; then
258-
log "No valid 'scripts' object found in blueprint composer.json. Nothing to merge."
258+
log "No valid 'scripts' object found in booster composer.json. Nothing to merge."
259259
rm "$OUTPUT" # Clean up temp file
260260
return 0
261261
fi
@@ -271,7 +271,7 @@ function merge_scripts() {
271271
local proj_type=$(jq -r 'type' <<<"$proj_script_json")
272272
local blue_type=$(jq -r 'type' <<<"$blue_script_json")
273273

274-
log " Project type: $proj_type, Blueprint type: $blue_type"
274+
log " Project type: $proj_type, Booster type: $blue_type"
275275

276276
local merged_script_json
277277

@@ -294,14 +294,14 @@ function merge_scripts() {
294294
log " Both scripts are arrays, merging uniquely."
295295
merged_script_json=$(jq -n --argjson p "$proj_script_json" --argjson b "$blue_script_json" '($p + $b) | unique')
296296
elif [ "$proj_type" == "string" ] && [ "$blue_type" == "array" ]; then
297-
log " Project is string, blueprint is array. Merging uniquely."
297+
log " Project is string, booster is array. Merging uniquely."
298298
merged_script_json=$(jq -n --argjson p "$proj_script_json" --argjson b "$blue_script_json" '([$p] + $b) | unique')
299299
elif [ "$proj_type" == "array" ] && [ "$blue_type" == "string" ]; then
300-
log " Project is array, blueprint is string. Merging uniquely."
300+
log " Project is array, booster is string. Merging uniquely."
301301
merged_script_json=$(jq -n --argjson p "$proj_script_json" --argjson b "$blue_script_json" '($p + [$b]) | unique')
302302
else
303303
# Handle other mismatches (e.g., object vs string) - prefer blueprint? Or keep project? Let's prefer blueprint.
304-
log " Type mismatch ($proj_type vs $blue_type). Using blueprint version."
304+
log " Type mismatch ($proj_type vs $blue_type). Using booster version."
305305
merged_script_json="$blue_script_json"
306306
fi
307307
fi
@@ -333,7 +333,7 @@ function update_tool_paths() {
333333
# Use standard recursive copy -R
334334
cp -R "$blueprint_doc_path/." "documentation" || warn "Failed to copy documentation directory."
335335
else
336-
log " Blueprint documentation directory not found. Skipping."
336+
log " Booster documentation directory not found. Skipping."
337337
fi
338338

339339
# --- Copy Config Files ---
@@ -343,7 +343,7 @@ function update_tool_paths() {
343343
if [ -f "$src_path" ]; then
344344
cp "$src_path" . || warn "Failed to copy '$src_path'."
345345
else
346-
log " Blueprint config '$file' not found. Skipping."
346+
log " Booster config '$file' not found. Skipping."
347347
fi
348348
done
349349

@@ -500,7 +500,7 @@ function add_code_quality_tools() {
500500
# --- Update composer.json ---
501501
log "Updating composer.json..."
502502
if [ ! -f "$project_composer" ]; then
503-
warn "'$project_composer' not found. Cannot merge scripts or add dependencies. Consider copying blueprint composer.json first."
503+
warn "'$project_composer' not found. Cannot merge scripts or add dependencies. Consider copying booster composer.json first."
504504
return
505505
fi
506506
if [ ! -f "$blueprint_composer" ]; then
@@ -531,10 +531,10 @@ function add_code_quality_tools() {
531531
# Run update afterwards to ensure scripts run if needed, though maybe not desired here?
532532
# "${composer_cmd[@]}" update --lock # Or just rely on the dev require below
533533
else
534-
log "No production dependencies found in blueprint composer.json 'require' section."
534+
log "No production dependencies found in booster composer.json 'require' section."
535535
fi
536536
else
537-
log "No 'require' object found in blueprint composer.json."
537+
log "No 'require' object found in booster composer.json."
538538
fi
539539

540540
# Install dev dependencies
@@ -547,10 +547,10 @@ function add_code_quality_tools() {
547547
# Run composer require --dev normally, allowing its scripts to run *after* install/update
548548
echo "$dev_deps" | xargs "${composer_cmd[@]}" require --dev || warn "Failed to install/update some dev dependencies. Check composer output."
549549
else
550-
log "No development dependencies found in blueprint composer.json 'require-dev' section."
550+
log "No development dependencies found in booster composer.json 'require-dev' section."
551551
fi
552552
else
553-
log "No 'require-dev' object found in blueprint composer.json."
553+
log "No 'require-dev' object found in booster composer.json."
554554
fi
555555

556556
success "composer.json updated with merged scripts and new dependencies."
@@ -566,11 +566,11 @@ function update_readme() {
566566
# Future enhancement: Append snippet if a placeholder exists?
567567
else
568568
if [ -f "$blueprint_snippet" ]; then
569-
warn "'$project_readme' not found. Creating new README.md from blueprint snippet..."
569+
warn "'$project_readme' not found. Creating new README.md from booster snippet..."
570570
cp "$blueprint_snippet" "$project_readme" || error "Failed to copy README snippet."
571571
success "New README.md created with content from '$blueprint_snippet'."
572572
else
573-
warn "'$project_readme' not found, and blueprint snippet '$blueprint_snippet' also not found. Skipping."
573+
warn "'$project_readme' not found, and booster snippet '$blueprint_snippet' also not found. Skipping."
574574
fi
575575
fi
576576
}
@@ -589,7 +589,7 @@ function update_gitignore() {
589589
touch "$project_gitignore"
590590

591591
local added_count=0
592-
# Read blueprint gitignore line by line
592+
# Read booster gitignore line by line
593593
while IFS= read -r line || [[ -n "$line" ]]; do
594594
# Trim whitespace (optional, depends on desired behavior)
595595
line=$(echo "$line" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
@@ -622,7 +622,7 @@ function update_gitignore() {
622622
log " Added header to .gitignore"
623623
fi
624624
echo "$line" >>"$project_gitignore"
625-
added_count=$((added_count+1))
625+
added_count=$((added_count + 1))
626626
fi
627627
done <"$blueprint_gitignore"
628628

docs/app.config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// https://github.com/nuxt-themes/docus/blob/main/nuxt.schema.ts
22
export default defineAppConfig({
33
docus: {
4-
title: 'PHP Blueprint',
5-
description: 'Your PHP Blueprint for success',
4+
title: 'PHP Booster',
5+
description: 'Your PHP Booster for success',
66

77
aside: {
88
level: 0,
@@ -22,7 +22,7 @@ export default defineAppConfig({
2222
fluid: false
2323
},
2424

25-
titleTemplate: '%s · PHP Blueprint',
25+
titleTemplate: '%s · PHP Booster',
2626

2727
socials: {
2828
github: 'terrorsquad/php-blueprint',

docs/content/0.index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ secondary:
2222
Elevate Your PHP Development
2323

2424
#description
25-
The PHP Blueprint provides a curated collection of best practices, tools, and resources to empower you to build robust, maintainable, and modern PHP applications.
25+
The PHP Booster provides a curated collection of best practices, tools, and resources to empower you to build robust, maintainable, and modern PHP applications.
2626

2727
#extra
2828
::list

docs/content/3.tools/3.static_analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ layout: default
1010

1111
Static analysis is a powerful technique for analyzing your code without actually executing it. It helps identify potential errors, inconsistencies, and code smells early in the development process, leading to more robust and maintainable PHP applications.
1212

13-
In this Blueprint, we leverage two leading static analysis tools: [PHPStan](https://phpstan.org/) and [Psalm](https://psalm.dev/). Let's explore how they work and how to integrate them into your PHP projects.
13+
In this Booster, we leverage two leading static analysis tools: [PHPStan](https://phpstan.org/) and [Psalm](https://psalm.dev/). Let's explore how they work and how to integrate them into your PHP projects.
1414

1515
## PHPStan: Your Code's Guardian Angel
1616

docs/content/3.tools/4.git_hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ layout: default
1010

1111
Git hooks are scripts that run automatically at specific points in your Git workflow, such as before a commit or before a push. They provide a powerful way to automate tasks, enforce coding standards, and ensure code quality before changes are shared with your team.
1212

13-
In this Blueprint, we utilize Husky to manage Git hooks and CommitLint to enforce consistent commit message formatting.
13+
In this Booster, we utilize Husky to manage Git hooks and CommitLint to enforce consistent commit message formatting.
1414

1515
## Husky: Simplifying Git Hooks Management
1616

docs/content/3.tools/5.api_documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ layout: default
88

99
## Introduction
1010

11-
Clear and comprehensive API documentation is essential for effective communication between developers and consumers of your API. In this Blueprint, we utilize Swagger-PHP to annotate your PHP code and ReDoc to generate beautiful, interactive API documentation.
11+
Clear and comprehensive API documentation is essential for effective communication between developers and consumers of your API. In this Booster, we utilize Swagger-PHP to annotate your PHP code and ReDoc to generate beautiful, interactive API documentation.
1212

1313
## Why Swagger-PHP and ReDoc?
1414

@@ -31,12 +31,12 @@ Clear and comprehensive API documentation is essential for effective communicati
3131

3232
3. **View Your API Documentation (Optional):**
3333
* While the `openapi.yml` file itself is machine-readable, you can use tools like ReDoc to generate human-readable, interactive documentation
34-
* **Note:** ReDoc integration is included in the Blueprint. Check out the `package.json` for the `generate:api-doc:html` script, which uses ReDoc to generate the HTML documentation
34+
* **Note:** ReDoc integration is included in the Booster. Check out the `package.json` for the `generate:api-doc:html` script, which uses ReDoc to generate the HTML documentation
3535
* Refer to the [ReDoc documentation](https://github.com/Redocly/redoc) for more information.
3636

3737
## Git Hooks Integration
3838

39-
The Blueprint's Git hooks are configured to automatically regenerate the API documentation whenever the `openapi.yml` file is modified. This ensures that your documentation stays in sync with your code changes
39+
The Booster's Git hooks are configured to automatically regenerate the API documentation whenever the `openapi.yml` file is modified. This ensures that your documentation stays in sync with your code changes
4040
4141
## Conclusion
4242

docs/content/3.tools/6.ide_configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ layout: default
88

99
## Introduction
1010

11-
A well-configured IDE (Integrated Development Environment) can significantly boost your productivity and streamline your PHP development workflow. In this Blueprint, we provide recommendations and configurations for two popular IDEs: Visual Studio Code and PHPStorm.
11+
A well-configured IDE (Integrated Development Environment) can significantly boost your productivity and streamline your PHP development workflow. In this Booster, we provide recommendations and configurations for two popular IDEs: Visual Studio Code and PHPStorm.
1212

1313
## Visual Studio Code Configuration
1414

@@ -28,7 +28,7 @@ The `.vscode` directory in your project root contains configuration files tailor
2828

2929
## PHPStorm Configuration (Optional)
3030

31-
While the Blueprint primarily focuses on Vscode, you can also configure PHPStorm to work seamlessly with your DDEV project. Here are the key steps:
31+
While the Booster primarily focuses on Vscode, you can also configure PHPStorm to work seamlessly with your DDEV project. Here are the key steps:
3232

3333
1. **Set Project Interpreter:**
3434
* Open your project in PHPStorm.
@@ -48,7 +48,7 @@ While the Blueprint primarily focuses on Vscode, you can also configure PHPStorm
4848

4949
## Conclusion
5050

51-
By configuring your IDE effectively, you can create a more productive and enjoyable development experience. Whether you prefer Vscode or PHPStorm, the Blueprint provides guidance and recommendations to help you get the most out of your chosen IDE.
51+
By configuring your IDE effectively, you can create a more productive and enjoyable development experience. Whether you prefer Vscode or PHPStorm, the Booster provides guidance and recommendations to help you get the most out of your chosen IDE.
5252

5353
---
5454

docs/content/3.tools/7.sonarqube.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ layout: default
1010

1111
SonarQube is a powerful open-source platform for continuous code quality inspection. It provides insights into code reliability, security, maintainability, and technical debt, helping you improve your codebase over time.
1212

13-
In this Blueprint, we've included the necessary configurations to integrate your PHP project with SonarQube, allowing you to leverage its advanced analysis capabilities.
13+
In this Booster, we've included the necessary configurations to integrate your PHP project with SonarQube, allowing you to leverage its advanced analysis capabilities.
1414

1515
## Why SonarQube?
1616

@@ -31,7 +31,7 @@ SonarQube offers a range of benefits for PHP developers and teams
3131
* Update the `sonar-project.properties` file in your project root with the correct project and organization keys
3232

3333
3. **Generate SonarQube Reports**
34-
* The Blueprint includes Composer scripts to generate SonarQube-compatible reports for PHPStan and Psalm
34+
* The Booster includes Composer scripts to generate SonarQube-compatible reports for PHPStan and Psalm
3535
* Run the following commands within your DDEV environment
3636
* For PHPStan analysis
3737
```bash

0 commit comments

Comments
 (0)