ng-checkup 0.0.0-stage → 0.2.0

package/dist/types.d.ts

@@ -0,0 +1,97 @@
+/**
+ * The shapes every check produces and every report renderer consumes.
+ *
+ * Kept in one dependency-free file so the renderers never import a check and a
+ * check never imports a renderer: a check only describes what it found, and the
+ * terminal, Markdown, HTML and JSON outputs decide independently how to show it.
+ */
+/**
+ * How a check judges the area it looked at.
+ *
+ * `info` means the check had nothing to grade, either because the codebase has
+ * none of what it measures (no components, no tests) or because a required
+ * input was missing (no `node_modules`). It never counts against the codebase.
+ */
+export type Grade = 'good' | 'fair' | 'poor' | 'info';
+/**
+ * How urgent a single finding is. `high` findings are lifted into the
+ * "top priorities" list at the head of every report.
+ */
+export type Severity = 'high' | 'medium' | 'low' | 'info';
+/** A source location, relative to the analysed root and always with `/` separators. */
+export interface FileRef {
+    path: string;
+    /** 1-based; absent when the finding concerns the file as a whole. */
+    line?: number;
+}
+/** One headline number shown in a check's metric grid. */
+export interface Metric {
+    label: string;
+    value: string | number;
+    /** A short qualifier rendered under the value, such as "of 214 components". */
+    hint?: string;
+}
+/** One thing a check wants a reader to act on, or at least to know. */
+export interface Finding {
+    severity: Severity;
+    /** One line, readable without the detail. Backticks mark code, as in Markdown; nothing else is markup. */
+    message: string;
+    /** Why it matters and what fixing it involves. Same markup rule as `message`. */
+    detail?: string;
+    /**
+     * Example locations, already capped at `maxExamples`. `count` holds the real
+     * total, so a renderer can say "and 40 more".
+     */
+    files?: FileRef[];
+    count?: number;
+}
+/** What one check returns. */
+export interface CheckResult {
+    /** Stable machine id, used by `--fail-on` and in the JSON output. */
+    id: string;
+    title: string;
+    grade: Grade;
+    /** One sentence shown next to the grade in every format. */
+    summary: string;
+    metrics: Metric[];
+    findings: Finding[];
+}
+/** The `ng-checkup` result as a whole, which is also the JSON output schema. */
+export interface Report {
+    tool: {
+        name: string;
+        version: string;
+    };
+    /** ISO 8601. */
+    generatedAt: string;
+    root: string;
+    project: {
+        name: string;
+        kind: WorkspaceKind;
+        angularVersion?: string;
+        sourceFiles: number;
+        templateFiles: number;
+        linesOfCode: number;
+    };
+    checks: CheckResult[];
+    durationMs: number;
+}
+/**
+ * How the repository is organised. It decides where project configuration is
+ * read from: `angular.json` for the Angular CLI, the `project.json` files for
+ * Nx. A repository with neither is still analysed, its builders are just unknown.
+ */
+export type WorkspaceKind = 'angular-cli' | 'nx' | 'unknown';
+/** Options shared by the CLI and the programmatic API. */
+export interface CheckupOptions {
+    /**
+     * Skip the npm registry lookup of the latest Angular version. The version
+     * check then compares against the newest major this release of the tool
+     * knows about and says so.
+     */
+    offline?: boolean;
+    /** How many example locations a finding lists. Defaults to 5. */
+    maxExamples?: number;
+    /** Paths to leave out, as in the config file's `ignore` (see `ignoreMatcher`). */
+    ignore?: string[];
+}

package/dist/types.js

