Skip to content

Commit

Permalink
Add scripts-descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
BrianHenryIE committed Nov 30, 2023
1 parent 3c54afd commit 71edc42
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@

```bash
# List the available scripts
composer run-script -l
```

`composer show --self`
`composer show --direct`
`composer show --outdated`
Expand Down
14 changes: 13 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
"restore-acceptance-database": [
"export $(grep -v '^#' .env.testing | xargs); mysql $TEST_SITE_DB_NAME < tests/_data/dump.sql"
],
"coverage-tests": [
"test-coverage": [
"codecept run unit --coverage unit.cov",
"codecept run wpunit --coverage wpunit.cov",
"phpcov merge --clover tests/_output/clover.xml --html tests/_output/html tests/_output;",
Expand All @@ -188,5 +188,17 @@
"github-actions": [
"act -P ubuntu-latest=shivammathur/node:latest"
]
},
"scripts-descriptions": {
"create-symlinks": "Create sylimks between /wordpress, /wp-content and the root plugin for convenience.",
"configure-phpstorm": "Add directories to PhpStorm's excluded folders list and add PHPUnit run configurations.",
"prefix-namespaces": "Prefix the namespaces of Composer packages using brianhenryie/strauss to avoid conflicts with other plugins.",
"test": "Run PHPUnit tests",
"test-coverage": "Run PHPUnit tests with coverage. Use `XDEBUG_MODE=coverage composer test-coverage` to run, `open ./coverage-report/index.html` to view.",
"cs-fix": "Run PHP Code Beautifier and Fixer",
"cs-fix-changes": "Run @cs-fix on files since the last commmit",
"create-plugin-archive": "Generate i18n .pot and create a plugin .zip using the exclusion list in .distignore",
"php-compatibility": "Run PHPCompatibilityWP",
"github-actions": "Run the GitHub Actions workflow locally using nektos/act"
}
}

0 comments on commit 71edc42

Please sign in to comment.