masi/lnreader-plugins
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

refactor(scripts): Reorganize Build Scripts (#1847)

Browse Source
This commit is contained in:
Rajarshee Chatterjee
2025-10-20 12:10:11 +05:30
committed by GitHub
parent d3313a460e
commit 8108df39a1
11 changed files with 55 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/host_plugins.yml
+2 -2
View File
@@ -27,10 +27,10 @@ jobs:
- if: github.repository == 'LNReader/lnreader-plugins'
name: Publish Plugins Main Repo
run: npm run host-linux 2>> $GITHUB_STEP_SUMMARY
run: npm run publish:plugins 2>> $GITHUB_STEP_SUMMARY
shell: bash
- if: github.repository != 'LNReader/lnreader-plugins'
name: Publish Plugins All Branches
run: npm run host-linux -- --all-branches
run: npm run publish:plugins -- --all-branches
shell: bash
README.md
+6 -6
View File
@@ -24,19 +24,19 @@ Repository to host plugins and related issues, and requests for
#### via the testing website
1. Run `npm start` and open `localhost:3000` to test!
1. Run `npm run dev:start` and open `localhost:3000` to test!
[Detailed tutorial for testing website](./docs/website-tutorial.md)
#### via an app
1. Plugins from GitHub
* Run `npm run host-linux` or `npm run host-windows` (depending on your operating system)
* Add your `https://raw.githubusercontent.com/<username>/<repo>/plugins/<tag>/.dist/plugins.min.json` to app repository
- Run `npm run publish:plugins` or `npm run publish:plugins:windows` (depending on your operating system)
- Add your `https://raw.githubusercontent.com/<username>/<repo>/plugins/<tag>/.dist/plugins.min.json` to app repository
2. Plugins from localhost
* Copy `.env.template` to `.env` and update `USER_CONTENT_BASE` according to the comment there
* Run `npm run host-dev`
* Add plugin listing to app repository (e.g. for android emulator `http://10.0.2.2/.dist/plugins.min.json`)
- Copy `.env.template` to `.env` and update `USER_CONTENT_BASE` according to the comment there
- Run `npm run serve:dev`
- Add plugin listing to app repository (e.g. for android emulator `http://10.0.2.2/.dist/plugins.min.json`)
---
importPlugins.js → generate-plugin-index.js
+5 -1
View File
@@ -1,4 +1,5 @@
import fs from 'fs';
import { execSync } from 'child_process';
let content = `import { Plugin } from '@typings/plugin';\n`;
let pluginCounter = 0;
@@ -21,4 +22,7 @@ content += `\nconst PLUGINS: Plugin.PluginBase[] = [${Array(pluginCounter)
.map((v, index) => 'p_' + index.toString())
.join(', ')}];\nexport default PLUGINS`;
fs.writeFileSync('./src/plugins/index.ts', content, { encoding: 'utf-8' });
const outputPath = './src/plugins/index.ts';
fs.writeFileSync(outputPath, content, { encoding: 'utf-8' });
execSync(`npx prettier --write ${outputPath}`, { stdio: 'inherit' });
package.json
+16 -12
View File
@@ -5,20 +5,24 @@
"main": "index.js",
"type": "module",
"scripts": {
"clearMultisrc": "find . -type f -wholename \"*plugins*\\[*\\]*.[t,j]s\" -delete",
"clearMultisrc-windows": "powershell -Command \"Get-ChildItem -Recurse -Include \\\"*].ts\\\",\\\"*].js\\\" | Where-Object { $_.FullName -like \\\"*plugins*\\\" } | Remove-Item\"",
"clean:multisrc": "find . -type f -wholename \"*plugins*\\[*\\]*.[t,j]s\" -delete",
"clean:multisrc:windows": "powershell -Command \"Get-ChildItem -Recurse -Include \\\"*].ts\\\",\\\"*].js\\\" | Where-Object { $_.FullName -like \\\"*plugins*\\\" } | Remove-Item\"",
"dev": "vite",
"generate": "node ./scripts/multisrc/generate.js",
"host-linux": "chmod +x ./host.sh && ./host.sh",
"host-windows": "powershell ./host.ps1",
"host-dev": "npx tsc --project tsconfig.production.json && node --env-file=.env ./scripts/json_plugins.js && serve",
"icons": "npm run clearMultisrc && npm run generate && npx tsc --project tsconfig.production.json && npm run json && node ./scripts/icon_reloading.js",
"json": "node ./scripts/json_plugins.js",
"dev:start": "node generate-plugin-index.js && vite",
"build:multisrc": "node ./scripts/multisrc/generate-multisrc-plugins.js",
"build:compile": "npx tsc --project tsconfig.production.json",
"build:manifest": "node ./scripts/build-plugin-manifest.js",
"build:manifest:dev": "node --env-file=.env ./scripts/build-plugin-manifest.js",
"build:icons": "npm run clean:multisrc && npm run build:multisrc && npm run build:compile && npm run build:manifest && node ./scripts/download-plugin-icons.js",
"build:full": "npm run clean:multisrc && npm run build:multisrc && npm run build:compile && npm run build:manifest",
"publish:plugins": "chmod +x ./publish-plugins.sh && ./publish-plugins.sh",
"publish:plugins:windows": "powershell ./publish-plugins.ps1",
"serve:dev": "npm run build:compile && npm run build:manifest:dev && serve",
"lint": "npx eslint .",
"prepare": "husky",
"prettier": "prettier --write \"./**/*.{js,ts}\"",
"start": "node importPlugins.js && vite",
"test": "exit 0"
"lint:fix": "npx eslint . --fix",
"format": "prettier --write \"./**/*.{js,ts}\"",
"format:check": "prettier --check \"./**/*.{js,ts}\"",
"prepare": "husky"
},
"author": "LNReader",
"license": "MIT",
host.ps1 → publish-plugins.ps1
+3 -3
View File
@@ -18,10 +18,10 @@ if(-Not $?){
git reset
rm -r -fo .js
npm run clearMultisrc
npm run generate
npm run clean:multisrc
npm run build:multisrc
npx tsc --project tsconfig.production.json
npm run json
npm run build:manifest
if (-not (Test-Path .dist) -or -not (Get-ChildItem -Path .dist -Force)) {
echo "=========="
host.sh → publish-plugins.sh
+9 -9
View File
@@ -13,9 +13,9 @@ if [[ "$1" == "--all-branches" ]]; then
git fetch --all
branches=$(git branch -r | grep -v '\->')
for branch in $branches; do
# Check if the branch has the same version of host.sh as the current branch
if ! diff host.sh <(git show "$branch:host.sh") >/dev/null; then
echo "Branch $branch does not have the current version of host.sh. Skipping."
# Check if the branch has the same version of publish-plugins.sh as the current branch
if ! diff publish-plugins.sh <(git show "$branch:publish-plugins.sh") >/dev/null; then
echo "Branch $branch does not have the current version of publish-plugins.sh. Skipping."
continue
fi
echo "::group::Branch $branch"
@@ -26,11 +26,11 @@ if [[ "$1" == "--all-branches" ]]; then
git branch -D $dist
fi
git stash pop
npm run clearMultisrc
npm run generate
npm run clean:multisrc
npm run build:multisrc
npx tsc --project tsconfig.production.json
echo "# $branch" >> $GITHUB_STEP_SUMMARY
npm run json -- --only-new 2>> $GITHUB_STEP_SUMMARY
npm run build:manifest -- --only-new 2>> $GITHUB_STEP_SUMMARY
if [ ! -d ".dist" ] || [ -z "$(ls -A .dist)" ]; then
echo "=========="
echo "JSON files were not generated! See the error above and fix it!"
@@ -73,10 +73,10 @@ fi
git reset
rm -rf .js
npm run clearMultisrc
npm run generate
npm run clean:multisrc
npm run build:multisrc
npx tsc --project tsconfig.production.json
npm run json
npm run build:manifest
if [ ! -d ".dist" ] || [ -z "$(ls -A .dist)" ]; then
echo "=========="
scripts/json_plugins.js → scripts/build-plugin-manifest.js
View File
scripts/icon_reloading.js → scripts/download-plugin-icons.js
+5 -1
View File
@@ -43,7 +43,11 @@ const notAvailableImage = fs.readFileSync(
console.log('Loading plugins.json ⌛');
const plugin_path = path.join('.dist', 'plugins.json');
if (!fs.existsSync(plugin_path)) {
console.log('❌', plugin_path, 'not found (run "json_plugins.js" first)');
console.log(
'❌',
plugin_path,
'not found (run "npm run build:manifest" first)',
);
return;
}
const plugins = JSON.parse(fs.readFileSync(plugin_path, 'utf-8'));
scripts/multisrc/generate.js → scripts/multisrc/generate-multisrc-plugins.js
View File
scripts/multisrc/lightnovelwp/README.md
+1 -1
View File
@@ -34,7 +34,7 @@ To add a new source you need to add it to sources.json:
### icon
To add an icon to the source you can just run `npm run icons` to generate all icons (make sure `npm run generate` works on your machine)
To add an icon to the source you can just run `npm run build:icons` to generate all icons (make sure `npm run build:multisrc` works on your machine)
Or you can manualy find the icon of the site \
(try the favicon of the site (https://site.com/favicon.ico) most of the times it redirects you to an image named something like "cropped-site-32x32.png" try to access "cropped-site.png" or "site.png" if that did not work you can try to access "https://site.com/wp-json/" at the end of this very long file there should be a "site_icon_url" value
scripts/multisrc/madara/README.md
+1 -1
View File
@@ -29,7 +29,7 @@ To add a new source you need to add it to sources.json:
### icon
To add an icon to the source you can just run `npm run icons` to generate all icons (make sure `npm run generate` works on your machine)
To add an icon to the source you can just run `npm run build:icons` to generate all icons (make sure `npm run build:multisrc` works on your machine)
Or you can manualy find the icon of the site \
(try the favicon of the site (https://site.com/favicon.ico) most of the times it redirects you to an image named something like "cropped-site-32x32.png" try to access "cropped-site.png" or "site.png" if that did not work you can try to access "https://site.com/wp-json/" at the end of this very long file there should be a "site_icon_url" value