Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

fix(generate): use tsconfig from shared nodecg-io-tsconfig package #74

Merged
merged 2 commits into from
Jan 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/generate/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export async function genExtension(opts: GenerationOptions, install: Installatio
genImport(writer, "requireService", opts.corePackage.name, opts.language);

if (opts.language === "typescript") {
genImport(writer, "NodeCG", `${opts.nodeeCGTypingsPackage}/types/server`, opts.language);
genImport(writer, "NodeCG", `${opts.nodeCGTypingsPackage}/types/server`, opts.language);
// Service import statements
services.forEach((svc) => {
genImport(writer, svc.clientName, svc.packageName, opts.language);
Expand Down
16 changes: 10 additions & 6 deletions src/generate/packageJson.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,20 @@ async function genDependencies(opts: GenerationOptions, serviceDeps: Dependency[
* @param nodecgDir the directory in which nodecg is installed. Used to get nodecg version which will be used by nodecg dependency.
*/
async function genTypeScriptDependencies(opts: GenerationOptions): Promise<Dependency[]> {
logger.debug(`Fetching latest ${opts.nodeeCGTypingsPackage}, typescript and @types/node versions...`);
const [nodecgVersion, latestNodeTypes, latestTypeScript] = await Promise.all([
getLatestPackageVersion(opts.nodeeCGTypingsPackage),
getLatestPackageVersion("@types/node"),
logger.debug(
`Fetching latest ${opts.nodeCGTypingsPackage}, nodecg-io-tsconfig, typescript and @types/node versions...`,
);
const [nodecgVersion, latestTsConfig, latestTypeScript, latestNodeTypes] = await Promise.all([
getLatestPackageVersion(opts.nodeCGTypingsPackage),
getLatestPackageVersion("nodecg-io-tsconfig"),
getLatestPackageVersion("typescript"),
getLatestPackageVersion("@types/node"),
]);

return [
[opts.nodeeCGTypingsPackage, `^${nodecgVersion}`],
["@types/node", `^${latestNodeTypes}`],
[opts.nodeCGTypingsPackage, `^${nodecgVersion}`],
["nodecg-io-tsconfig", `^${latestTsConfig}`],
["typescript", `^${latestTypeScript}`],
];
}
Expand All @@ -90,7 +94,7 @@ async function genTypeScriptDependencies(opts: GenerationOptions): Promise<Depen
*/
function genScripts(opts: GenerationOptions) {
if (opts.language !== "typescript") {
// For JS we don't need any scripts to build anythiing.
// For JS we don't need any scripts to build anything.
return undefined;
}

Expand Down
4 changes: 2 additions & 2 deletions src/generate/prompt.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface PromptedGenerationOptions {
export interface GenerationOptions extends PromptedGenerationOptions {
servicePackages: NpmPackage[];
corePackage: NpmPackage;
nodeeCGTypingsPackage: "nodecg" | "nodecg-types";
nodeCGTypingsPackage: "nodecg" | "nodecg-types";
bundlePath: string;
}

Expand Down Expand Up @@ -178,6 +178,6 @@ export function computeGenOptsFields(
return svcPackage;
}),
bundlePath: path.join(opts.bundleDir, opts.bundleName),
nodeeCGTypingsPackage: install.version === "0.1" ? "nodecg" : "nodecg-types",
nodeCGTypingsPackage: install.version === "0.1" ? "nodecg" : "nodecg-types",
};
}
26 changes: 7 additions & 19 deletions src/generate/tsConfig.ts
Original file line number Diff line number Diff line change
@@ -1,30 +1,18 @@
import { GenerationOptions } from "./prompt";
import { writeBundleFile } from "./utils";

const defaultTsConfigJson = {
compilerOptions: {
target: "es2019",
sourceMap: true,
lib: ["es2019"],
alwaysStrict: true,
forceConsistentCasingInFileNames: true,
noFallthroughCasesInSwitch: true,
noImplicitAny: true,
noImplicitReturns: true,
noImplicitThis: true,
strictNullChecks: true,
skipLibCheck: true,
module: "CommonJS",
types: ["node"],
},
};

/**
* Generates a tsconfig.json for a bundle if the language was set to typescript.
*/
export async function genTsConfig(opts: GenerationOptions): Promise<void> {
// Only TS needs its tsconfig.json compiler configuration
if (opts.language === "typescript") {
await writeBundleFile(defaultTsConfigJson, opts.bundlePath, "tsconfig.json");
await writeBundleFile(
{
extends: "nodecg-io-tsconfig",
},
opts.bundlePath,
"tsconfig.json",
);
}
}