Refactor to enforce strictNullChecks

This commit applies `strictNullChecks` to the entire codebase to improve
maintainability and type safety. Key changes include:

- Remove some explicit null-checks where unnecessary.
- Add necessary null-checks.
- Refactor static factory functions for a more functional approach.
- Improve some test names and contexts for better debugging.
- Add unit tests for any additional logic introduced.
- Refactor `createPositionFromRegexFullMatch` to its own function as the
  logic is reused.
- Prefer `find` prefix on functions that may return `undefined` and
  `get` prefix for those that always return a value.
This commit is contained in:
undergroundwires
2023-11-12 22:54:00 +01:00
parent 7ab16ecccb
commit 949fac1a7c
294 changed files with 2477 additions and 2738 deletions

View File

@@ -6,26 +6,34 @@ describe('ScriptCode', () => {
describe('code', () => {
describe('throws with invalid code', () => {
// arrange
const testCases = [
const testScenarios: ReadonlyArray<{
readonly description: string;
readonly code: {
readonly execute: string;
readonly revert?: string;
},
readonly expectedError: string;
}> = [
{
name: 'throws when "execute" and "revert" are same',
description: 'throws when "execute" and "revert" are same',
code: {
execute: 'same',
revert: 'same',
},
expectedError: '(revert): Code itself and its reverting code cannot be the same',
},
...getAbsentStringTestCases().map((testCase) => ({
name: `cannot construct with ${testCase.valueName} "execute"`,
code: {
execute: testCase.absentValue,
revert: 'code',
},
expectedError: 'missing code',
})),
...getAbsentStringTestCases({ excludeNull: true, excludeUndefined: true })
.map((testCase) => ({
description: `cannot construct with ${testCase.valueName} "execute"`,
code: {
execute: testCase.absentValue,
revert: 'code',
},
expectedError: 'missing code',
})),
];
for (const testCase of testCases) {
it(testCase.name, () => {
for (const testCase of testScenarios) {
it(testCase.description, () => {
// act
const act = () => new ScriptCodeBuilder()
.withExecute(testCase.code.execute)
@@ -38,21 +46,27 @@ describe('ScriptCode', () => {
});
describe('sets as expected with valid "execute" or "revert"', () => {
// arrange
const testCases = [
const testScenarios: ReadonlyArray<{
readonly description: string;
readonly code: string;
readonly revertCode: string | undefined;
}> = [
{
testName: 'code and revert code is given',
description: 'code and revert code is given',
code: 'valid code',
revertCode: 'valid revert-code',
},
{
testName: 'only code is given but not revert code',
code: 'valid code',
revertCode: undefined,
},
...getAbsentStringTestCases({ excludeNull: true })
.map((testCase) => ({
description: `only code is given but not revert code (given ${testCase.valueName})`,
code: 'valid code',
revertCode: testCase.absentValue,
expectedError: 'missing code',
})),
];
// assert
for (const testCase of testCases) {
it(testCase.testName, () => {
for (const testCase of testScenarios) {
it(testCase.description, () => {
// act
const sut = new ScriptCodeBuilder()
.withExecute(testCase.code)
@@ -70,14 +84,14 @@ describe('ScriptCode', () => {
class ScriptCodeBuilder {
public execute = 'default-execute-code';
public revert = '';
public revert: string | undefined = '';
public withExecute(execute: string) {
this.execute = execute;
return this;
}
public withRevert(revert: string) {
public withRevert(revert: string | undefined) {
this.revert = revert;
return this;
}