Skip to content

Commit f6d71a4

Browse files
committed
fix: package name
1 parent 063d057 commit f6d71a4

9 files changed

Lines changed: 28 additions & 28 deletions

File tree

.github/ISSUE_TEMPLATE/1-bug-report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ body:
1111
id: faqs
1212
attributes:
1313
label: Troubleshooting
14-
description: By submitting this issue, you agree that our [troubleshooting tips](https://github.com/Rahmon/wp-docker#i-am-having-issues-with-wp-local-docker-what-are-the-best-troubleshooting-techniques) have not helped resolve the issue.
14+
description: By submitting this issue, you agree that our [troubleshooting tips](https://github.com/Rahmon/wpdocker#i-am-having-issues-with-wp-local-docker-what-are-the-best-troubleshooting-techniques) have not helped resolve the issue.
1515
options:
1616
- label: I have attempted to troubleshoot this already
1717
required: true
@@ -63,7 +63,7 @@ body:
6363
id: terms
6464
attributes:
6565
label: Code of Conduct
66-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Rahmon/wp-docker/blob/develop/CODE_OF_CONDUCT.md).
66+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Rahmon/wpdocker/blob/develop/CODE_OF_CONDUCT.md).
6767
options:
6868
- label: I agree to follow this project's Code of Conduct
6969
required: true

.github/ISSUE_TEMPLATE/2-enhancement.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ body:
3939
id: terms
4040
attributes:
4141
label: Code of Conduct
42-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Rahmon/wp-docker/blob/develop/CODE_OF_CONDUCT.md).
42+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Rahmon/wpdocker/blob/develop/CODE_OF_CONDUCT.md).
4343
options:
4444
- label: I agree to follow this project's Code of Conduct
4545
required: true