@@ -0,0 +1,9 @@
+/**
+ * The shapes every check produces and every report renderer consumes.
+ *
+ * Kept in one dependency-free file so the renderers never import a check and a
+ * check never imports a renderer: a check only describes what it found, and the
+ * terminal, Markdown, HTML and JSON outputs decide independently how to show it.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/workspace.d.ts

@@ -0,0 +1,76 @@
+import type { WorkspaceKind } from './types.js';
+/** One build/test/e2e target of one project, as `angular.json` or a `project.json` declares it. */
+export interface TargetInfo {
+    project: string;
+    target: string;
+    /** The `builder` (Angular CLI) or `executor` (Nx), such as `@angular/build:application`. */
+    builder: string;
+    /** The target's `options` block, untyped because every builder defines its own. */
+    options: Record<string, unknown>;
+    /** Absolute directory the project's relative option paths resolve against. */
+    baseDirectory: string;
+}
+/** What the analysis knows about the repository before it reads any source file. */
+export interface WorkspaceInfo {
+    root: string;
+    name: string;
+    kind: WorkspaceKind;
+    /** `dependencies` and `devDependencies` of the root `package.json`, merged. Empty when there is none. */
+    dependencies: Record<string, string>;
+    /** Whether `node_modules/@angular/core` exists, which the deprecation index needs. */
+    hasNodeModules: boolean;
+    angular: {
+        /** The range `package.json` asks for, such as `^17.3.0`. */
+        declared?: string;
+        /** The exact version in `node_modules`, when dependencies are installed. */
+        installed?: string;
+        /** From `installed` when present, else from `declared`. Absent when Angular is not a dependency. */
+        major?: number;
+    };
+    /**
+     * The project's TypeScript major, installed version first, then the
+     * `package.json` range. It decides what an absent `strict` means: on from
+     * TypeScript 6, off before.
+     */
+    typescriptMajor?: number;
+    targets: TargetInfo[];
+    /** Every polyfill entry of every target, which is where `zone.js` is wired in for CLI 15+ projects. */
+    polyfills: string[];
+    /** The tsconfig the application is compiled with, used for the strictness flags. */
+    appTsconfig?: string;
+    /** The tsconfig holding repository-wide `paths`, used to resolve imports for the dependency graph. */
+    rootTsconfig?: string;
+}
+/**
+ * Reads the repository-level configuration: `package.json`, `angular.json` or
+ * the Nx `project.json` files, and the tsconfig files that matter.
+ *
+ * Every read is defensive. A repository is analysed as far as it can be, so a
+ * missing or malformed file leaves the corresponding field empty instead of
+ * aborting the run; the checks that depend on it then grade `info`.
+ *
+ * @param projectJsons The `project.json` paths the file walk already found, so
+ *   an Nx workspace is not walked a second time.
+ */
+export declare function readWorkspace(root: string, projectJsons: string[]): WorkspaceInfo;
+/**
+ * The major version in a version or a range: `^17.3.0` gives 17, `~22.0.8`
+ * gives 22, `22.0.8` gives 22. Undefined for anything without a leading number,
+ * such as `latest`, a git URL or a `workspace:` protocol.
+ */
+export declare function majorOf(versionOrRange: string | undefined): number | undefined;
+/**
+ * The `version` field of an installed package, or undefined when the package
+ * is not in `node_modules`. Reads `package.json` directly instead of using
+ * `require.resolve`, which would honour the analysed package's `exports` map
+ * and refuse a path it does not export.
+ */
+export declare function readInstalledVersion(root: string, packageName: string): string | undefined;
+/**
+ * Parses a JSON file that may contain comments and trailing commas, which
+ * `angular.json`, `project.json` and every tsconfig are allowed to. Returns
+ * undefined for a missing file, a parse error, or anything that is not an object.
+ */
+export declare function readJson(path: string): Record<string, unknown> | undefined;
+/** Narrows an unknown JSON value to an object, treating anything else as empty. */
+export declare function asRecord(value: unknown): Record<string, unknown>;

package/dist/workspace.js

