1cc562a6b1
# Description of Changes This PR fixes false-positive TypeScript errors in our layered build setup (core → proprietary → desktop) by ensuring each build’s typecheck only evaluates files that are actually part of that build’s reachable module graph. This prevents overridden core implementations from being typechecked in higher-layer builds where they are effectively unreachable due to alias-based overrides. ## Background We maintain multiple build targets from a layered source tree: - core: open source baseline - proprietary: core + proprietary additions/overrides - desktop: proprietary + desktop-specific additions/overrides We implement overrides via paths/aliases such that placing a file in a higher layer at the same relative path supersedes the lower-layer file at runtime. For safety, we run TypeScript typechecking independently per build target to ensure all builds remain valid. ## Problem Our existing tsconfig setup often typechecked files that are not actually reachable in a given build. Specifically: - When a file in core is overridden by a file in proprietary or desktop, the overridden core file can still be included in the TypeScript Program for the higher-layer build (typically due to broad include globs). - This produces false-positive type errors in higher-layer typecheck runs, even though those core files are effectively unreachable in the build. This created friction and noise, and meant we had to make unnecessary changes to `core` to make the other builds happy, reducing type safety in the process. ## Solution This PR adjusts the tsconfig strategy so each build target's typecheck is driven by reachable entrypoints rather than blanket inclusion of all layer source trees. Concretely: - Each build’s tsconfig now includes only: - that build’s entrypoints and layer sources that are intended to be compiled for the target - any shared/top-level sources required by the target - Lower layers (e.g., core) are not globally included in higher-layer builds; they are instead pulled in through module resolution only when actually referenced (with paths ordering ensuring the correct override wins). - This means that we still check all the files that will actually be run with whatever the overridden logic is, but avoid wasting time and introducing false-positives by not checking files which have been overridden. ## Notes Unfortunately, the config we use for the type checking can't be the same as the one we use for Vite in this strategy. Vite needs to know about the entire source tree, so it can't only include the subfolders because it causes build errors. Because of this, I've duplicated the existing (valid) tsconfig files and use them for Vite. This is a little clunky but it does the job. Some day hopefully I'll come back to it and be able to figure out a nicer way to do it, but for now at least, this solves the type checking issues without impacting the runtime builds. Also, I noticed that `@desktop` is defined as an alias, which was presumably missed when I was removing the self-aliases from the files. I don't see why you'd ever need to have a desktop file reference `@desktop` to say "import this but make it impossible for something else to override the import". I've removed the `@desktop` alias in this PR while I was in there. |
||
|---|---|---|
| .. | ||
| public | ||
| scripts | ||
| src | ||
| src-tauri | ||
| .gitignore | ||
| eslint.config.mjs | ||
| index.html | ||
| package-lock.json | ||
| package.json | ||
| playwright.config.ts | ||
| postcss.config.js | ||
| README.md | ||
| tailwind.config.js | ||
| tsconfig.core.json | ||
| tsconfig.core.vite.json | ||
| tsconfig.desktop.json | ||
| tsconfig.desktop.vite.json | ||
| tsconfig.json | ||
| tsconfig.proprietary.json | ||
| tsconfig.proprietary.vite.json | ||
| vite-env.d.ts | ||
| vite.config.ts | ||
| vitest.config.ts | ||
Getting Started with Create React App
This project was bootstrapped with Create React App.
Docker Setup
For Docker deployments and configuration, see the Docker README.
Available Scripts
In the project directory, you can run:
npm start
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
npm test
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
npm run build
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
npm run eject
Note: this is a one-way operation. Once you eject, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
Learn More
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
Code Splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
Analyzing the Bundle Size
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
Making a Progressive Web App
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
Advanced Configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
Deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
npm run build fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
Tauri
In order to run Tauri, you first have to build the Java backend for Tauri to use.
macOS/Linux:
From the root of the repo, run:
./gradlew clean build
./scripts/build-tauri-jlink.sh
Windows
From the root of the repo, run:
gradlew clean build
scripts\build-tauri-jlink.bat
Testing the Bundled Runtime
Before building the full Tauri app, you can test the bundled runtime:
macOS/Linux:
./frontend/src-tauri/runtime/launch-stirling.sh
Windows:
frontend\src-tauri\runtime\launch-stirling.bat
This will start Stirling-PDF using the bundled JRE, accessible at http://localhost:8080
Dev
To run Tauri in development. Use the command in the frontend folder:
npm run tauri-dev
This will run the gradle runboot command and the tauri dev command concurrently, starting the app once both are stable.
Build
To build a deployment of the Tauri app. Use this command in the frontend folder:
npm run tauri-build
This will bundle the backend and frontend into one executable for each target. Targets can be set within the tauri.conf.json file.