ngtrue

Checks that keep an Angular library true.

To true something is to bring it into exact alignment — a wheel, a door, a frame. That is the brief: every export takes one claim a library makes and holds it against what the library actually does.

Documentation · The three entry points · API reference · Deprecation policy

People who ship Angular libraries. Not application developers. The questions here are the ones you only have when other people install your code:

• Is this control really wired to Signal Forms, or does it only look wired?
• Does the manifest describe the files the build actually produced?
• Will the types resolve for a consumer whose tsconfig.json is not yours?

npm install --save-dev ngtrue

Always a dev dependency. @angular/core, @angular/forms and typescript are optional peers — each is needed by one entry point, and the entry point that does not need them works without them.

Split by the environment the code runs in, the same way @angular/core and @angular/core/testing are split.

No export may import another export. That is the mistake that made lodash untreeshakable, and here it would also drag @angular/core/testing or node:fs onto a path an application build can follow. It is enforced by a test, not by convention.

import { assertSignalFormsControl } from 'ngtrue/testing';

it('is a conforming Signal Forms control', async () => {
  await assertSignalFormsControl(() => TestBed.createComponent(Host));
});

One assertion, eight rules, and a failure that names the rule that broke rather than the line that noticed. It is stricter than FormValueControl deliberately: Angular makes disabled, readonly and touch optional, and a control that omits them binds and renders while the schema rules that reach for them evaporate in silence.

import { peerDependencyMismatches, unresolvableTypes, unresolvedExports } from 'ngtrue/node';

it('ships every file it advertises', () => {
  expect(unresolvedExports({ packageDir: 'dist' })).toEqual([]);
});

it('resolves its types the way a consumer will', async () => {
  expect(await unresolvableTypes({ packageDir: 'dist' })).toEqual([]);
});

it('declares what it imports, and imports what it declares', () => {
  expect(peerDependencyMismatches({ packageDir: '.', tsconfig: 'tsconfig.build.json' })).toEqual([]);
});

Each returns the problems it found, so the runner prints the offending subpath rather than "expected true to be false".

Every export states what it cannot check, next to what it can. A check that would answer the same for a working library and a broken one is worse than no check: it turns an unasked question into an answered one, and the answer is always yes. Where a rule cannot be verified honestly, ngtrue says so and leaves it to a reviewer.

MIT © Roman Khegay