949fac1a7c
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.
71 lines
2.4 KiB
TypeScript
71 lines
2.4 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import type { DocumentableData } from '@/application/collections/';
|
|
import { parseDocs } from '@/application/Parser/DocumentationParser';
|
|
import { itEachAbsentStringValue } from '@tests/unit/shared/TestCases/AbsentTests';
|
|
|
|
describe('DocumentationParser', () => {
|
|
describe('parseDocs', () => {
|
|
describe('throws when single documentation is missing', () => {
|
|
itEachAbsentStringValue((absentValue) => {
|
|
// arrange
|
|
const expectedError = 'missing documentation';
|
|
const node: DocumentableData = { docs: ['non empty doc 1', absentValue] };
|
|
// act
|
|
const act = () => parseDocs(node);
|
|
// assert
|
|
expect(act).to.throw(expectedError);
|
|
}, { excludeNull: true, excludeUndefined: true });
|
|
});
|
|
describe('throws when type is unexpected', () => {
|
|
// arrange
|
|
const expectedTypeError = 'docs field (documentation) must be an array of strings';
|
|
const wrongTypedValue = 22 as never;
|
|
const testCases: ReadonlyArray<{ name: string, node: DocumentableData }> = [
|
|
{
|
|
name: 'given docs',
|
|
node: { docs: wrongTypedValue },
|
|
},
|
|
{
|
|
name: 'single doc',
|
|
node: { docs: ['non empty doc 1', wrongTypedValue] },
|
|
},
|
|
];
|
|
for (const testCase of testCases) {
|
|
it(testCase.name, () => {
|
|
// act
|
|
const act = () => parseDocs(testCase.node);
|
|
// assert
|
|
expect(act).to.throw(expectedTypeError);
|
|
});
|
|
}
|
|
});
|
|
it('returns empty when empty', () => {
|
|
// arrange
|
|
const empty: DocumentableData = { };
|
|
// act
|
|
const actual = parseDocs(empty);
|
|
// assert
|
|
expect(actual).to.have.lengthOf(0);
|
|
});
|
|
it('returns single item when string', () => {
|
|
// arrange
|
|
const url = 'https://privacy.sexy';
|
|
const expected = [url];
|
|
const sut: DocumentableData = { docs: url };
|
|
// act
|
|
const actual = parseDocs(sut);
|
|
// assert
|
|
expect(actual).to.deep.equal(expected);
|
|
});
|
|
it('returns all when array', () => {
|
|
// arrange
|
|
const expected = ['https://privacy.sexy', 'https://github.com/undergroundwires/privacy.sexy'];
|
|
const sut: DocumentableData = { docs: expected };
|
|
// act
|
|
const actual = parseDocs(sut);
|
|
// assert
|
|
expect(actual).to.deep.equal(expected);
|
|
});
|
|
});
|
|
});
|