You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/frontend/content/docs/cli/commands.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,10 @@ description: Interact with the Blueprint CLI
4
4
category: cli
5
5
---
6
6
7
+
::card
8
+
Blueprint has built-in support for shell autocompletion. Add `source blueprint;` to your shell's configuration (likely `~/.bashrc` or `~/.zshrc`) to import it.
Copy file name to clipboardExpand all lines: apps/frontend/content/docs/concepts/flags.md
+52-15Lines changed: 52 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Feature-specific and experimental extension flags
4
4
category: concepts
5
5
---
6
6
7
-
## What are feature-flags?
7
+
## Introduction
8
8
9
9
Blueprint allows extensions to control certain features through feature-flags, defined in the `info.flags`[conf.yml](/docs/configs/confyml#infoflags) option. These flags can range from toggling beta features to skipping install steps for extensions.
10
10
@@ -28,21 +28,58 @@ info:
28
28
29
29
## Available feature-flags
30
30
31
-
Feature-flags that impact your extension in production and development.
| `developerIgnoreInstallScript` | Ignore the custom extension installation script. |
45
-
| `developerIgnoreRebuild` | Skip rebuilding panel assets on installation. |
46
-
| `developerKeepApplicationCache` | Skip flushing the application's cache on installation. |
47
-
| `developerEscalateInstallScript` | Run install scripts with root permissions instead of running them through the webserver user. |
48
-
| `developerEscalateExportScript` | Run export scripts with root permissions instead of running them through the webserver user. |
39
+
#### `forceLegacyPlaceholders`
40
+
41
+
Use Blueprint's (deprecated) legacy placeholders. This flag will automatically be applied if your extension is built for any `alpha` or `indev` Blueprint release.
42
+
43
+
### Development
44
+
45
+
Developer feature-flags only apply to [developer commands](/docs/cli/commands#developer).
46
+
47
+
#### `developerIgnoreInstallScript`
48
+
49
+
Skip running the extension's [install script](/docs/concepts/scripts) when the extension is installed through [developer commands](/docs/cli/commands#developer).
50
+
51
+
#### `developerIgnoreRebuild`
52
+
53
+
Skip rebuilding frontend assets when the extension is installed through [developer commands](/docs/cli/commands#developer). Asset rebuilds are only triggered when Blueprint determines that your extension may require one.
54
+
55
+
#### `developerKeepApplicationCache`
56
+
57
+
Skip flushing the application's cache when the extension is installed through [developer commands](/docs/cli/commands#developer).
58
+
59
+
#### `developerEscalateInstallScript`
60
+
61
+
Blueprint runs [scripts](/docs/concepts/scripts) as the webserver user by default. For extension development only, scripts can be ran with administrator privileges.
62
+
63
+
#### `developerEscalateExportScript`
64
+
65
+
Blueprint runs [scripts](/docs/concepts/scripts) as the webserver user by default, but your export script may need additional permissions. This flag will provide administrator privileges to your extension's export script.
66
+
67
+
### Deprecated
68
+
69
+
Deprecated feature-flags may be ignored by Blueprint and should not be used.
70
+
71
+
#### ~~`hasInstallScript`~~ (deprecated)
72
+
73
+
Blueprint will look for a file called `install.sh`, relative to the extension's data directory, during extension installation. If present, Blueprint will run the script. **As of beta-2024-12, Blueprint no longer requires a flag to enable install scripts.**
74
+
75
+
#### ~~`hasRemovalScript`~~ (deprecated)
76
+
77
+
Blueprint will look for a file called `remove.sh`, relative to the extension's data directory, during extension removal. If present, Blueprint will run the script. **As of beta-2024-12, Blueprint no longer requires a flag to enable remove scripts.**
78
+
79
+
#### ~~`hasExportScript`~~ (deprecated)
80
+
81
+
Blueprint will look for a file called `export.sh`, relative to the extension's data directory, during extension export/packaging. If present, Blueprint will run the script. **As of beta-2024-12, Blueprint no longer requires a flag to enable export scripts.**
82
+
83
+
#### ~~`developerForceMigrate`~~ (deprecated)
84
+
85
+
Forcefully migrate the database non-interactively when installing your extension through [developer commands](/docs/cli/commands#developer). **As of beta-2024-12, Blueprint no longer requires interaction for database migrations.**
Copy file name to clipboardExpand all lines: apps/frontend/content/docs/concepts/placeholders.md
+22-2Lines changed: 22 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Automatically replace strings with data
4
4
category: concepts
5
5
---
6
6
7
-
## What's this?
7
+
## Introduction
8
8
9
9
Placeholders are strings developers put in their extensions, these can range from generating a random number to autofilling your extension identifier. They are quite useful, work in (almost) every file and can help your extension work on all kinds of installations.
10
10
@@ -115,6 +115,26 @@ For example, you could use the `{webroot/public}` placeholder to add an image to
115
115
<img src="{webroot/public}/cool_image.jpeg" />
116
116
```
117
117
118
+
### Context
119
+
120
+
Context placeholders simplify otherwise complicated paths and generally improve compatibility.
121
+
122
+
#### Appcontext
123
+
124
+
Returns the namespace prefix for an extension's PHP classes.
Technical details about the framework handling the extension.
@@ -149,7 +169,7 @@ With this info, your extension could warn users if they aren't using the Bluepri
149
169
150
170
#### Mode
151
171
152
-
Returns either `local` or `develop` depending on if the extension has been installed through a packaged `myextension.blueprint` file or developer commands.
172
+
Returns either `local` or `develop` depending on if the extension has been installed through a packaged `myextension.blueprint` file or [developer commands](/docs/cli/commands#developer).
0 commit comments