Skip to content

Extra files #230

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

Merged
merged 20 commits into from
Sep 11, 2025
Merged

Extra files #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
9bd4b29
Support for shipping extra files
simonhamp Jun 25, 2025
92930ba
Add extras path to PHP environment
simonhamp Jun 25, 2025
075308a
Fix path
simonhamp Jun 25, 2025
993ad13
Formatting
simonhamp Jun 25, 2025
ea94a73
Merge branch 'main' of https://github.com/NativePHP/electron into fea…
PeteBishwhip Jun 25, 2025
20a5c16
Change path
simonhamp Jun 25, 2025
a825ba2
Change path
simonhamp Jun 25, 2025
4f6fb0e
fix `npm install` error during plugin build
gwleuverink Jul 15, 2025
608a454
Merge remote-tracking branch 'origin/main' into feature/extras
gwleuverink Jul 15, 2025
210bcec
specify head ref in auto-commit-action
gwleuverink Jul 15, 2025
183d6bf
revert: specify head ref in auto-commit-action
gwleuverink Jul 15, 2025
35e0459
revert auto-commit-action to v5
gwleuverink Jul 15, 2025
9869cda
Build plugin
gwleuverink Jul 15, 2025
6043353
explicitly pass builder config
gwleuverink Jul 18, 2025
f9a0103
Merge branch 'main' into feature/extras
gwleuverink Sep 10, 2025
e006bb3
fix paths
gwleuverink Sep 10, 2025
df1ed48
Build plugin
gwleuverink Sep 10, 2025
e23113e
don't include 'extras' in asar archive
gwleuverink Sep 10, 2025
710ce02
Merge branch 'feature/extras' of github.com:NativePHP/electron into f…
gwleuverink Sep 10, 2025
f9c3fe5
use auto-commit v6
gwleuverink Sep 10, 2025
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
1 change: 0 additions & 1 deletion .github/workflows/build-plugin.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ jobs:
working-directory: ./resources/js/
run: npm run plugin:build


- name: Commit changes
if: github.event_name == 'pull_request'
uses: stefanzweifel/git-auto-commit-action@v6
Expand Down
11 changes: 10 additions & 1 deletion resources/js/electron-builder.js → resources/js/electron-builder.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export default {
3: 'arm64'
}[context.arch];

if(arch === undefined) {
if (arch === undefined) {
console.error('Cannot build PHP for unsupported architecture');
process.exit(1);
}
Expand Down Expand Up @@ -136,6 +136,15 @@ export default {
version: appVersion,
author: appAuthor,
},
extraFiles: [
{
from: join(process.env.APP_PATH, 'extras'),
to: 'extras',
filter: [
'**/*'
]
}
],
...updaterEnabled
? { publish: updaterConfig }
: {}
Expand Down
3 changes: 3 additions & 0 deletions resources/js/electron-plugin/dist/server/php.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,9 @@ function getDefaultEnvironmentVariables(secret, apiPort) {
NATIVEPHP_PICTURES_PATH: getPath('pictures'),
NATIVEPHP_VIDEOS_PATH: getPath('videos'),
NATIVEPHP_RECENT_PATH: getPath('recent'),
NATIVEPHP_EXTRAS_PATH: app.isPackaged
? join(process.resourcesPath, '..', 'extras')
: join(process.env.APP_PATH, 'extras'),
};
if (secret && apiPort) {
variables.NATIVEPHP_API_URL = `http://localhost:${apiPort}/api/`;
Expand Down
4 changes: 4 additions & 0 deletions resources/js/electron-plugin/src/server/php.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,7 @@ interface EnvironmentVariables {
NATIVEPHP_PICTURES_PATH: string;
NATIVEPHP_VIDEOS_PATH: string;
NATIVEPHP_RECENT_PATH: string;
NATIVEPHP_EXTRAS_PATH: string;
// Cache variables
APP_SERVICES_CACHE?: string;
APP_PACKAGES_CACHE?: string;
Expand Down Expand Up @@ -293,6 +294,9 @@ function getDefaultEnvironmentVariables(secret?: string, apiPort?: number): Envi
NATIVEPHP_PICTURES_PATH: getPath('pictures'),
NATIVEPHP_VIDEOS_PATH: getPath('videos'),
NATIVEPHP_RECENT_PATH: getPath('recent'),
NATIVEPHP_EXTRAS_PATH: app.isPackaged
? join(process.resourcesPath, '..', 'extras')
Copy link
Contributor

@gwleuverink gwleuverink Sep 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original join(app.getAppPath(), 'nativephp', 'extras')
pointed to playground.app/Contents/Resources/app.asar/nativephp/extras

Electron builder automatically the extra files in playground.app/Contents/extras.
Using process.resourcesPath instead points it to the right place

: join(process.env.APP_PATH, 'extras'),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I installed the electron package from a symlinked directory.
The original join(app.getAppPath(), '..', '..', 'extras') pointed to a wrong relative path

Using APP_PATH makes this consistent no matter how you structure your dev setup

};

// Only if the server has already started
Expand Down
18 changes: 9 additions & 9 deletions resources/js/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,22 @@
"dev": "cross-env node php.js && electron-vite dev --watch",
"build": "electron-vite build",
"postinstall": "node ./node_modules/electron-builder/cli.js install-app-deps",
"publish:all": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js --win --mac --linux --config --x64 --arm64 -p always",
"publish:all": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js --win --mac --linux --config electron-builder.mjs --x64 --arm64 -p always",
"publish:win": "cross-env npm run publish:win-x64",
"publish:win-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --win --config --x64",
"publish:win-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --win --config electron-builder.mjs --x64",
"publish:mac": "cross-env npm run publish:mac-arm64 -- --x64",
"publish:mac-arm64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --mac --config --arm64 -p always",
"publish:mac-x86": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --mac --config --x64 -p always",
"publish:mac-arm64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --mac --config electron-builder.mjs --arm64 -p always",
"publish:mac-x86": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p always --mac --config electron-builder.mjs --x64 -p always",
"publish:linux": "cross-env npm run publish:linux-x64",
"publish:linux-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js --linux --config --x64 -p always",
"publish:linux-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js --linux --config electron-builder.mjs --x64 -p always",
"build:all": "cross-env npm run build:mac && cross-env npm run build:win && cross-env npm run build:linux",
"build:win": "cross-env npm run build:win-x64",
"build:win-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --win --config --x64",
"build:win-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --win --config electron-builder.mjs --x64",
"build:mac": "cross-env npm run build:mac-arm64 -- --x64",
"build:mac-arm64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --mac --config --arm64",
"build:mac-x86": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --mac --config --x64",
"build:mac-arm64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --mac --config electron-builder.mjs --arm64",
"build:mac-x86": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --mac --config electron-builder.mjs --x64",
"build:linux": "cross-env npm run build:linux-x64",
"build:linux-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --linux --config --x64",
"build:linux-x64": "cross-env npm run build && cross-env node ./node_modules/electron-builder/cli.js -p never --linux --config electron-builder.mjs --x64",
"plugin:build": "rimraf electron-plugin/dist/ && node node_modules/typescript/bin/tsc --project electron-plugin",
"plugin:build:watch": "npm run plugin:build -- -W",
"plugin:test": "vitest run --root electron-plugin --coverage.all",
Expand Down
1 change: 1 addition & 0 deletions src/Traits/CopiesToBuildDirectory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ abstract protected function sourcePath(string $path = ''): string;
'dist',
'build',
'temp',
'extras',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to pack it up in the archive. Otherwise the extra files will be included in the app twice

'docker',
'packages',
'**/.github',
Expand Down
Loading