Skip to content

Commit 71c5073

Browse files
committed
More trimming.
1 parent 8970642 commit 71c5073

File tree

3 files changed

+11
-36
lines changed

3 files changed

+11
-36
lines changed

README.md

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
WP-Parser is the parser for creating the new code reference at [developer.wordpress.org](https://developer.wordpress.org/reference). It parses the inline documentation and produces custom post type entries in WordPress.
44

5+
We are currently looking for contributors to help us complete the work on the parser.
6+
57
There is a guide to developing for developer.wordpress.org in the [WordPress documentation handbook](https://make.wordpress.org/docs/handbook/projects/devhub/)
68

79
## Requirements
@@ -13,51 +15,22 @@ There is a guide to developing for developer.wordpress.org in the [WordPress doc
1315

1416
## Quick Start
1517

16-
### 1. Clone the Repository
18+
Clone the repository into your WordPress plugins directory:
1719

1820
```bash
1921
git clone https://github.com/WordPress/phpdoc-parser.git
2022
cd phpdoc-parser
2123
```
2224

23-
### 2. Install Dependencies
24-
25-
Install both Node.js and PHP dependencies:
25+
After that install the dependencies:
2626

2727
```bash
28-
# Install Node.js dependencies (includes @wordpress/env)
2928
npm install
30-
31-
# Install PHP dependencies
32-
npm run composer:setup
33-
# OR if you have local PHP 8.1+: composer install
29+
npm run setup
3430
```
3531

36-
### 3. Start Development Environment
37-
38-
The project uses [@wordpress/env](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/) (wp-env) for local development:
32+
## Running
3933

40-
```bash
41-
# Start WordPress environment with Docker
42-
npm start
43-
44-
# Or manually:
45-
npm run wp-env start
46-
```
34+
In your site's directory:
4735

48-
This will start two WordPress environments:
49-
- **Development**: `http://localhost:8888` (admin: `http://localhost:8888/wp-admin/` - admin/password)
50-
- **Tests**: `http://localhost:8889` (for automated testing only)
51-
52-
### 4. Run Tests
53-
54-
```bash
55-
# Run the full test suite
56-
npm test
57-
58-
# Run tests with setup (first time)
59-
npm run test:phpunit:setup
60-
61-
# Watch tests during development
62-
composer run test:watch
63-
```
36+
wp parser create /path/to/source/code --user=<id|login>

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"psr/log" : "^2.0|^3.0"
2828
},
2929
"require-dev" : {
30-
"phpunit/phpunit": "^9.0",
30+
"phpunit/phpunit": "^9",
3131
"spatie/phpunit-watcher": "^1.23",
3232
"yoast/phpunit-polyfills": "^1.0"
3333
},

phpunit.xml.dist

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
44
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
55
bootstrap="tests/phpunit/includes/bootstrap.php"
6+
backupGlobals="false"
7+
colors="true"
68
cacheResultFile=".phpunit.result.cache"
79
executionOrder="depends,defects"
810
forceCoversAnnotation="false"

0 commit comments

Comments
 (0)