miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

feat(nest): Add strict option (#16371)

Browse Source
This commit is contained in:
Nicholas Cunningham 2023-04-18 12:47:02 -06:00 committed by GitHub
parent a4ef9596d9
commit ce4a76a975
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 72 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/generated/packages/nest/generators/application.json
View File

@ -68,6 +68,11 @@
"type": "boolean",
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"default": false
},
"strict": {
"type": "boolean",
"description": "Adds strictNullChecks, noImplicitAny, strictBindCallApply, forceConsistentCasingInFileNames and noFallthroughCasesInSwitch to tsconfig.",
"default": false
}
},
"additionalProperties": false,

2
docs/generated/packages/nest/generators/library.json
View File

@ -110,7 +110,7 @@
"strict": {
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean",
"default": false
"default": true
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",

6
e2e/node/src/node.test.ts
View File

@ -511,8 +511,8 @@ describe('nest libraries', function () {
`libs/${nestlib}/src/lib/foo.model.ts`,
`
export class FooModel {
foo: string;
bar: number;
foo?: string;
bar?: number;
}`
);
@ -527,7 +527,7 @@ exports.FooModel = void 0;
const openapi = require("@nestjs/swagger");
class FooModel {
static _OPENAPI_METADATA_FACTORY() {
return { foo: { required: true, type: () => String }, bar: { required: true, type: () => Number } };
return { foo: { required: false, type: () => String }, bar: { required: false, type: () => Number } };
}
}
exports.FooModel = FooModel;

16
packages/nest/src/generators/application/application.spec.ts
View File

@ -59,6 +59,22 @@ describe('application generator', () => {
]);
});
it('should add strict checks with --strict', async () => {
await applicationGenerator(tree, { name: appName, strict: true });
const tsConfig = devkit.readJson(
tree,
`apps/${appDirectory}/tsconfig.app.json`
);
expect(tsConfig.compilerOptions.strictNullChecks).toBeTruthy();
expect(tsConfig.compilerOptions.noImplicitAny).toBeTruthy();
expect(tsConfig.compilerOptions.strictBindCallApply).toBeTruthy();
expect(
tsConfig.compilerOptions.forceConsistentCasingInFileNames
).toBeTruthy();
expect(tsConfig.compilerOptions.noFallthroughCasesInSwitch).toBeTruthy();
});
describe('--skipFormat', () => {
it('should format files', async () => {
jest.spyOn(devkit, 'formatFiles');

1
packages/nest/src/generators/application/lib/normalize-options.ts
View File

@ -25,6 +25,7 @@ export function normalizeOptions(
return {
...options,
strict: options.strict ?? false,
appProjectRoot,
linter: options.linter ?? Linter.EsLint,
unitTestRunner: options.unitTestRunner ?? 'jest',

10
packages/nest/src/generators/application/lib/update-tsconfig.ts
View File

@ -9,6 +9,16 @@ export function updateTsConfig(tree: Tree, options: NormalizedOptions): void {
(json) => {
json.compilerOptions.emitDecoratorMetadata = true;
json.compilerOptions.target = 'es2015';
if (options.strict) {
json.compilerOptions = {
...json.compilerOptions,
strictNullChecks: true,
noImplicitAny: true,
strictBindCallApply: true,
forceConsistentCasingInFileNames: true,
noFallthroughCasesInSwitch: true,
};
}
return json;
}
);

1
packages/nest/src/generators/application/schema.d.ts vendored
View File

@ -13,6 +13,7 @@ export interface ApplicationGeneratorOptions {
e2eTestRunner?: 'jest' | 'none';
setParserOptionsProject?: boolean;
rootProject?: boolean;
strict?: boolean;
}
interface NormalizedOptions extends ApplicationGeneratorOptions {

5
packages/nest/src/generators/application/schema.json
View File

@ -68,6 +68,11 @@
"type": "boolean",
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
"default": false
},
"strict": {
"type": "boolean",
"description": "Adds strictNullChecks, noImplicitAny, strictBindCallApply, forceConsistentCasingInFileNames and noFallthroughCasesInSwitch to tsconfig.",
"default": false
}
},
"additionalProperties": false,

18
packages/nest/src/generators/library/__snapshots__/library.spec.ts.snap
View File

@ -32,7 +32,13 @@ export default {
exports[`lib --unit-test-runner none should not generate test configuration 1`] = `
{
"compilerOptions": {
"forceConsistentCasingInFileNames": true,
"module": "commonjs",
"noFallthroughCasesInSwitch": true,
"noImplicitOverride": true,
"noImplicitReturns": true,
"noPropertyAccessFromIndexSignature": true,
"strict": true,
},
"extends": "../../tsconfig.base.json",
"files": [],
@ -62,7 +68,13 @@ exports[`lib --unit-test-runner none should not generate test configuration 2`]
exports[`lib nested should create a local tsconfig.json 1`] = `
{
"compilerOptions": {
"forceConsistentCasingInFileNames": true,
"module": "commonjs",
"noFallthroughCasesInSwitch": true,
"noImplicitOverride": true,
"noImplicitReturns": true,
"noPropertyAccessFromIndexSignature": true,
"strict": true,
},
"extends": "../../../tsconfig.base.json",
"files": [],
@ -94,7 +106,13 @@ export class MyLibModule {}
exports[`lib not nested should create a local tsconfig.json 1`] = `
{
"compilerOptions": {
"forceConsistentCasingInFileNames": true,
"module": "commonjs",
"noFallthroughCasesInSwitch": true,
"noImplicitOverride": true,
"noImplicitReturns": true,
"noPropertyAccessFromIndexSignature": true,
"strict": true,
},
"extends": "../../tsconfig.base.json",
"files": [],

1
packages/nest/src/generators/library/lib/normalize-options.ts
View File

@ -28,6 +28,7 @@ export function normalizeOptions(
const normalized: NormalizedOptions = {
...options,
strict: options.strict ?? true,
controller: options.controller ?? false,
fileName,
global: options.global ?? false,

5
packages/nest/src/generators/library/lib/update-tsconfig.ts
View File

@ -10,9 +10,10 @@ export function updateTsConfig(tree: Tree, options: NormalizedOptions): void {
if (options.strict) {
json.compilerOptions = {
...json.compilerOptions,
strictNullChecks: true,
noImplicitAny: true,
strictBindCallApply: true,
forceConsistentCasingInFileNames: true,
strict: true,
noImplicitReturns: true,
noFallthroughCasesInSwitch: true,
};
}

35
packages/nest/src/generators/library/library.spec.ts
View File

@ -247,35 +247,14 @@ describe('lib', () => {
it('should update the projects tsconfig with strict true', async () => {
await libraryGenerator(tree, { name: libName, strict: true });
const tsconfigJson = readJson(
tree,
`/libs/${libFileName}/tsconfig.lib.json`
);
expect(tsconfigJson.compilerOptions.strict).toBe(true);
const tsConfig = readJson(tree, `/libs/${libFileName}/tsconfig.lib.json`);
expect(tsConfig.compilerOptions.strictNullChecks).toBeTruthy();
expect(tsConfig.compilerOptions.noImplicitAny).toBeTruthy();
expect(tsConfig.compilerOptions.strictBindCallApply).toBeTruthy();
expect(
tsconfigJson.compilerOptions.forceConsistentCasingInFileNames
).toBe(true);
expect(tsconfigJson.compilerOptions.noImplicitReturns).toBe(true);
expect(tsconfigJson.compilerOptions.noFallthroughCasesInSwitch).toBe(
true
);
});
it('should default to strict false', async () => {
await libraryGenerator(tree, { name: libName });
const tsconfigJson = readJson(
tree,
`/libs/${libFileName}/tsconfig.lib.json`
);
expect(tsconfigJson.compilerOptions.strict).not.toBeDefined();
expect(
tsconfigJson.compilerOptions.forceConsistentCasingInFileNames
).not.toBeDefined();
expect(tsconfigJson.compilerOptions.noImplicitReturns).not.toBeDefined();
expect(
tsconfigJson.compilerOptions.noFallthroughCasesInSwitch
).not.toBeDefined();
tsConfig.compilerOptions.forceConsistentCasingInFileNames
).toBeTruthy();
expect(tsConfig.compilerOptions.noFallthroughCasesInSwitch).toBeTruthy();
});
});

2
packages/nest/src/generators/library/schema.json
View File

@ -110,7 +110,7 @@
"strict": {
"description": "Whether to enable tsconfig strict mode or not.",
"type": "boolean",
"default": false
"default": true
},
"standaloneConfig": {
"description": "Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json",