diff options
| author | Ivan Gabaldon <igabaldon@inetol.net> | 2025-07-06 12:27:28 +0200 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarIT.de> | 2025-08-18 16:38:32 +0200 |
| commit | 0b913053a76e83a43846e19097963f98c8519a1d (patch) | |
| tree | d11f7d76db1053559ca91f8ad66b0afd6c6d4336 /client/simple/vite.config.ts | |
| parent | 4fb6105d699e19321f6799d7fff05313fd4cd4b9 (diff) | |
[mod] theme/simple: migrate codebase to TypeScript
TypeScript is a superset of JavaScript, converting the entire theme to
TypeScript allows us to receive much more feedback on possible issues made in
package updates or our own typos, furthermore, it allows to transpile properly
to lower specs. This PR couldn't be done in smaller commits, a lot of work
needed to make everything *work properly*:
- A browser baseline has been set that requires minimum **Chromium 93, Firefox
92 and Safari 15** (proper visuals/operation on older browser versions is not
guaranteed)
- LightningCSS now handles minification and prefix creation for CSS.
- All hardcoded polyfills and support for previous browser baseline versions
have been removed.
- Convert codebase to TypeScript.
- Convert IIFE to ESM, handling globals with IIFE is cumbersome, ESM is the
standard for virtually any use of JS nowadays.
- Vite now builds the theme without the need for `vite-plugin-static-copy`.
- `searxng.ready` now accepts an array of conditions for the callback to be
executed.
- Replace `leaflet` with `ol` as there were some issues with proper Vite
bundling.
- Merged `head` with `main` script, as head was too small now.
- Add `assertElement` to properly check the existence of critical DOM elements.
- `searxng.on` renamed to `searxng.listen` with some handling improvements.
Diffstat (limited to 'client/simple/vite.config.ts')
| -rw-r--r-- | client/simple/vite.config.ts | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/client/simple/vite.config.ts b/client/simple/vite.config.ts new file mode 100644 index 000000000..78ca07a2c --- /dev/null +++ b/client/simple/vite.config.ts @@ -0,0 +1,145 @@ +/** + * CONFIG: https://vite.dev/config/ + */ + +import { resolve } from "node:path"; +import browserslistToEsbuild from "browserslist-to-esbuild"; +import { browserslistToTargets } from "lightningcss"; +import type { Config } from "svgo"; +import type { UserConfig } from "vite"; +import { browserslist } from "./package.json"; +import { plg_svg2png, plg_svg2svg } from "./tools/plg"; + +const ROOT = "../../"; // root of the git repository + +const PATH = { + brand: "src/brand/", + dist: resolve(ROOT, "searx/static/themes/simple/"), + modules: "node_modules/", + src: "src/", + templates: resolve(ROOT, "searx/templates/simple/") +}; + +const svg2svg_opts: Config = { + plugins: [{ name: "preset-default" }, "sortAttrs", "convertStyleToAttrs"] +}; + +const svg2svg_favicon_opts: Config = { + plugins: [{ name: "preset-default" }, "sortAttrs"] +}; + +export default { + base: "/static/themes/simple/", + publicDir: "static/", + mode: "production", + // mode: "development", + + build: { + target: browserslistToEsbuild(browserslist), + cssTarget: browserslistToEsbuild(browserslist), + manifest: "manifest.json", + emptyOutDir: true, + assetsDir: "", + outDir: PATH.dist, + + sourcemap: true, + + rollupOptions: { + input: { + // build CSS files + "searxng-ltr.min.css": `${PATH.src}/less/style-ltr.less`, + "searxng-rtl.min.css": `${PATH.src}/less/style-rtl.less`, + "rss.min.css": `${PATH.src}/less/rss.less`, + + // build script files + "searxng.min": `${PATH.src}/js/main/index.ts`, + + // ol + "ol.min": `${PATH.src}/js/pkg/ol.ts`, + "ol.min.css": `${PATH.modules}/ol/ol.css` + }, + + // file naming conventions / pathnames are relative to outDir (PATH.dist) + output: { + entryFileNames: "js/[name].js", + chunkFileNames: "js/[name].js", + assetFileNames: ({ names }) => { + const [name] = names; + + const extension = name?.split(".").pop(); + switch (extension) { + case "css": + return `css/[name][extname]`; + case "js": + return `js/[name][extname]`; + case "png": + case "svg": + return `img/[name][extname]`; + default: + console.warn("Unknown asset:", name); + return `[name][extname]`; + } + } + } + } + }, // end: build + + plugins: [ + // -- svg images + plg_svg2svg( + [ + { src: `${PATH.src}/svg/empty_favicon.svg`, dest: `${PATH.dist}/img/empty_favicon.svg` }, + { src: `${PATH.src}/svg/select-dark.svg`, dest: `${PATH.dist}/img/select-dark.svg` }, + { src: `${PATH.src}/svg/select-light.svg`, dest: `${PATH.dist}/img/select-light.svg` } + ], + svg2svg_opts + ), + + // SearXNG brand (static) + plg_svg2png([ + { src: `${PATH.brand}/searxng-wordmark.svg`, dest: `${PATH.dist}/img/favicon.png` }, + { src: `${PATH.brand}/searxng.svg`, dest: `${PATH.dist}/img/searxng.png` } + ]), + + // -- svg + plg_svg2svg( + [ + { src: `${PATH.brand}/searxng.svg`, dest: `${PATH.dist}/img/searxng.svg` }, + { src: `${PATH.brand}/img_load_error.svg`, dest: `${PATH.dist}/img/img_load_error.svg` } + ], + svg2svg_opts + ), + + // -- favicon + plg_svg2svg( + [{ src: `${PATH.brand}/searxng-wordmark.svg`, dest: `${PATH.dist}/img/favicon.svg` }], + svg2svg_favicon_opts + ), + + // -- simple templates + plg_svg2svg( + [{ src: `${PATH.brand}/searxng-wordmark.svg`, dest: `${PATH.templates}/searxng-wordmark.min.svg` }], + svg2svg_opts + ) + ], // end: plugins + + // FIXME: missing CCS sourcemaps!! + // see: https://github.com/vitejs/vite/discussions/13845#discussioncomment-11992084 + // + // what I have tried so far (see config below): + // + // - build.sourcemap + // - esbuild.sourcemap + // - css.preprocessorOptions.less.sourceMap + css: { + transformer: "lightningcss", + lightningcss: { + targets: browserslistToTargets(browserslist) + }, + devSourcemap: true + }, // end: css + + experimental: { + enableNativePlugin: true + } // end: experimental +} satisfies UserConfig; |