@@ -0,0 +1,156 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { basename, dirname, join, resolve } from 'node:path';
+import ts from 'typescript';
+/**
+ * Reads the repository-level configuration: `package.json`, `angular.json` or
+ * the Nx `project.json` files, and the tsconfig files that matter.
+ *
+ * Every read is defensive. A repository is analysed as far as it can be, so a
+ * missing or malformed file leaves the corresponding field empty instead of
+ * aborting the run; the checks that depend on it then grade `info`.
+ *
+ * @param projectJsons The `project.json` paths the file walk already found, so
+ *   an Nx workspace is not walked a second time.
+ */
+export function readWorkspace(root, projectJsons) {
+    const packageJson = readJson(join(root, 'package.json'));
+    const dependencies = {
+        ...asStringRecord(packageJson?.['devDependencies']),
+        ...asStringRecord(packageJson?.['dependencies']),
+    };
+    const angularJson = readJson(join(root, 'angular.json'));
+    const isNx = existsSync(join(root, 'nx.json'));
+    const kind = angularJson ? 'angular-cli' : isNx ? 'nx' : 'unknown';
+    const targets = angularJson ? readAngularJsonTargets(root, angularJson) : readProjectJsonTargets(projectJsons);
+    const installed = readInstalledVersion(root, '@angular/core');
+    const declared = dependencies['@angular/core'];
+    return {
+        root,
+        name: typeof packageJson?.['name'] === 'string' ? packageJson['name'] : basename(root),
+        kind,
+        dependencies,
+        hasNodeModules: installed !== undefined,
+        angular: { declared, installed, major: majorOf(installed ?? declared) },
+        typescriptMajor: majorOf(readInstalledVersion(root, 'typescript') ?? dependencies['typescript']),
+        targets,
+        polyfills: targets.flatMap((target) => polyfillsOf(target.options)),
+        appTsconfig: findAppTsconfig(root, targets),
+        rootTsconfig: ['tsconfig.base.json', 'tsconfig.json'].map((name) => join(root, name)).find((path) => existsSync(path)),
+    };
+}
+/**
+ * The major version in a version or a range: `^17.3.0` gives 17, `~22.0.8`
+ * gives 22, `22.0.8` gives 22. Undefined for anything without a leading number,
+ * such as `latest`, a git URL or a `workspace:` protocol.
+ */
+export function majorOf(versionOrRange) {
+    const match = versionOrRange?.match(/(\d+)\.\d+/) ?? versionOrRange?.match(/^[\^~>=<\s]*(\d+)$/);
+    return match ? Number(match[1]) : undefined;
+}
+/**
+ * The `version` field of an installed package, or undefined when the package
+ * is not in `node_modules`. Reads `package.json` directly instead of using
+ * `require.resolve`, which would honour the analysed package's `exports` map
+ * and refuse a path it does not export.
+ */
+export function readInstalledVersion(root, packageName) {
+    const version = readJson(join(root, 'node_modules', packageName, 'package.json'))?.['version'];
+    return typeof version === 'string' ? version : undefined;
+}
+/** Targets from `angular.json`, which calls them `architect` in older files and `targets` in newer ones. */
+function readAngularJsonTargets(root, angularJson) {
+    const projects = asRecord(angularJson['projects']);
+    const targets = [];
+    for (const [projectName, value] of Object.entries(projects)) {
+        const project = asRecord(value);
+        const projectRoot = typeof project['root'] === 'string' ? project['root'] : '';
+        const declared = asRecord(project['architect'] ?? project['targets']);
+        for (const [targetName, target] of Object.entries(declared)) {
+            const builder = asRecord(target)['builder'];
+            if (typeof builder !== 'string')
+                continue;
+            // angular.json resolves option paths against the workspace root, not the project root.
+            targets.push({ project: projectName || projectRoot, target: targetName, builder, options: asRecord(asRecord(target)['options']), baseDirectory: root });
+        }
+    }
+    return targets;
+}
+/** Targets from Nx `project.json` files, which name the builder `executor`. */
+function readProjectJsonTargets(projectJsons) {
+    const targets = [];
+    for (const path of projectJsons) {
+        const project = readJson(path);
+        if (!project)
+            continue;
+        const projectName = typeof project['name'] === 'string' ? project['name'] : basename(dirname(path));
+        for (const [targetName, target] of Object.entries(asRecord(project['targets']))) {
+            const record = asRecord(target);
+            const builder = record['executor'] ?? record['builder'];
+            if (typeof builder !== 'string')
+                continue;
+            // Nx resolves option paths against the workspace root as well, which is
+            // two or more levels above the project.json in a typical apps/ layout.
+            targets.push({ project: projectName, target: targetName, builder, options: asRecord(record['options']), baseDirectory: findWorkspaceRoot(path) });
+        }
+    }
+    return targets;
+}
+/** The nearest ancestor of `path` holding `nx.json`, falling back to the file's own directory. */
+function findWorkspaceRoot(path) {
+    let directory = dirname(path);
+    while (true) {
+        if (existsSync(join(directory, 'nx.json')))
+            return directory;
+        const parent = dirname(directory);
+        if (parent === directory)
+            return dirname(path);
+        directory = parent;
+    }
+}
+/** `polyfills` is a string in CLI 15–16 projects and an array from CLI 17 on. */
+function polyfillsOf(options) {
+    const polyfills = options['polyfills'];
+    if (typeof polyfills === 'string')
+        return [polyfills];
+    return Array.isArray(polyfills) ? polyfills.filter((entry) => typeof entry === 'string') : [];
+}
+/**
+ * The application's tsconfig: the `tsConfig` option of the first application
+ * build target, then a root `tsconfig.app.json`, then the root `tsconfig.json`.
+ *
+ * A library's build target is skipped on purpose. Libraries are commonly built
+ * with laxer settings than the app, and the app config is what decides how
+ * strictly the shipped code is checked.
+ */
+function findAppTsconfig(root, targets) {
+    const applicationBuild = targets.find((target) => target.target === 'build' && /:(application|browser|browser-esbuild|webpack-browser)$/.test(target.builder));
+    const fromTarget = applicationBuild?.options['tsConfig'];
+    if (applicationBuild && typeof fromTarget === 'string') {
+        const path = resolve(applicationBuild.baseDirectory, fromTarget);
+        if (existsSync(path))
+            return path;
+    }
+    return ['tsconfig.app.json', 'tsconfig.json'].map((name) => join(root, name)).find((path) => existsSync(path));
+}
+/**
+ * Parses a JSON file that may contain comments and trailing commas, which
+ * `angular.json`, `project.json` and every tsconfig are allowed to. Returns
+ * undefined for a missing file, a parse error, or anything that is not an object.
+ */
+export function readJson(path) {
+    if (!existsSync(path))
+        return undefined;
+    const parsed = ts.parseConfigFileTextToJson(path, readFileSync(path, 'utf8'));
+    if (parsed.error || typeof parsed.config !== 'object' || parsed.config === null)
+        return undefined;
+    return parsed.config;
+}
+/** Narrows an unknown JSON value to an object, treating anything else as empty. */
+export function asRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value) ? value : {};
+}
+/** Narrows a dependency map, dropping any entry whose version is not a string. */
+function asStringRecord(value) {
+    return Object.fromEntries(Object.entries(asRecord(value)).filter((entry) => typeof entry[1] === 'string'));
+}
+//# sourceMappingURL=workspace.js.map

