R CompilerOptions#project to tsConfig

fixes #53
quatico-solutions · Jan 25, 2025 · 3895f8e · 3895f8e
1 parent 4d6ff4a
commit 3895f8e
Show file tree

Hide file tree

Showing 22 changed files with 73 additions and 73 deletions.
diff --git a/packages/compiler/src/CompilerArguments.ts b/packages/compiler/src/CompilerArguments.ts
@@ -6,7 +6,7 @@ import { CompilerOptions } from "@quatico/websmith-core";
  *   Licensed under the MIT License. See LICENSE in the project root for license information.
  * ---------------------------------------------------------------------------------------------
  */
-export interface CompilerArguments extends Partial<Omit<CompilerOptions, "tsconfig" | "reporter" | "project" | "additionalArguments" | "targets">> {
+export interface CompilerArguments extends Partial<Omit<CompilerOptions, "cliArgs" | "reporter" | "tsConfig" | "additionalArguments" | "targets">> {
     targets?: string;
     files?: string[];
     project?: string;

diff --git a/packages/compiler/src/command.spec.ts b/packages/compiler/src/command.spec.ts
@@ -66,7 +66,7 @@ describe("addCompileCommand", () => {
             outDir: "/lib",
             sourceMap: false,
         };
-        expect(actual.project).toEqual(compilerOptions);
+        expect(actual.tsConfig).toEqual(compilerOptions);
 
         expect({ wildcardDirectories: {}, ...actual.cliArgs }).toEqual({
             options: compilerOptions,
@@ -116,7 +116,7 @@ describe("addCompileCommand", () => {
 
         addCompileCommand(new Command(), target).parse(["--project", "expected/tsconfig.json"], { from: "user" });
 
-        expect(target.getOptions().project.configFilePath).toEqual(expect.stringContaining("/expected/tsconfig.json"));
+        expect(target.getOptions().tsConfig.configFilePath).toEqual(expect.stringContaining("/expected/tsconfig.json"));
     });
 
     it("should yield sourceMap option w/ --sourceMap cli argument", () => {

diff --git a/packages/compiler/src/options.spec.ts b/packages/compiler/src/options.spec.ts
@@ -28,7 +28,7 @@ describe("createOptions", () => {
             },
         });
 
-        const actual = createOptions({ project: "./expected/tsconfig.json" }, new NoReporter(), target).project;
+        const actual = createOptions({ project: "./expected/tsconfig.json" }, new NoReporter(), target).tsConfig;
 
         expect(actual).toEqual({
             configFilePath: "/expected/tsconfig.json",
@@ -109,7 +109,7 @@ describe("createOptions", () => {
                 addons: ["one", "two"],
                 addonsDir: "/expected",
             },
-            project: {
+            tsConfig: {
                 configFilePath: "/tsconfig.json",
                 outDir: "/lib",
             },

diff --git a/packages/compiler/src/options.ts b/packages/compiler/src/options.ts
@@ -53,7 +53,7 @@ export const createOptions = (args: CompilerArguments, reporter = new NoReporter
         // TODO: Do we need lib files, or is injecting them into the system sufficient?
         // files?: Record<string, string>;
         cliArgs: tsConfig,
-        project: tsConfig.options,
+        tsConfig: tsConfig.options,
         reporter,
         sourceMap: args.sourceMap ?? DEFAULTS.sourceMap,
         targets: resolveTargets(targets, compilationConfig, reporter),

diff --git a/packages/core/src/compiler/Compiler.e2e.spec.ts b/packages/core/src/compiler/Compiler.e2e.spec.ts
@@ -11,7 +11,7 @@ describe("end-2-end compile", () => {
 
         const actual = new Compiler(
             compileOptions(target, {
-                project: { outDir: "./bin" },
+                tsConfig: { outDir: "./bin" },
             }),
             target
         ).compile();

diff --git a/packages/core/src/compiler/Compiler.spec.ts b/packages/core/src/compiler/Compiler.spec.ts
@@ -60,7 +60,7 @@ describe("getSystem", () => {
 describe("setOptions", () => {
     it("replaces compiler options", () => {
         const expected = {
-            project: {
+            tsConfig: {
                 react: 1,
             },
         } as unknown as CompilerOptions;
@@ -78,7 +78,7 @@ describe("setOptions", () => {
         }).getSourceFile("src/target.ts");
 
         new CompilerTestClass(
-            compileOptions(target, { project: { outDir: "/expected" }, cliArgs: { fileNames: [entry!.fileName] } }),
+            compileOptions(target, { tsConfig: { outDir: "/expected" }, cliArgs: { fileNames: [entry!.fileName] } }),
             target
         ).watch();
 
@@ -183,7 +183,7 @@ describe("compile", () => {
                 sourceMap: false,
                 transpileOnly: false,
                 watch: false,
-                project: {
+                tsConfig: {
                     module: ts.ModuleKind.ESNext,
                     target: ts.ScriptTarget.Latest,
                     configFilePath: "./tsconfig.json",
@@ -212,7 +212,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: true },
+            tsConfig: { declaration: true },
             cliArgs: { fileNames: [entry!.fileName] },
         });
 
@@ -235,7 +235,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: true },
+            tsConfig: { declaration: true },
             cliArgs: { fileNames: [entry!.fileName] },
         });
 
@@ -258,7 +258,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: false, sourceMap: false },
+            tsConfig: { declaration: false, sourceMap: false },
             cliArgs: { fileNames: [entry!.fileName] },
             transpileOnly: true,
         });
@@ -279,7 +279,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: true, declarationMap: false, sourceMap: false },
+            tsConfig: { declaration: true, declarationMap: false, sourceMap: false },
             cliArgs: { fileNames: [entry!.fileName] },
             sourceMap: true,
             transpileOnly: true,
@@ -301,7 +301,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: true, declarationMap: true, sourceMap: false },
+            tsConfig: { declaration: true, declarationMap: true, sourceMap: false },
             cliArgs: { fileNames: [entry!.fileName] },
             sourceMap: true,
             transpileOnly: true,
@@ -323,7 +323,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: false, declarationMap: false, sourceMap: true },
+            tsConfig: { declaration: false, declarationMap: false, sourceMap: true },
             cliArgs: { fileNames: [entry!.fileName] },
             sourceMap: true,
             transpileOnly: true,
@@ -348,7 +348,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: false, sourceMap: false },
+            tsConfig: { declaration: false, sourceMap: false },
             cliArgs: { fileNames: [entry!.fileName] },
         });
 
@@ -368,7 +368,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: true, declarationMap: false, sourceMap: false },
+            tsConfig: { declaration: true, declarationMap: false, sourceMap: false },
             cliArgs: { fileNames: [entry!.fileName] },
             sourceMap: true,
         });
@@ -393,7 +393,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: true, declarationMap: true, sourceMap: false },
+            tsConfig: { declaration: true, declarationMap: true, sourceMap: false },
             cliArgs: { fileNames: [entry!.fileName] },
             sourceMap: true,
         });
@@ -421,7 +421,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: false, declarationMap: false, sourceMap: true },
+            tsConfig: { declaration: false, declarationMap: false, sourceMap: true },
             cliArgs: { fileNames: [entry!.fileName] },
             sourceMap: true,
         });
