neworbit / not-valid Goto Github PK

The validators should have documentation around what formats they expect.

This will make it easier for users to understand whether or not their needs are met by the validator

Some validators have "UK" in the name but others do not despite being a UK-based thing (e.g. NI number)

It would probably be good to add UK to all of the ones that are UK specific

In the latest release (1.1.1) some relative paths in declaration files are incorrectly specified - this appears to be due to microsoft/TypeScript#24599. This results in build errors in any project that consumes not-valid.

Example, in bin/create-validator.d.ts:

export declare const createValidator: <T>(predicate: ValidationPredicate<T>, message: string) => (value: T) => import("../../../Code/validation/src/results/validation-result").ValidationResult;
export declare const createValidatorFactory: <T>(predicate: (value: T) => boolean, defaultMessage: string) => (message?: string | undefined) => (value: T) => import("../../../Code/validation/src/results/validation-result").ValidationResult;
export declare const createAsyncValidator: <T>(predicate: (value: T) => Promise<boolean>, message: string) => (value: T) => Promise<import("../../../Code/validation/src/results/validation-result").ValidationResult>;
export declare const createAsyncValidatorFactory: <T>(predicate: (value: T) => Promise<boolean>, defaultMessage: string) => (message?: string | undefined) => (value: T) => Promise<import("../../../Code/validation/src/results/validation-result").ValidationResult>;

Upgrading to typescript@3 fixes this.

Add check if min and max are same return valid error message

Per https://docs.npmjs.com/misc/scripts#prepublish-and-prepare, npm prepublish is deprecated because, confusingly, it runs before every npm install. We should be using prepublishOnly instead.

@OwenPattison mentioned that we should add more keywords to package.json in order to have better discoverability on npmjs

I think we should move the tests alongside the code:

• it makes them easier to find
• easier to import the SUT
• really obvious if a file doesn't have tests
• also just to standardise the structure to follow our other packages and internal projects (Momenta, TTC and TeamPrevent are all doing this for there front end code)

Also then build all the test files into another directory to keep the working directory clean.

Example of tsconfig setup: https://github.com/NewOrbit/redux-authorisation