package/dist/workspace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.js","sourceRoot":"","sources":["../src/workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,MAAM,YAAY,CAAC;AA+C5B;;;;;;;;;;GAUG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,YAAsB;IAChE,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;IACzD,MAAM,YAAY,GAA2B;QAC3C,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,CAAC;QACnD,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,CAAC;KACjD,CAAC;IACF,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;IACzD,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAkB,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAElF,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;IAC/G,MAAM,SAAS,GAAG,oBAAoB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAE/C,OAAO;QACL,IAAI;QACJ,IAAI,EAAE,OAAO,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtF,IAAI;QACJ,YAAY;QACZ,cAAc,EAAE,SAAS,KAAK,SAAS;QACvC,OAAO,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAC,EAAE;QACvE,eAAe,EAAE,OAAO,CAAC,oBAAoB,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,YAAY,CAAC,YAAY,CAAC,CAAC;QAChG,OAAO;QACP,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACnE,WAAW,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC;QAC3C,YAAY,EAAE,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;KACvH,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,cAAkC;IACxD,MAAM,KAAK,GAAG,cAAc,EAAE,KAAK,CAAC,YAAY,CAAC,IAAI,cAAc,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACjG,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAY,EAAE,WAAmB;IACpE,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;IAC/F,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3D,CAAC;AAED,4GAA4G;AAC5G,SAAS,sBAAsB,CAAC,IAAY,EAAE,WAAoC;IAChF,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;IACnD,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,KAAK,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5D,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QAChC,MAAM,WAAW,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/E,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;QACtE,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5D,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC;YAC5C,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAAE,SAAS;YAC1C,uFAAuF;YACvF,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,IAAI,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1J,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,+EAA+E;AAC/E,SAAS,sBAAsB,CAAC,YAAsB;IACpD,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,OAAO;YAAE,SAAS;QACvB,MAAM,WAAW,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACpG,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;YAChF,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YAChC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC;YACxD,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAAE,SAAS;YAC1C,wEAAwE;YACxE,uEAAuE;YACvE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,aAAa,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpJ,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,kGAAkG;AAClG,SAAS,iBAAiB,CAAC,IAAY;IACrC,IAAI,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;QAClC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/C,SAAS,GAAG,MAAM,CAAC;IACrB,CAAC;AACH,CAAC;AAED,iFAAiF;AACjF,SAAS,WAAW,CAAC,OAAgC;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACvC,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IACtD,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACjH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,OAAqB;IAC1D,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,OAAO,IAAI,yDAAyD,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/J,MAAM,UAAU,GAAG,gBAAgB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACzD,IAAI,gBAAgB,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;QACjE,IAAI,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;IACpC,CAAC;IACD,OAAO,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;AACjH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAY;IACnC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IACxC,MAAM,MAAM,GAAG,EAAE,CAAC,yBAAyB,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9E,IAAI,MAAM,CAAC,KAAK,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IAClG,OAAO,MAAM,CAAC,MAAiC,CAAC;AAClD,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,KAAiC,CAAC,CAAC,CAAC,EAAE,CAAC;AACxH,CAAC;AAED,kFAAkF;AAClF,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAA6B,EAAE,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC;AACxI,CAAC"}

