Skip to content

Add add-function.php to scaffold new bridge functions #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sonalidudhia wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add add-function.php to scaffold new bridge functions #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ resources/android/ Kotlin bridge implementation copied into Android builds
resources/ios/ Swift bridge implementation copied into iOS builds
android/ Android module starter and packaging notes
ios/ iOS module starter and packaging notes
stubs/ Files for future scaffolding automation
stubs/ Templates used by add-function.php to scaffold new bridge functions
tests/ Pest tests for PHP and manifest behavior
docs/ Maintainer and user documentation
.github/ Issue templates, workflows, release automation
Expand Down Expand Up @@ -109,16 +109,12 @@ composer test
composer lint
```

## Future Automation
## Adding Bridge Functions

The `stubs/` directory is designed for a future companion scaffolder such as `nativephp-plugin-maker`.

Possible workflows:
Once the template is configured, add a new bridge function with one command:

```bash
composer create-project {{ vendor }}/nativephp-plugin-template my-plugin
php add-function.php --name=Level --description="Reads the battery level."
```

```bash
nativephp-plugin new Battery
```
This adds the manifest entry, the contract method, the `Plugin` implementation, the facade `@method` line, the Kotlin and Swift bridge classes, and a Pest test — see `docs/bridge-functions.md` for what each file gets and the available flags (`--skip-android`, `--skip-ios`, `--dry-run`, `--no-interaction`).
Loading
Loading