Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: writing TypeScript config file #2114

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
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import { describe, expect, it } from "vitest";

import { InitializationImprovement } from "./improvements.js";
import { generateMultiTypeScriptConfig } from "./writeMultiTypeScriptConfig.js";

describe("writeMultiTypeScriptConfig", () => {
it("creates multi TypeScript config", () => {
const config = generateMultiTypeScriptConfig({
fileName: "typestat.json",
improvements: new Set([
InitializationImprovement.MissingProperties,
InitializationImprovement.NoImplicitAny,
InitializationImprovement.NoImplicitThis,
InitializationImprovement.NoInferableTypes,
InitializationImprovement.StrictNullChecks,
]),
project: { filePath: "./tsconfig.json" },
testFiles: "test/**/*.{ts,tsx}",
});

expect(config).toStrictEqual([
{
fixes: {
incompleteTypes: true,
noImplicitAny: true,
noImplicitThis: true,
noInferableTypes: true,
strictNonNullAssertions: true,
},
include: ["test/**/*.{ts,tsx}"],
projectPath: "./tsconfig.json",
types: {
strictNullChecks: true,
},
},
{
fixes: {
incompleteTypes: true,
noImplicitAny: true,
noImplicitThis: true,
noInferableTypes: true,
},
include: undefined,
projectPath: "./tsconfig.json",
},
{
fixes: {
incompleteTypes: true,
noImplicitAny: true,
noImplicitThis: true,
noInferableTypes: true,
},
include: ["test/**/*.{ts,tsx}"],
projectPath: "./tsconfig.json",
},
]);
});
});
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import * as fs from "node:fs/promises";

import { Fixes, RawTypeStatOptions } from "../../options/types.js";
import { isNotUndefined } from "../../shared/arrays.js";
import { ProjectDescription } from "../initializeProject/shared.js";
import { InitializationImprovement } from "./improvements.js";

Expand All @@ -11,61 +13,62 @@
testFiles?: string;
}

