nx-lifecycle 1.1.0 → 1.1.2

package/README.md

@@ -14,8 +14,6 @@ Declare your workflow once — `build` runs hooks `pre` → `run` → `post`, `t
 - **Per-project implementations** — each project opts into the bound targets it declares, so TypeScript, Go and Java projects can all answer to the same `build` and `test`.
 - **Nothing to commit** — the plugin infers targets when Nx builds the project graph, and fails with the fix if a project's `dependsOn` breaks the wiring. An executor that writes the config to files is also available.
 
-**Compared to** hand-written `dependsOn` in `targetDefaults` and each `project.json`: there, adding a step between two existing ones means editing every target that depended on the first, in every project that has it.
-
 For the problem this solves and design rationale, see [WHY-NX-LIFECYCLE.md](https://github.com/JacobLey/leyman/blob/main/apps/nx-lifecycle/WHY-NX-LIFECYCLE.md).
 
 ## Contents
@@ -33,6 +31,7 @@ For the problem this solves and design rationale, see [WHY-NX-LIFECYCLE.md](http
     - [dryRun](#dryrun)
 - [CLI](#cli)
     - [explain](#explain)
+- [Compared to alternatives](#compared-to-alternatives)
 
 ## Install
 
@@ -368,3 +367,7 @@ my-lib
 ```
 
 Stages and bindings come from the [plugin](#plugin) options in `nx.json`, or else from `--config-file` (default `lifecycle.json`). Bound targets and their other dependencies come from the project as Nx resolves it, after `targetDefaults` and `project.json`.
+
+## Compared to alternatives
+
+Without nx-lifecycle, `dependsOn` is written by hand in `targetDefaults` and each `project.json`. Adding a step between two existing ones then means editing every target that depended on the first, in every project that has it.

package/dist/bin.d.ts

@@ -1,2 +1,3 @@
-export { LifecycleCli as default } from './cli.js';
+declare const _default: import("haywire-launcher").WrapperMain;
+export default _default;
 //# sourceMappingURL=bin.d.ts.map

package/dist/bin.js

@@ -1,3 +1,7 @@
-export { LifecycleCli as default } from './cli.js';
+import { identifier } from 'haywire';
+import { launch } from 'haywire-launcher';
+import { LifecycleCli } from './cli.js';
+import { cliContainer } from './container.js';
+export default launch(cliContainer, identifier(LifecycleCli));
 
 //# sourceMappingURL=bin.js.map

package/dist/cli.d.ts

@@ -1,11 +1,16 @@
-import { EntryScript } from 'entry-script';
+import type { Main } from 'entry-script';
+import type { RegisterCommand } from './commands/lib/types.js';
 /**
  * Lifecycle CLI. Run `./bin.mjs --help` for options.
  *
  * Uses `yargs` package for command line parsing and logic flow.
  */
-export declare class LifecycleCli extends EntryScript {
+export declare class LifecycleCli implements Main {
     #private;
+    /**
+     * @param commands - every command the CLI runs
+     */
+    constructor(commands: readonly RegisterCommand[]);
     /**
      * Entry point to CLI script.
      *
@@ -13,6 +18,7 @@ export declare class LifecycleCli extends EntryScript {
      *
      * @param argv - process arguments
      */
-    static main(argv: string[]): Promise<void>;
+    main(argv: string[]): Promise<void>;
 }
+export declare const lifecycleCliBinding: import("haywire").Binding<import("haywire").OutputHaywireId<import("haywire").HaywireId<LifecycleCli, typeof LifecycleCli, null, false, false, false, false, false>>, [import("haywire").HaywireId<RegisterCommand, null, null, true, false, false, false, false>], false>;
 //# sourceMappingURL=cli.d.ts.map

package/dist/cli.js

@@ -1,21 +1,28 @@
 import yargs from 'yargs';
-import { EntryScript } from "entry-script";
-import { explainCommand } from './commands/explain-command.js';
-import { lifecycleCommand } from './commands/lifecycle-command.js';
-export class LifecycleCli extends EntryScript {
-    static async main(argv) {
+import { bind } from 'haywire';
+import { commandId } from './commands/lib/types.js';
+export class LifecycleCli {
+    #commands;
+    constructor(commands){
+        this.#commands = commands;
+    }
+    async main(argv) {
         const packageJson = await import('../package.json', {
             with: {
                 type: 'json'
             }
         });
-        await yargs().scriptName('lifecycle').option({
+        let cli = yargs().scriptName('lifecycle').option({
             cwd: {
                 type: 'string',
                 default: '.',
                 describe: 'Directory to resolve all other paths from'
             }
-        }).strict().help().alias('help', 'info').version(packageJson.default.version).command(lifecycleCommand).command(explainCommand).parseAsync(argv, {}, LifecycleCli.#yargsOutput);
+        }).strict().help().alias('help', 'info').version(packageJson.default.version);
+        for (const register of this.#commands){
+            cli = register(cli);
+        }
+        await cli.parseAsync(argv, {}, LifecycleCli.#yargsOutput);
     }
     static #yargsOutput(e, _argv, log) {
         if (e) {
@@ -28,5 +35,8 @@ export class LifecycleCli extends EntryScript {
         }
     }
 }
+export const lifecycleCliBinding = bind(LifecycleCli).withDependencies([
+    commandId
+]).withConstructorProvider();
 
 //# sourceMappingURL=cli.js.map

package/dist/commands/explain-command.d.ts

@@ -8,5 +8,6 @@ interface ExplainCommandExtendedInput extends LifecycleCommandInput {
  * Prints the stages of a project in the order they run, with the targets bound to each hook.
  */
 export declare const explainCommand: Command<ExplainCommandExtendedInput>;
+export declare const explainCommandBinding: import("haywire").Binding<import("haywire").OutputHaywireId<import("haywire").HaywireId<import("./lib/types.js").RegisterCommand, null, null, true, false, false, false, false>>, [], false>;
 export {};
 //# sourceMappingURL=explain-command.d.ts.map

package/dist/commands/explain-command.js

@@ -1,9 +1,12 @@
 import Path from 'node:path';
 import { createProjectGraphAsync, readJsonFile, workspaceRoot } from '@nx/devkit';
+import { bind } from 'haywire';
+import { getErrorMessage } from 'unknown-error';
 import { explainLifecycle, formatExplanation } from '../lifecycle/explain.js';
 import { loadOptions } from '../lifecycle/normalizer.js';
 import { planLifecycle } from '../lifecycle/processor.js';
 import { planPluginOptions } from '../plugin/lifecycle-plugin.js';
+import { commandId } from './lib/types.js';
 const loadPlan = async ({ cwd, configFile })=>{
     const { plugins = [] } = readJsonFile(Path.join(workspaceRoot, 'nx.json'));
     const plugin = plugins.find((entry)=>typeof entry !== 'string' && entry.plugin === 'nx-lifecycle/plugin');
@@ -41,17 +44,18 @@ export const explainCommand = {
                 plan,
                 graph,
                 project: options.project,
-                ...options.stage === undefined ? {} : {
+                ...options.stage !== undefined && {
                     stage: options.stage
                 }
             });
         } catch (err) {
-            console.error(err.message);
+            console.error(getErrorMessage(err));
             process.exitCode = 1;
             return;
         }
         console.log(formatExplanation(explanation));
     }
 };
+export const explainCommandBinding = bind(commandId).withInstance((cli)=>cli.command(explainCommand));
 
 //# sourceMappingURL=explain-command.js.map

package/dist/commands/lib/types.d.ts

@@ -1,6 +1,19 @@
-import type { CommandModule } from 'yargs';
+import type { Argv, CommandModule } from 'yargs';
 export interface LifecycleCommandInput {
     cwd: string;
 }
 export type Command<ExtendedInput extends LifecycleCommandInput> = Pick<CommandModule<LifecycleCommandInput, ExtendedInput>, 'builder' | 'command' | 'describe' | 'handler'>;
+/**
+ * Adds a command to the CLI.
+ *
+ * Commands differ in the input their handler receives, so they cannot share an element type.
+ * Wrapping each in a function that registers it keeps every command type-checked against its own input.
+ */
+export type RegisterCommand = (cli: Argv<LifecycleCommandInput>) => Argv<LifecycleCommandInput>;
+/**
+ * Every command the CLI runs. Each command binds itself:
+ *
+ * `bind(commandId).withInstance(cli => cli.command(myCommand))`
+ */
+export declare const commandId: import("haywire").HaywireId<RegisterCommand, null, null, true, false, false, false, false>;
 //# sourceMappingURL=types.d.ts.map

package/dist/commands/lib/types.js

@@ -1,3 +1,4 @@
-export { };
+import { identifier } from 'haywire';
+export const commandId = identifier().list();
 
 //# sourceMappingURL=types.js.map

package/dist/commands/lifecycle-command.d.ts

@@ -8,5 +8,6 @@ interface LifecycleCommandExtendedInput extends LifecycleCommandInput {
  * Main `nx-lifecycle` command
  */
 export declare const lifecycleCommand: Command<LifecycleCommandExtendedInput>;
+export declare const lifecycleCommandBinding: import("haywire").Binding<import("haywire").OutputHaywireId<import("haywire").HaywireId<import("./lib/types.js").RegisterCommand, null, null, true, false, false, false, false>>, [], false>;
 export {};
 //# sourceMappingURL=lifecycle-command.d.ts.map

package/dist/commands/lifecycle-command.js

@@ -1,6 +1,8 @@
 import { createProjectGraphAsync, workspaceRoot } from '@nx/devkit';
 import { isCI } from 'ci-info';
+import { bind } from 'haywire';
 import { lifecycleInternal } from '../lifecycle/lifecycle-internal.js';
+import { commandId } from './lib/types.js';
 export const lifecycleCommand = {
     command: [
         '$0',
@@ -41,5 +43,6 @@ export const lifecycleCommand = {
         });
     }
 };
+export const lifecycleCommandBinding = bind(commandId).withInstance((cli)=>cli.command(lifecycleCommand));
 
 //# sourceMappingURL=lifecycle-command.js.map

package/dist/container.d.ts

@@ -0,0 +1,3 @@
+export declare const cliModule: import("haywire").Module<[import("haywire").NonExtendable<import("./cli.js").LifecycleCli, typeof import("./cli.js").LifecycleCli, null, false, false, false>] | [import("haywire").NonExtendable<import("./cli.js").LifecycleCli, typeof import("./cli.js").LifecycleCli, null, false, false, true>] | [import("haywire").NonExtendable<import("./cli.js").LifecycleCli, typeof import("./cli.js").LifecycleCli, null, false, true, false>] | [import("haywire").NonExtendable<import("./cli.js").LifecycleCli, typeof import("./cli.js").LifecycleCli, null, false, true, true>], import("haywire").CombineListOutputs<[import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, true>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, true>], [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, true>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, true>]>, [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, false>], false>;
+export declare const cliContainer: import("haywire").SyncContainer<[import("haywire").NonExtendable<import("./cli.js").LifecycleCli, typeof import("./cli.js").LifecycleCli, null, false, false, false>] | [import("haywire").NonExtendable<import("./cli.js").LifecycleCli, typeof import("./cli.js").LifecycleCli, null, false, false, true>] | [import("haywire").NonExtendable<import("./cli.js").LifecycleCli, typeof import("./cli.js").LifecycleCli, null, false, true, false>] | [import("haywire").NonExtendable<import("./cli.js").LifecycleCli, typeof import("./cli.js").LifecycleCli, null, false, true, true>] | import("haywire").CombineListOutputs<[import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, true>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, true>], [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, true>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, true>]>>;
+//# sourceMappingURL=container.d.ts.map

package/dist/container.js

@@ -0,0 +1,8 @@
+import { createContainer, createModule } from 'haywire';
+import { lifecycleCliBinding } from './cli.js';
+import { explainCommandBinding } from './commands/explain-command.js';
+import { lifecycleCommandBinding } from './commands/lifecycle-command.js';
+export const cliModule = createModule(lifecycleCliBinding).addBinding(lifecycleCommandBinding).addBinding(explainCommandBinding);
+export const cliContainer = createContainer(cliModule);
+
+//# sourceMappingURL=container.js.map

package/dist/lifecycle/explain.js

@@ -2,13 +2,10 @@ const normalizeDependency = (dependency)=>{
     if (typeof dependency !== 'string') {
         return dependency;
     }
-    if (dependency.startsWith('^')) {
-        return {
-            target: dependency.slice(1),
-            dependencies: true
-        };
-    }
-    return {
+    return dependency.startsWith('^') ? {
+        target: dependency.slice(1),
+        dependencies: true
+    } : {
         target: dependency
     };
 };
@@ -18,13 +15,17 @@ const resolveUpstream = (graph, projectName, target)=>{
         projectName
     ]);
     const visit = (name)=>{
-        for (const dependency of graph.dependencies[name] ?? []){
+        const dependencies = graph.dependencies[name];
+        if (!dependencies) {
+            return;
+        }
+        for (const dependency of dependencies){
             const node = graph.nodes[dependency.target];
             if (!node || visited.has(dependency.target)) {
                 continue;
             }
             visited.add(dependency.target);
-            if (node.data.targets && target in node.data.targets) {
+            if (node.data.targets && Object.hasOwn(node.data.targets, target)) {
                 upstream.add(dependency.target);
             } else {
                 visit(dependency.target);
@@ -85,9 +86,7 @@ export const explainLifecycle = ({ plan, graph, project, stage })=>{
         throw new Error(`Project ${project} not found`);
     }
     const targets = node.data.targets ?? {};
-    const stageNames = [
-        ...plan.lifecycleTargets.values()
-    ].filter((target)=>target.kind === 'base').map((target)=>target.name);
+    const stageNames = plan.lifecycleTargets.values().filter((target)=>target.kind === 'base').map((target)=>target.name).toArray();
     if (stage !== undefined && !stageNames.includes(stage)) {
         throw new Error(`Stage ${stage} not found. Stages: ${stageNames.join(', ')}`);
     }
@@ -106,9 +105,7 @@ export const explainLifecycle = ({ plan, graph, project, stage })=>{
     const stages = orderStages(plan, stageDependencies, stage).map((stageName)=>{
         const base = plan.lifecycleTargets.get(stageName);
         const anchor = plan.lifecycleTargets.get(`${stageName}:_`);
-        const hookTargets = [
-            ...plan.lifecycleTargets.values()
-        ].filter((target)=>target.stage === stageName && (target.kind === 'hook' || target.kind === 'base' && !target.hasHooks));
+        const hookTargets = plan.lifecycleTargets.values().filter((target)=>target.stage === stageName && (target.kind === 'hook' || target.kind === 'base' && !target.hasHooks)).toArray();
         return {
             name: stageName,
             dependsOn: anchor.dependsOn.map((dependency)=>explainDependency(graph, project, dependency)),
@@ -116,7 +113,7 @@ export const explainLifecycle = ({ plan, graph, project, stage })=>{
                     name: hook.name,
                     targets: [
                         ...plan.registeredTargets
-                    ].filter(([targetName, lifecycleTarget])=>lifecycleTarget.name === hook.name && targetName in targets).map(([targetName, lifecycleTarget])=>explainTarget(targetName, lifecycleTarget.previousHook))
+                    ].filter(([targetName, lifecycleTarget])=>lifecycleTarget.name === hook.name && Object.hasOwn(targets, targetName)).map(([targetName, lifecycleTarget])=>explainTarget(targetName, lifecycleTarget.previousHook))
                 })),
             hasHooks: base.kind === 'base' && base.hasHooks
         };

package/dist/lifecycle/processor.js

@@ -60,12 +60,15 @@ const registerTargets = ({ lifecycleTargets, options })=>{
 };
 const calculateTargetsToRemove = ({ lifecycleTargets, nxJson })=>{
     const targetsToRemove = new Set();
-    for (const [targetName, target] of lifecycleTargets.entries()){
+    for (const [targetName, target] of lifecycleTargets){
         if (target.kind !== 'base') {
             targetsToRemove.add(targetName);
         }
     }
-    for (const [targetName, target] of Object.entries(nxJson.targetDefaults ?? {})){
+    if (!nxJson.targetDefaults) {
+        return targetsToRemove;
+    }
+    for (const [targetName, target] of Object.entries(nxJson.targetDefaults)){
         if (!lifecycleTargets.has(targetName) && '__lifecycle' in (target.configurations ?? {})) {
             targetsToRemove.add(targetName);
         }
@@ -77,12 +80,15 @@ const normalizeDependencyTarget = (dependencyTarget)=>dependencyTarget.replace(/
 const removeDependencyTargets = ({ target, targetsToRemove })=>(target.dependsOn ?? []).filter((dependency)=>!targetsToRemove.has(normalizeDependencyTarget(getDependencyTarget(dependency))));
 const validateLifecycleDependencies = ({ lifecycleTargets, options })=>{
     for (const [stageName, { dependsOn }] of Object.entries(options.stages)){
-        for (const dependency of dependsOn ?? []){
+        if (!dependsOn) {
+            continue;
+        }
+        for (const dependency of dependsOn){
             const dependencyTarget = getDependencyTarget(dependency);
             const normalized = normalizeDependencyTarget(dependencyTarget);
             const lifecycleTarget = lifecycleTargets.get(normalized);
             if (lifecycleTarget && lifecycleTarget.kind !== 'base') {
-                const suggested = dependencyTarget.replace(normalized, lifecycleTarget.stage);
+                const suggested = dependencyTarget.replace(normalized, ()=>lifecycleTarget.stage);
                 throw new Error(`Lifecycle stage ${stageName} cannot depend on ${dependencyTarget}, which is internal to stage ${lifecycleTarget.stage}. Depend on ${suggested} instead`);
             }
         }
@@ -90,7 +96,10 @@ const validateLifecycleDependencies = ({ lifecycleTargets, options })=>{
 };
 const validateStaleDependencies = ({ options, targetsToRemove })=>{
     for (const [stageName, { dependsOn }] of Object.entries(options.stages)){
-        for (const dependency of dependsOn ?? []){
+        if (!dependsOn) {
+            continue;
+        }
+        for (const dependency of dependsOn){
             const dependencyTarget = getDependencyTarget(dependency);
             if (targetsToRemove.has(normalizeDependencyTarget(dependencyTarget))) {
                 throw new Error(`Lifecycle stage ${stageName} cannot depend on ${dependencyTarget}, which is a stale lifecycle target in nx.json`);
@@ -118,7 +127,7 @@ const processNxJson = ({ nxJson, lifecycleTargets, registeredTargets, targetsToR
         ...originalTargets
     };
     const lifecycles = {};
-    for (const [targetName, target] of lifecycleTargets.entries()){
+    for (const [targetName, target] of lifecycleTargets){
         lifecycles[targetName] = {
             executor: NOOP_EXECUTOR,
             dependsOn: [
@@ -146,7 +155,7 @@ const processNxJson = ({ nxJson, lifecycleTargets, registeredTargets, targetsToR
             };
         }
     }
-    for (const [targetName, lifecycleTarget] of registeredTargets.entries()){
+    for (const [targetName, lifecycleTarget] of registeredTargets){
         const registeredTarget = targetDefaults[targetName] ?? {};
         registeredTarget.dependsOn ??= [];
         registeredTarget.dependsOn.push(lifecycleTarget.previousHook);
@@ -155,11 +164,12 @@ const processNxJson = ({ nxJson, lifecycleTargets, registeredTargets, targetsToR
     }
     Object.assign(targetDefaults, lifecycles);
     for (const [targetName, target] of Object.entries(targetDefaults)){
-        if (target.dependsOn.length === 0) {
-            const originalTarget = originalTargets[targetName] ?? {};
-            if (!originalTarget.dependsOn) {
-                delete target.dependsOn;
-            }
+        if (target.dependsOn.length > 0) {
+            continue;
+        }
+        const originalTarget = originalTargets[targetName] ?? {};
+        if (!originalTarget.dependsOn) {
+            delete target.dependsOn;
         }
     }
     return {