mirror of
https://github.com/Frooodle/Stirling-PDF.git
synced 2026-02-01 20:10:35 +01:00
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.
126 lines
13 KiB
JSON
126 lines
13 KiB
JSON
{
|
|
"compilerOptions": {
|
|
/* Visit https://aka.ms/tsconfig to read more about this file */
|
|
|
|
/* Projects */
|
|
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
|
|
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
|
|
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
|
|
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
|
|
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
|
|
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
|
|
|
|
/* Language and Environment */
|
|
"target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
|
|
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
|
|
"jsx": "react-jsx", /* Specify what JSX code is generated. */
|
|
// "libReplacement": true, /* Enable lib replacement. */
|
|
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
|
|
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
|
|
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
|
|
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
|
|
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
|
|
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
|
|
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
|
|
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
|
|
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
|
|
|
|
/* Modules */
|
|
"module": "esnext", /* Specify what module code is generated. */
|
|
// "rootDir": "./", /* Specify the root folder within your source files. */
|
|
"moduleResolution": "bundler", /* Specify how TypeScript looks up a file from a given module specifier. */
|
|
"baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
|
|
"paths": { /* Specify a set of entries that re-map imports to additional lookup locations. */
|
|
"@app/*": [
|
|
"src/desktop/*",
|
|
"src/proprietary/*",
|
|
"src/core/*"
|
|
],
|
|
"@proprietary/*": ["src/proprietary/*"],
|
|
"@core/*": ["src/core/*"]
|
|
},
|
|
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
|
|
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
|
|
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
|
|
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
|
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
|
|
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
|
|
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
|
|
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
|
|
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
|
|
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
|
|
// "noUncheckedSideEffectImports": true, /* Check side effect imports. */
|
|
"resolveJsonModule": true, /* Enable importing .json files. */
|
|
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
|
|
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
|
|
|
|
/* JavaScript Support */
|
|
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
|
|
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
|
|
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
|
|
|
|
/* Emit */
|
|
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
|
|
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
|
|
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
|
|
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
|
|
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
|
|
// "noEmit": true, /* Disable emitting files from a compilation. */
|
|
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
|
|
// "outDir": "./", /* Specify an output folder for all emitted files. */
|
|
// "removeComments": true, /* Disable emitting comments. */
|
|
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
|
|
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
|
|
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
|
|
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
|
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
|
|
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
|
|
// "newLine": "crlf", /* Set the newline character for emitting files. */
|
|
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
|
|
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
|
|
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
|
|
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
|
|
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
|
|
|
|
/* Interop Constraints */
|
|
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
|
|
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
|
|
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
|
|
// "erasableSyntaxOnly": true, /* Do not allow runtime constructs that are not part of ECMAScript. */
|
|
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
|
|
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
|
|
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
|
|
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
|
|
|
|
/* Type Checking */
|
|
"strict": true, /* Enable all strict type-checking options. */
|
|
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
|
|
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
|
|
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
|
|
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
|
|
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
|
|
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
|
|
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
|
|
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
|
|
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
|
|
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
|
|
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
|
|
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
|
|
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
|
|
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
|
|
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
|
|
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
|
|
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
|
|
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
|
|
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
|
|
|
|
/* Completeness */
|
|
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
|
|
"skipLibCheck": true /* Skip type checking all .d.ts files. */
|
|
},
|
|
"include": [
|
|
"src",
|
|
"src/global.d.ts"
|
|
, "vite.config.ts" ]
|
|
}
|