@@ -445,7 +445,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: false, declarationMap: false, sourceMap: false },
+            tsConfig: { declaration: false, declarationMap: false, sourceMap: false },
             cliArgs: { fileNames: [entry!.fileName] },
             sourceMap: true,
             transpileOnly: true,
@@ -467,7 +467,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("src/target.ts");
         const target = compileOptions(fileSystem, {
-            project: { declaration: false, declarationMap: false, sourceMap: false },
+            tsConfig: { declaration: false, declarationMap: false, sourceMap: false },
             cliArgs: { fileNames: [entry!.fileName] },
             sourceMap: true,
         });
@@ -486,7 +486,7 @@ describe("emitSourceFile", () => {
             "src/config.json": `{"name":"test"}`,
         }).getSourceFile("src/config.json");
         const target = compileOptions(fileSystem, {
-            project: {
+            tsConfig: {
                 declaration: false,
                 declarationMap: false,
                 sourceMap: false,
@@ -509,7 +509,7 @@ describe("emitSourceFile", () => {
             "src/config.json": `{"name":"test"}`,
         }).getSourceFile("src/config.json");
         const target = compileOptions(fileSystem, {
-            project: {
+            tsConfig: {
                 declaration: false,
                 declarationMap: false,
                 sourceMap: false,
@@ -538,7 +538,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("types/style.d.ts");
         const target = compileOptions(fileSystem, {
-            project: {
+            tsConfig: {
                 declaration: false,
                 declarationMap: false,
                 sourceMap: false,
@@ -567,7 +567,7 @@ describe("emitSourceFile", () => {
             `,
         }).getSourceFile("types/style.d.ts");
         const target = compileOptions(fileSystem, {
-            project: {
+            tsConfig: {
                 declaration: false,
                 declarationMap: false,
                 sourceMap: false,
@@ -675,7 +675,7 @@ describe("watch", () => {
                 configFilePath: "/fake/websmith.config.json",
                 targets: { "*": { writeFile: true } },
             },
-            project: { declaration: true, outDir: "/build" },
+            tsConfig: { declaration: true, outDir: "/build" },
             cliArgs: { fileNames: [entry!.fileName] },
             watch: true,
         });
@@ -707,7 +707,7 @@ describe("watch", () => {
                 configFilePath: "/fake/websmith.config.json",
                 targets: { "*": { writeFile: true, options: { outDir: "/build" } } },
             },
-            project: { declaration: true },
+            tsConfig: { declaration: true },
             cliArgs: { options: { outDir: "/build" }, fileNames: [entry!.fileName] },
             watch: true,
         });
@@ -742,7 +742,7 @@ describe("watch", () => {
                     target2: { writeFile: true, options: { outDir: "/target2", declaration: false } },
                 },
             },
-            project: { declaration: true },
+            tsConfig: { declaration: true },
             targets: ["target1", "target2"],
             cliArgs: { options: { outDir: "/build" }, fileNames: [entry!.fileName] },
             watch: true,
@@ -786,7 +786,7 @@ describe("watch", () => {
                     },
                 },
             },
-            project: { declaration: true },
+            tsConfig: { declaration: true },
             targets: ["target1", "target2"],
             cliArgs: { options: { outDir: "/build" }, fileNames: [entry!.fileName] },
             transpileOnly: true,
@@ -837,7 +837,7 @@ describe("watch", () => {
                     target1: { writeFile: true, options: { outDir: "/target1" } },
                 },
             },
-            project: { declaration: true },
+            tsConfig: { declaration: true },
             targets: ["target1"],
             cliArgs: {
                 options: { outDir: "/build" },
@@ -889,7 +889,7 @@ describe("watch", () => {
                     target1: { writeFile: true, options: { outDir: "/target1" } },
                 },
             },
-            project: { declaration: true },
+            tsConfig: { declaration: true },
             targets: ["target1"],
             cliArgs: { options: { outDir: "/build" }, fileNames: [entry!.fileName] },
             watch: true,

diff --git a/packages/core/src/compiler/Compiler.ts b/packages/core/src/compiler/Compiler.ts
@@ -227,15 +227,15 @@ export class Compiler {
         target?: string,
         registerDependencyCallback?: (filePath: string) => void
     ): CompilationContext {
-        const { buildDir, config, configFile, project, cliArgs, watch } = compileOptions;
+        const { buildDir, config, configFile, tsConfig, cliArgs, watch } = compileOptions;
         const { options = {}, config: targetConfig } = getTargetConfig(target, config);
         return new CompilationContext({
             buildDir,
-            project: { ...project, ...options },
+            tsConfig: { ...tsConfig, ...options },
             projectDir: dirname(configFile ?? cliArgs.raw?.configFilePath ?? this.system.getCurrentDirectory()),
             system: this.system,
-            program: ts.createProgram({ rootNames: this.getRootFiles(), options: project, host: createCompileHost(project) }),
-            cliArgs: { ...cliArgs, options: { ...project, ...options } },
+            program: ts.createProgram({ rootNames: this.getRootFiles(), options: tsConfig, host: createCompileHost(tsConfig) }),
+            cliArgs: { ...cliArgs, options: { ...tsConfig, ...options } },
             rootFiles: this.getRootFiles(),
             reporter: this.reporter,
             ...(!!targetConfig && { config: targetConfig }),
@@ -344,7 +344,7 @@ export class Compiler {
 
     private transpileJson({ ctx, fileName, content }: CompilationFragment) {
         // JSON are only output by TypoScript if an outDir is provided, otherwise they are ignored.
-        if (this.options.project.outDir !== undefined) {
+        if (this.options.tsConfig.outDir !== undefined) {
             const fileNames = ts.getOutputFileNames(ctx.getConfig(), fileName, !this.system.useCaseSensitiveFileNames);
             return { outputFiles: [{ name: fileNames[0], text: content, writeByteOrderMark: false }], emitSkipped: false };
         }

diff --git a/packages/core/src/compiler/CompilerOptions.ts b/packages/core/src/compiler/CompilerOptions.ts
@@ -15,7 +15,7 @@ export interface CompilerOptions {
     configFile?: string;
     debug?: boolean;
     cliArgs: ts.ParsedCommandLine;
-    project: ts.CompilerOptions;
+    tsConfig: ts.CompilerOptions;
     reporter: Reporter;
     sourceMap?: boolean;
     /**

diff --git a/packages/core/src/compiler/compilation/CompilationContext.spec.ts b/packages/core/src/compiler/compilation/CompilationContext.spec.ts
@@ -55,7 +55,7 @@ beforeEach(() => {
     testProgram = ts.createProgram({ options: {}, rootNames: [] });
     testObj = new CompilationContextTestClass({
         buildDir: "",
-        project: {},
+        tsConfig: {},
         projectDir: testSystem.getCurrentDirectory(),
         reporter: new ReporterMock(testSystem),
         rootFiles: [],
@@ -182,7 +182,7 @@ describe("resolvePath", () => {
     beforeEach(() => {
         testObj = new CompilationContextTestClass({
             buildDir: "",
-            project: {},
+            tsConfig: {},
             projectDir: "/expected",
             reporter: new ReporterMock(testSystem),
             rootFiles: [],
@@ -271,7 +271,7 @@ describe("addAssetDependency", () => {
         const target = jest.fn();
         testObj = new CompilationContextTestClass({
             buildDir: "",
-            project: {},
+            tsConfig: {},
             projectDir: testSystem.getCurrentDirectory(),
             reporter: new ReporterMock(testSystem),
             rootFiles: [],

diff --git a/packages/core/src/compiler/compilation/CompilationContext.ts b/packages/core/src/compiler/compilation/CompilationContext.ts
@@ -15,7 +15,7 @@ export type CompilationContextOptions = {
     buildDir: string;
     config?: unknown;
     program: ts.Program;
-    project: ts.CompilerOptions;
+    tsConfig: ts.CompilerOptions;
     projectDir: string;
     reporter: Reporter;
     rootFiles: string[];
@@ -50,7 +50,7 @@ export class CompilationContext implements AddonContext {
     private assetCodeDependency: Map<string, string[]> = new Map();
 
     constructor(options: CompilationContextOptions) {
-        const { buildDir, config, program, project, projectDir, rootFiles, system, target, cliArgs, watchCallback, registerDependencyCallback } =
+        const { buildDir, config, program, tsConfig, projectDir, rootFiles, system, target, cliArgs, watchCallback, registerDependencyCallback } =
             options;
         this.buildDir = buildDir;
         this.rootFiles = rootFiles;
@@ -61,7 +61,7 @@ export class CompilationContext implements AddonContext {
         this.generators = [];
         this.languageHost = this.createLanguageServiceHost({
             system,
-            options: project,
+            options: tsConfig,
             target,
         });
         this.cache = new FileCache(system);

diff --git a/packages/core/test/compile-options.ts b/packages/core/test/compile-options.ts
@@ -21,11 +21,11 @@ export const compileOptions = (
         transpileOnly: false,
         watch: false,
         ...overrides,
-        project: {
+        tsConfig: {
             module: ts.ModuleKind.ESNext,
             target: ts.ScriptTarget.Latest,
             configFilePath: "./tsconfig.json",
-            ...overrides?.project,
+            ...overrides?.tsConfig,
         },
         targets: overrides?.targets ?? ["*"],
         cliArgs: {