package/package.json

@@ -1,6 +1,69 @@
 {
   "name": "ng-checkup",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "A one-minute modernization report for any Angular codebase: version gap, deprecated APIs, zoneless readiness, signals adoption, test runner, type safety and circular dependencies.",
+  "keywords": [
+    "angular",
+    "audit",
+    "migration",
+    "modernization",
+    "zoneless",
+    "signals",
+    "health-check",
+    "cli"
+  ],
+  "license": "MIT",
+  "author": "Stefan Kuburovic",
+  "homepage": "https://github.com/stefankuburovic/ng-checkup#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stefankuburovic/ng-checkup.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stefankuburovic/ng-checkup/issues"
+  },
+  "type": "module",
+  "bin": {
+    "ng-checkup": "dist/cli.js"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "schematics": "./schematics/collection.json",
+  "ng-add": {
+    "save": "devDependencies"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json",
+    "./schematics/*": "./schematics/*"
+  },
+  "files": [
+    "dist",
+    "schematics"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "prepare": "npm run build",
+    "typecheck": "tsc --noEmit",
+    "pretest": "npm run build",
+    "test": "vitest run",
+    "prepublishOnly": "npm run typecheck && npm test",
+    "checkup": "node dist/cli.js"
+  },
+  "dependencies": {
+    "typescript": "~6.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^24.19.2",
+    "vitest": "^5.0.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/schematics/collection.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "schematics": {
+    "ng-add": {
+      "description": "Sets up ng-checkup: a checkup script, a config file and a CI step.",
+      "factory": "./ng-add/index.cjs#ngAdd",
+      "schema": "./ng-add/schema.json"
+    }
+  }
+}