export const writeMultiTypeScriptConfig = async ({
fileName,
export const writeMultiTypeScriptConfig = async (
settings: MultiTypeScriptConfigSettings,
) => {
const config = generateMultiTypeScriptConfig(settings);
await fs.writeFile(settings.fileName, JSON.stringify(config, undefined, 4));
};

Check warning on line 21 in src/initialization/initializeTypeScript/writeMultiTypeScriptConfig.ts

View check run for this annotation

Codecov / codecov/patch

src/initialization/initializeTypeScript/writeMultiTypeScriptConfig.ts#L17-L21

Added lines #L17 - L21 were not covered by tests

export const generateMultiTypeScriptConfig = ({
improvements,
project,
sourceFiles,
testFiles,
}: MultiTypeScriptConfigSettings) => {
await fs.writeFile(
fileName,
JSON.stringify(
[
{
fixes: {
...printImprovements(improvements),
strictNonNullAssertions: true,
},
...(testFiles && { include: [testFiles] }),
projectPath: project.filePath,
types: {
strictNullChecks: true,
},
},
{
...(testFiles && { exclude: [testFiles] }),
fixes: printImprovements(improvements),
...(sourceFiles && { include: [sourceFiles] }),
projectPath: project.filePath,
},
{
fixes: printImprovements(improvements),
...(testFiles
? { include: [testFiles, sourceFiles] }
: { include: [sourceFiles] }),
projectPath: project.filePath,
},
],
undefined,
4,
),
);
const fixes = printImprovements(improvements);

const stage1: Partial<RawTypeStatOptions> = {
fixes: {
...fixes,
strictNonNullAssertions: true,
},
include: testFiles ? [testFiles] : undefined,
projectPath: project.filePath,
types: {
strictNullChecks: true,
},
};

const stage2: Partial<RawTypeStatOptions> = {
fixes,
include: sourceFiles ? [sourceFiles] : undefined,
projectPath: project.filePath,
};

const stage3Include = [testFiles, sourceFiles].filter(isNotUndefined);

const stage3: Partial<RawTypeStatOptions> = {
fixes,
include: stage3Include.length ? stage3Include : undefined,
projectPath: project.filePath,
};

return [stage1, stage2, stage3];
};

const printImprovements = (
improvements: ReadonlySet<InitializationImprovement>,
) => {
return {
incompleteTypes: true,
...(improvements.has(InitializationImprovement.NoImplicitAny) && {
rubiesonthesky marked this conversation as resolved.
Show resolved Hide resolved
noImplicitAny: true,
}),
...(improvements.has(InitializationImprovement.NoInferableTypes) && {
inferableTypes: true,
}),
...(improvements.has(InitializationImprovement.NoImplicitThis) && {
noImplicitThis: true,
}),
};
): Partial<Fixes> => {
const fixes: Partial<Fixes> = { incompleteTypes: true };
if (improvements.has(InitializationImprovement.NoImplicitAny)) {
fixes.noImplicitAny = true;
}
if (improvements.has(InitializationImprovement.NoInferableTypes)) {
fixes.noInferableTypes = true;
}
if (improvements.has(InitializationImprovement.NoImplicitThis)) {
fixes.noImplicitThis = true;
}
return fixes;
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { describe, expect, it } from "vitest";

import { InitializationImprovement } from "./improvements.js";
import { generateSingleTypeScriptConfig } from "./writeSingleTypeScriptConfig.js";

describe("writeMultiTypeScriptConfig", () => {
it("creates multi TypeScript config", () => {
const config = generateSingleTypeScriptConfig({
fileName: "typestat.json",
improvements: new Set([InitializationImprovement.NoImplicitAny]),
project: { filePath: "./tsconfig.json" },
});

expect(config).toStrictEqual({
fixes: {
incompleteTypes: true,
noImplicitAny: true,
},
include: undefined,
projectPath: "./tsconfig.json",
});

expect(JSON.stringify(config)).toBe(
'{"fixes":{"incompleteTypes":true,"noImplicitAny":true},"projectPath":"./tsconfig.json"}',
);
});
});
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import * as fs from "node:fs/promises";

import { Fixes, RawTypeStatOptions } from "../../options/types.js";
import { ProjectDescription } from "../initializeProject/shared.js";
import { InitializationImprovement } from "./improvements.js";

Expand All @@ -10,36 +11,35 @@
sourceFiles?: string;
}

export const writeSingleTypeScriptConfig = async ({
fileName,
export const writeSingleTypeScriptConfig = async (
settings: SingleTypeScriptConfigSettings,
) => {
const config = generateSingleTypeScriptConfig(settings);
await fs.writeFile(settings.fileName, JSON.stringify(config, undefined, 4));
};

Check warning on line 19 in src/initialization/initializeTypeScript/writeSingleTypeScriptConfig.ts

View check run for this annotation

Codecov / codecov/patch

src/initialization/initializeTypeScript/writeSingleTypeScriptConfig.ts#L15-L19

Added lines #L15 - L19 were not covered by tests

export const generateSingleTypeScriptConfig = ({
improvements,
project,
sourceFiles,
}: SingleTypeScriptConfigSettings) => {
await fs.writeFile(
fileName,
JSON.stringify(
{
fixes: printImprovements(improvements),
...(sourceFiles && { include: [sourceFiles] }),
projectPath: project.filePath,
},
undefined,
4,
),
);
const config: Partial<RawTypeStatOptions> = {
fixes: printImprovements(improvements),
include: sourceFiles ? [sourceFiles] : undefined,
projectPath: project.filePath,
};
return config;
};

const printImprovements = (
improvements: ReadonlySet<InitializationImprovement>,
) => {
return {
incompleteTypes: true,
...(improvements.has(InitializationImprovement.NoImplicitAny) && {
noImplicitAny: true,
}),
...(improvements.has(InitializationImprovement.NoImplicitThis) && {
noImplicitThis: true,
}),
};
): Partial<Fixes> => {
const fixes: Partial<Fixes> = { incompleteTypes: true };
if (improvements.has(InitializationImprovement.NoImplicitAny)) {
fixes.noImplicitAny = true;
}
if (improvements.has(InitializationImprovement.NoImplicitThis)) {
fixes.noImplicitThis = true;
}

Check warning on line 43 in src/initialization/initializeTypeScript/writeSingleTypeScriptConfig.ts

View check run for this annotation

Codecov / codecov/patch

src/initialization/initializeTypeScript/writeSingleTypeScriptConfig.ts#L42-L43

Added lines #L42 - L43 were not covered by tests
return fixes;
};
Loading