-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Heiko Mamerow
committed
Apr 6, 2023
1 parent
beaa41b
commit 708599a
Showing
1 changed file
with
33 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,35 @@ | ||
# wp-env-port-stamp | ||
|
||
npm package writes an .wp-env.json file with custom ports. | ||
**TL;DR:** *wp-env-port-stamp* is a npm package who generates an *.wp-env.json* file with custom ports for your *wp-env* envirenment. | ||
|
||
## Background | ||
|
||
If you work with different docker envirenments at the same time you need to manage the ports. *wp-env* use port 8888 per default. If this port is already in use by another project then you have an problemen. But the solution is easy: Just change the ports... | ||
|
||
*wp-env-prt-stamp* generates every time an new port adress - more or less - randomly. When the package is called, it creates a file *.wp-env.json* in the directory where it was called. With this *.wp-env.json* file you can customize the WordPress installation. In our case are dynamic renderered port numbers. | ||
|
||
The port number will be generatated from the current JavaScript date - the time in miliseconds since the ECMAScript epoch. We take the last 4 numbers of this time as the port number. This solution my not be perfekt but good enough for your dayly local web development with a handfull docker instances. :-) | ||
|
||
## Install/Remove | ||
|
||
Install the package global on your local computer: | ||
|
||
``` | ||
npm i -g wp-env-port-stamp | ||
``` | ||
|
||
To remove the packe: | ||
|
||
``` | ||
npm uninstall -g wp-env-port-stamp | ||
``` | ||
|
||
## Usage | ||
|
||
1. Go in your local dev envirenment to your plugin, theme or block root directory or wherever you want to start *wp-env*. | ||
2. Call the package: `wp-env-port-stamp` | ||
3. The file is generated. You can start now with `wp-env` | ||
|
||
Normaly you only need to call the package for the first time in an new project. Later just start directly *wp-env*. | ||
|
||
**Attention:** If there is already existing *.wp-env.json* file, *wp-env-port-stamp* will overwrite it! (There will be an improvement to this later). |