package/schematics/ng-add/index.cjs

@@ -0,0 +1,60 @@
+'use strict';
+/**
+ * `ng add ng-checkup`.
+ *
+ * The Angular CLI has already installed the package and saved it to
+ * devDependencies (see "ng-add" in package.json) by the time this runs, so the
+ * rule only applies the same plan `ng-checkup init` does, through the CLI's
+ * virtual tree: nothing is written unless the whole schematic succeeds, and
+ * `ng add --dry-run` shows the changes for free.
+ *
+ * Written as CommonJS on purpose. The Angular CLI loads schematic factories
+ * with `require`, while the rest of this package is ESM; the planner is
+ * therefore loaded with a dynamic `import()`, which a CommonJS module may do
+ * and which Angular's rule runner awaits.
+ *
+ * It deliberately depends on nothing from @angular-devkit: the Tree and
+ * context are passed in by the CLI, so the package needs no schematics
+ * dependency of its own.
+ */
+const { join } = require('node:path');
+const { pathToFileURL } = require('node:url');
+
+/**
+ * @param {{ ci?: 'auto' | 'github' | 'gitlab' | 'none', force?: boolean }} options
+ */
+function ngAdd(options) {
+  return async (tree, context) => {
+    const { planInit } = await import(pathToFileURL(join(__dirname, '..', '..', 'dist', 'init.js')).href);
+    const { version } = require(join(__dirname, '..', '..', 'package.json'));
+
+    const plan = planInit(
+      {
+        read: (path) => {
+          const buffer = tree.read(`/${path}`);
+          return buffer ? buffer.toString('utf8') : undefined;
+        },
+        exists: (path) => {
+          if (tree.exists(`/${path}`)) return true;
+          // Tree.exists only knows files; a directory exists when it holds something.
+          const directory = tree.getDir(`/${path}`);
+          return directory.subfiles.length > 0 || directory.subdirs.length > 0;
+        },
+      },
+      { ci: options.ci ?? 'auto', force: options.force ?? false, addDependency: false, version },
+    );
+
+    for (const change of plan.changes) {
+      const path = `/${change.path}`;
+      if (tree.exists(path)) tree.overwrite(path, change.content);
+      else tree.create(path, change.content);
+      context.logger.info(`ng-checkup: ${change.path}: ${change.summary}`);
+    }
+    if (plan.changes.length === 0) context.logger.info('ng-checkup is already configured here.');
+    for (const note of plan.notes) context.logger.warn(note);
+    context.logger.info(`Run the checkup with: ${plan.nextSteps[plan.nextSteps.length - 1]}`);
+    return tree;
+  };
+}
+
+module.exports = { ngAdd };

package/schematics/ng-add/schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "NgCheckupNgAdd",
+  "title": "ng-checkup ng-add",
+  "type": "object",
+  "properties": {
+    "ci": {
+      "type": "string",
+      "enum": ["auto", "github", "gitlab", "none"],
+      "default": "auto",
+      "description": "Where to add the CI step. auto uses GitHub when .github/ exists, GitLab when .gitlab-ci.yml does.",
+      "x-prompt": {
+        "message": "Add a CI step that runs the checkup on every pull request?",
+        "type": "list",
+        "items": [
+          { "value": "auto", "label": "Yes, for the CI this repository already uses" },
+          { "value": "github", "label": "Yes, GitHub Actions" },
+          { "value": "gitlab", "label": "Yes, GitLab CI" },
+          { "value": "none", "label": "No" }
+        ]
+      }
+    },
+    "force": {
+      "type": "boolean",
+      "default": false,
+      "description": "Replace an existing \"checkup\" script."
+    }
+  }
+}