@bostonuniversity/buwp-local 0.7.4 → 0.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/COMMANDS.md CHANGED
@@ -17,6 +17,7 @@ npx buwp-local init [options]
17
17
  - `--plugin` - Non-interactive: initialize as plugin project
18
18
  - `--mu-plugin` - Non-interactive: initialize as mu-plugin project
19
19
  - `--theme` - Non-interactive: initialize as theme project
20
+ - `--sandbox` - Non-interactive: initialize as sandbox project
20
21
  - `-f, --force` - Overwrite existing configuration file
21
22
 
22
23
  **Examples:**
@@ -28,13 +29,14 @@ npx buwp-local init
28
29
  npx buwp-local init --plugin
29
30
  npx buwp-local init --mu-plugin --force
30
31
  npx buwp-local init --theme --no-interactive
32
+ npx buwp-local init --sandbox --no-interactive
31
33
  ```
32
34
 
33
35
  **What it does:**
34
36
  - Creates `.buwp-local.json` configuration file
35
37
  - Auto-detects project type from directory structure
36
38
  - Generates hostname from directory name
37
- - Creates appropriate volume mappings for plugin/theme/mu-plugin types
39
+ - Creates appropriate volume mappings for plugin/theme/mu-plugin/sandbox types
38
40
  - Configures services (Redis, S3, Shibboleth)
39
41
  - Sets up port mappings
40
42
 
@@ -93,6 +93,8 @@ sudo bash -c 'echo "127.0.0.1 username-myproject.local" >> /etc/hosts'
93
93
 
94
94
  Replace `username-myproject.local` with the hostname you chose in step 4.
95
95
 
96
+ The `init` command will also display this command for you to run.
97
+
96
98
  ### 6. Start Your Environment
97
99
 
98
100
  Start the Docker containers:
package/docs/ROADMAP.md CHANGED
@@ -218,6 +218,12 @@ hostile.remove('127.0.0.1', config.hostname);
218
218
 
219
219
  **Breaking Change Note:** Existing projects will need `buwp-local update` or restart to apply new port bindings. Database access from phones/tablets/other computers will no longer work (rare use case).
220
220
 
221
+ ### Shipped in v0.7.5
222
+ - **Init Template updated with WP_ENVIRONMENT_TYPE** ✅
223
+ - New projects set `WP_ENVIRONMENT_TYPE=local` by default
224
+ - Provides standardized environment detection for plugins/themes
225
+ - Can be overridden to simulate staging/production if needed
226
+
221
227
  ### Potential Features
222
228
 
223
229
  - **Ability to add custom WORDPRESS_CONFIG_EXTRA environment variables**
@@ -244,6 +250,10 @@ hostile.remove('127.0.0.1', config.hostname);
244
250
  - Multiplatform /etc/hosts hostname guide
245
251
  - Evaluate credential storage solutions for non-macOS platforms (https://www.npmjs.com/package/keytar)
246
252
 
253
+ - **Custom Docker Compose Overrides**
254
+ - Support for user-provided `docker-compose.override.yml` files
255
+ - Allows advanced users to customize services, add new ones, etc.
256
+
247
257
  - **Project Status & Listing**
248
258
  - Central tracking of all buwp-local projects in `~/.buwp-local/projects.json`
249
259
  - View all running projects: `buwp-local list`
@@ -262,6 +262,7 @@ async function initCommand(options) {
262
262
  mappings: [],
263
263
  env: {
264
264
  WP_DEBUG: true,
265
+ WP_ENVIRONMENT_TYPE: 'local',
265
266
  XDEBUG: answers.xdebug || false
266
267
  }
267
268
  };
package/lib/config.js CHANGED
@@ -228,6 +228,7 @@ function initConfig(projectPath = process.cwd(), options = {}) {
228
228
  mappings: [],
229
229
  env: {
230
230
  WP_DEBUG: true,
231
+ WP_ENVIRONMENT_TYPE: 'local',
231
232
  XDEBUG: false
232
233
  }
233
234
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bostonuniversity/buwp-local",
3
- "version": "0.7.4",
3
+ "version": "0.7.5",
4
4
  "description": "Local WordPress development environment for Boston University projects",
5
5
  "type": "module",
6
6
  "main": "lib/index.js",
package/readme.md CHANGED
@@ -113,3 +113,4 @@ Your local WordPress site should now be accessible at the hostname you configure
113
113
  - ✅ Smart initialization for plugins, themes, and mu-plugins
114
114
  - ✅ Volume mapping for live code sync
115
115
  - ✅ Xdebug support for step debugging
116
+ - ✅ WordPress environment detection (`WP_ENVIRONMENT_TYPE` set to `local`)