.github/ISSUE_TEMPLATE/3-help.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ body:
1111
id: faqs
1212
attributes:
1313
label: Troubleshooting
14-
description: By submitting this question, you agree that our [troubleshooting tips](https://github.com/Rahmon/wp-docker#i-am-having-issues-with-wp-local-docker-what-are-the-best-troubleshooting-techniques) have not helped resolve the quesstion.
14+
description: By submitting this question, you agree that our [troubleshooting tips](https://github.com/Rahmon/wpdocker#i-am-having-issues-with-wp-local-docker-what-are-the-best-troubleshooting-techniques) have not helped resolve the quesstion.
1515
options:
1616
- label: I have attempted to troubleshoot this already
1717
required: true
@@ -27,7 +27,7 @@ body:
2727
id: terms
2828
attributes:
2929
label: Code of Conduct
30-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Rahmon/wp-docker/blob/develop/CODE_OF_CONDUCT.md).
30+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Rahmon/wpdocker/blob/develop/CODE_OF_CONDUCT.md).
3131
options:
3232
- label: I agree to follow this project's Code of Conduct
3333
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Looking for documentation?
4-
url: https://github.com/Rahmon/wp-docker/#readme
4+
url: https://github.com/Rahmon/wpdocker/#readme
55
about: If you're looking for information on installation, global commands, environments, WP Snapshots, and related tools then check out the WP Local Docker Readme.

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ All notable changes to this project will be documented in this file, per [the Ke
1111

1212
### Removes
1313

14-
[Unreleased]: https://github.com/Rahmon/wp-docker/compare/master...develop
14+
[Unreleased]: https://github.com/Rahmon/wpdocker/compare/master...develop

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Contributing isn't just writing code - it's anything that improves the project.
1010

1111
### Reporting bugs
1212

13-
If you're running into an issue, please take a look through [existing issues](https://github.com/Rahmon/wp-docker/issues) and [open a new one](https://github.com/Rahmon/wp-docker/issues/new) if needed. If you're able, include steps to reproduce, environment information, and screenshots/screencasts as relevant.
13+
If you're running into an issue, please take a look through [existing issues](https://github.com/Rahmon/wpdocker/issues) and [open a new one](https://github.com/Rahmon/wpdocker/issues/new) if needed. If you're able, include steps to reproduce, environment information, and screenshots/screencasts as relevant.
1414

1515
### Suggesting enhancements
1616

17-
New features and enhancements are also managed via [issues](https://github.com/Rahmon/wp-docker/issues).
17+
New features and enhancements are also managed via [issues](https://github.com/Rahmon/wpdocker/issues).
1818

1919
### Pull requests
2020

@@ -33,7 +33,7 @@ The `develop` branch is the development branch which means it contains the next
3333
1. Readme updates: Make any other readme changes to `README.md` as necessary.
3434
1. Merge: Make a non-fast-forward merge from your release branch to `develop` (or merge the pull request), then do the same for `develop` into `master` (`git checkout master && git merge --no-ff develop`). `master` contains the stable development version.
3535
1. Push: Push your master branch to GitHub (e.g. `git push origin master`).
36-
1. Release: Create a [new release](https://github.com/Rahmon/wp-docker/releases/new), naming the tag and the release with the new version number, and targeting the `master` branch. Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/Rahmon/wp-docker/milestone/#?closed=1).
37-
1. Close milestone: Edit the [milestone](https://github.com/Rahmon/wp-docker/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
36+
1. Release: Create a [new release](https://github.com/Rahmon/wpdocker/releases/new), naming the tag and the release with the new version number, and targeting the `master` branch. Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/Rahmon/wpdocker/milestone/#?closed=1).
37+
1. Close milestone: Edit the [milestone](https://github.com/Rahmon/wpdocker/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
3838
1. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.
3939
1. Update [NPM](https://www.npmjs.com/package/wp-local-docker) with the latest version.

README.md

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

33
> WP Docker is an easy to use Docker based local development environment for WordPress development that works on Mac, Windows, and Linux.
44
5-
[![Release Version](https://img.shields.io/github/release/Rahmon/wp-docker.svg)](https://github.com/Rahmon/wp-docker/releases/latest) [![MIT License](https://img.shields.io/github/license/Rahmon/wp-docker.svg)](https://github.com/Rahmon/wp-docker/blob/master/LICENSE)
5+
[![Release Version](https://img.shields.io/github/release/Rahmon/wpdocker.svg)](https://github.com/Rahmon/wpdocker/releases/latest) [![MIT License](https://img.shields.io/github/license/Rahmon/wpdocker.svg)](https://github.com/Rahmon/wpdocker/blob/master/LICENSE)
66

77
> **Note**<br>
88
> This is a fork of [10updocker](https://github.com/10up/wp-local-docker-v2).
@@ -195,7 +195,7 @@ Getting WP Docker up and running on your system involves a few simple steps. Sta
195195
Next, you can install WP Docker as a global npm package. Run the following command in your terminal:
196196

197197
```bash
198-
npm install -g wp-docker
198+
npm install -g @wpdocker/wpdocker
199199
```
200200

201201
To confirm that WP Docker has been installed successfully, you can check its version. Simply type:
@@ -221,7 +221,7 @@ Then, follow the prompts to customise your settings.
221221
Keeping WP Docker up-to-date is important. To update it, you can run the installation command again. NPM will replace your current version with the latest one. Here's the command:
222222

223223
```bash
224-
npm install -g wp-docker
224+
npm install -g @wpdocker/wpdocker
225225
```
226226

227227
---
@@ -592,7 +592,7 @@ Starting from version 4.0.0, WP Docker has switched from the old [WP Snapshots](
592592

593593
#### Configuration
594594

595-
If you haven't used [Snapshots](https://github.com/10up/snapshots) with [WP Docker](https://github.com/Rahmon/wp-docker) yet, you'll first need to configure Snapshots with your AWS credentials. To do so, run the following command:
595+
If you haven't used [Snapshots](https://github.com/10up/snapshots) with [WP Docker](https://github.com/Rahmon/wpdocker) yet, you'll first need to configure Snapshots with your AWS credentials. To do so, run the following command:
596596

597597
```
598598
wpdocker wp snapshots configure <repository>
@@ -638,7 +638,7 @@ Replace `<command>` with any command that Snapshots accepts. The command is pass
638638

639639
Concurrent environments are limited by the available resources of your host machine.
640640

641-
### I am having issues with wp-docker, what are the best troubleshooting techniques?
641+
### I am having issues with wpdocker, what are the best troubleshooting techniques?
642642

643643
See the [Troubleshooting](#troubleshooting) section.
644644

@@ -724,10 +724,10 @@ Facing issues with WP Docker? Here are a few steps you can follow to troubleshoo
724724
725725
1. Update Docker and Node: First, make sure that Docker and Node are up to date.
726726
727-
2. Update wp-docker: Ensure that wp-docker is up to date as well. You can do this by running the following command:
727+
2. Update wpdocker: Ensure that wpdocker is up to date as well. You can do this by running the following command:
728728
729729
```
730-
npm i -g wp-docker
730+
npm i -g @wpdocker/wpdocker
731731
```
732732
733733
3. Restart Docker: Once everything is up to date, it's generally a good idea to restart Docker.
@@ -758,7 +758,7 @@ Remember, troubleshooting is a process of elimination. Try these steps one by on
758758
759759
### Avoiding conflicts with other local dev environments (Valet, MAMP, etc) on macOS
760760
761-
If you are running something like MAMP or Laravel Valet on your Mac, it is possible you may have port conflicts when attempting to use wp-docker, such as:
761+
If you are running something like MAMP or Laravel Valet on your Mac, it is possible you may have port conflicts when attempting to use wpdocker, such as:
762762
763763
```
764764
Cannot start service mysql: Ports are not available: listen tcp 127.0.0.1:3306: bind: address already in use
@@ -773,7 +773,7 @@ sudo lsof -i -P | grep LISTEN
773773
sudo lsof -i -P | grep :3306
774774
```
775775

776-
If you see a process that is using that port, that process should be stopped before you attempt to start or create any new environments with wp-docker.
776+
If you see a process that is using that port, that process should be stopped before you attempt to start or create any new environments with wpdocker.
777777

778778
If you installed `mysqld` via Homebrew, you need to stop the process via Homebrew:
779779

@@ -811,7 +811,7 @@ If that doesn't resolve the issues, try updating your Docker images using `wpdoc
811811

812812
## Migrating from 10updocker
813813

814-
If you already have 10updocker installed and working, you can install wpdocker (`npm install -g wp-docker`) and start
814+
If you already have 10updocker installed and working, you can install wpdocker (`npm install -g @wpdocker/wpdocker`) and start
815815
using it by typing `wpdocker` instead of `10updocker` e.g. `wpdocker start`. Your settings will remain the same. At this
816816
point, you just changed the name of the tool.
817817

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"name": "wp-docker",
2+
"name": "@wpdocker/wpdocker",
33
"version": "1.0.0",
44
"description": "WP Docker",
55
"license": "MIT",
6-
"homepage": "https://github.com/Rahmon/wp-docker",
6+
"homepage": "https://github.com/Rahmon/wpdocker",
77
"bugs": {
8-
"url": "https://github.com/Rahmon/wp-docker/issues"
8+
"url": "https://github.com/Rahmon/wpdocker/issues"
99
},
1010
"keywords": [
1111
"wordpress",
@@ -44,7 +44,7 @@
4444
},
4545
"repository": {
4646
"type": "git",
47-
"url": "git+ssh://git@github.com/Rahmon/wp-docker.git"
47+
"url": "git+ssh://git@github.com/Rahmon/wpdocker.git"
4848
},
4949
"engines": {
5050
"node": ">=18"

src/command-utils.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const chalk = require( 'chalk' );
66

77
const envUtils = require( './env-utils' );
88

9-
exports.checkIfDockerRunning = function() {
9+
exports.checkIfDockerRunning = function () {
1010
let output;
1111

1212
try {
@@ -22,7 +22,7 @@ exports.checkIfDockerRunning = function() {
2222
return true;
2323
};
2424

25-
exports.checkForUpdates = async function() {
25+
exports.checkForUpdates = async function () {
2626
const pkg = require( path.join( envUtils.rootPath, 'package' ) );
2727
let update = null;
2828

@@ -33,6 +33,6 @@ exports.checkForUpdates = async function() {
3333
}
3434

3535
if ( update ) {
36-
console.warn( chalk.yellow( `WP Docker version ${ update.latest } is now available. Please run \`npm i -g wp-docker\` to update!` ) );
36+
console.warn( chalk.yellow( `WP Docker version ${ update.latest } is now available. Please run \`npm i -g @wpdocker/wpdocker\` to update!` ) );
3737
}
3838
};

0 commit comments

Comments
 (0)