add new target family presets to add-target command

- family.json is the database of presets
- add-target help info describes the presets
- `neon add-target` can take a present e.g. `neon add-target linux`
- we won't yet change the `"targets"` section format but we'll get ready to in the future:
  * `neon tarball` in the future won't ever take a --target and create a temp dir, it'll require `--in-dir`
  * so for now let's add `neon rust-target` to do the node2rust conversion for a project, and we'll use that in neon-actions/build in a future iteration
  * to be ready for that, this repo will always use `--in-dir` instead of `--target`
  * in the next commit in this PR, let's make `neon add-target` create the template package directory for a target

.github/workflows/ci.yml

@@ -44,7 +44,7 @@ jobs:
         uses: neon-actions/[email protected]
         with:
           working-directory: ./pkgs/cargo-messages
-          target: linux-x64-gnu
+          input-directory: npm/linux-x64-gnu
           node-version: ${{ env.NODE_VERSION }}
           use-cross: false
           npm-publish: false

.github/workflows/publish.yml

@@ -65,7 +65,7 @@ jobs:
         uses: neon-actions/[email protected]
         with:
           working-directory: ./pkgs/cargo-messages
-          target: ${{ matrix.target }}
+          input-directory: npm/${{ matrix.target }}
           node-version: ${{ env.NODE_VERSION }}
           npm-publish: false
           github-release: ${{ needs.setup.outputs.action == 'publish' }}
@@ -102,7 +102,7 @@ jobs:
         uses: neon-actions/[email protected]
         with:
           working-directory: ./pkgs/cargo-messages
-          target: ${{ matrix.target }}
+          input-directory: npm/${{ matrix.target }}
           node-version: ${{ env.NODE_VERSION }}
           npm-publish: false
           github-release: ${{ needs.setup.outputs.action == 'publish' }}
@@ -139,7 +139,7 @@ jobs:
         uses: neon-actions/[email protected]
         with:
           working-directory: ./pkgs/cargo-messages
-          target: ${{ matrix.target }}
+          input-directory: npm/${{ matrix.target }}
           node-version: ${{ env.NODE_VERSION }}
           use-cross: true
           npm-publish: false

src/cli/data/family.json

@@ -0,0 +1,26 @@
+{
+  "windows": {
+    "win32-x64-msvc": "x86_64-pc-windows-msvc"
+  },
+  "macos": {
+    "darwin-x64": "x86_64-apple-darwin",
+    "darwin-arm64": "aarch64-apple-darwin"
+  },
+  "linux": {
+    "linux-x64-gnu": "x86_64-unknown-linux-gnu",
+    "linux-arm-gnueabihf": "armv7-unknown-linux-gnueabihf"
+  },
+  "desktop": {
+    "win32-x64-msvc": "x86_64-pc-windows-msvc",
+    "darwin-x64": "x86_64-apple-darwin",
+    "darwin-arm64": "aarch64-apple-darwin",
+    "linux-x64-gnu": "x86_64-unknown-linux-gnu"
+  },
+  "mobile": {
+    "win32-arm64-msvc": "aarch64-pc-windows-msvc",
+    "linux-arm-gnueabihf": "armv7-unknown-linux-gnueabihf",
+    "android-arm-eabi": "armv7-linux-androideabi"
+  },
+  "common": ["desktop"],
+  "extended": ["desktop", "mobile"]
+}

src/cli/src/command.ts

@@ -3,17 +3,21 @@ import Bump from './commands/bump.js';
 import Tarball from './commands/tarball.js';
 import AddTarget from './commands/add-target.js';
 import UpdateTargets from './commands/update-targets.js';
+import RustTarget from './commands/rust-target.js';
 import Help from './commands/help.js';
 
 export interface Command {
   run(): Promise<void>;
 }
 
+export type CommandSection = { title: string, details: CommandDetail[] };
+
 export interface CommandStatics {
   summary(): string;
   syntax(): string;
   options(): CommandDetail[];
   seeAlso(): CommandDetail[] | void;
+  extraSection(): CommandSection | void;
 }
 
 export type CommandClass = (new (argv: string[]) => Command) & CommandStatics;
@@ -31,7 +35,8 @@ export enum CommandName {
   Tarball = 'tarball',
   AddTarget = 'add-target',
   InstallBuilds = 'install-builds', // deprecated but retained for compat
-  UpdateTargets = 'update-targets'
+  UpdateTargets = 'update-targets',
+  RustTarget = 'rust-target'
 };
 
 export function isCommandName(s: string): s is CommandName {
@@ -54,7 +59,8 @@ const COMMANDS: Record<CommandName, CommandClass> = {
   [CommandName.Tarball]: Tarball,
   [CommandName.AddTarget]: AddTarget,
   [CommandName.InstallBuilds]: UpdateTargets, // deprecated but retained for compat
-  [CommandName.UpdateTargets]: UpdateTargets
+  [CommandName.UpdateTargets]: UpdateTargets,
+  [CommandName.RustTarget]: RustTarget
 };
 
 export function commandFor(name: CommandName): CommandClass {
@@ -68,6 +74,7 @@ export function summaries(): CommandDetail[] {
     { name: CommandName.Bump, summary: Bump.summary() },
     { name: CommandName.Tarball, summary: Tarball.summary() },
     { name: CommandName.AddTarget, summary: AddTarget.summary() },
-    { name: CommandName.UpdateTargets, summary: UpdateTargets.summary() }
+    { name: CommandName.UpdateTargets, summary: UpdateTargets.summary() },
+    { name: CommandName.RustTarget, summary: RustTarget.summary() }
   ];
 }

src/cli/src/commands/add-target.ts

@@ -1,6 +1,6 @@
 import commandLineArgs from 'command-line-args';
-import { Command, CommandDetail } from '../command.js';
-import { getCurrentTarget, isNodeTarget, isRustTarget } from '../target.js';
+import { Command, CommandDetail, CommandSection } from '../command.js';
+import { expandTargetFamily, getCurrentTarget, isNodeTarget, isRustTarget, isTargetFamilyKey } from '../target.js';
 import { SourceManifest } from '../manifest.js';
 
 const OPTIONS = [
@@ -16,7 +16,11 @@ export default class AddTarget implements Command {
     static syntax(): string { return 'neon add-target [<target> | -p <plat> -a <arch> [--abi <abi>]] [-b <file>]'; }
     static options(): CommandDetail[] {
       return [
-        { name: '<target>', summary: 'Full target name, in either Node or Rust convention. (Default: current target)' },
+        { name: '<target>', summary: 'Full target name, in either Node or Rust convention.' },
+        {
+          name: '',
+          summary: 'This may be a target name in either Node or Rust convention, or one of the Neon target family presets described below. (Default: current target)'
+        },
         { name: '-p, --platform <plat>', summary: 'Target platform name. (Default: current platform)' },
         { name: '-a, --arch <arch>', summary: 'Target architecture name. (Default: current arch)' },
         { name: '--abi <abi>', summary: 'Target ABI name. (Default: current ABI)' },
@@ -28,9 +32,20 @@ export default class AddTarget implements Command {
         { name: '-v, --verbose', summary: 'Enable verbose logging. (Default: false)' }
     ];
     }
-    static seeAlso(): CommandDetail[] | void {
-      return [
-      ];
+    static seeAlso(): CommandDetail[] | void { }
+    static extraSection(): CommandSection | void {
+      return {
+        title: 'Target Family Presets',
+        details: [
+          { name: 'linux', summary: 'Common desktop Linux targets.' },
+          { name: 'macos', summary: 'Common desktop macOS targets.' },
+          { name: 'windows', summary: 'Common desktop Windows targets.' },
+          { name: 'mobile', summary: 'Common mobile and tablet targets.' },
+          { name: 'desktop', summary: 'All common desktop targets.' },
+          { name: 'common', summary: 'All common targets.' },
+          { name: 'extended', summary: 'All supported targets.' }
+        ]
+      };
     }
 
     private _platform: string | null;
@@ -67,7 +82,11 @@ export default class AddTarget implements Command {
         }
         this._target = options._unknown[0];
       } else {
-        this._target = null;
+        this._target = `${options.platform}-${options.arch}`;
+
+        if (!!options.abi) {
+          this._target = `${this._target}-${options.abi}`;
+        }
       }
     }
 
@@ -87,6 +106,8 @@ export default class AddTarget implements Command {
       } else if (isNodeTarget(this._target)) {
         this.log(`adding Node target ${this._target}`);
         return sourceManifest.addNodeTarget(this._target);
+      } else if (isTargetFamilyKey(this._target)) {
+        return sourceManifest.addTargets(expandTargetFamily(this._target));
       } else {
         throw new Error(`unrecognized target ${this._target}`);
       }

src/cli/src/commands/bump.ts

@@ -2,7 +2,7 @@ import { execa } from 'execa';
 import commandLineArgs from 'command-line-args';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
-import { Command, CommandDetail } from '../command.js';
+import { Command, CommandDetail, CommandSection } from '../command.js';
 
 const OPTIONS = [
   { name: 'verbose', alias: 'v', type: Boolean, defaultValue: false },
@@ -43,6 +43,7 @@ export default class Bump implements Command {
       { name: 'npm version', summary: '<https://docs.npmjs.com/cli/commands/npm-version>' }
     ];
   }
+  static extraSection(): CommandSection | void { }
 
   private _verbose: boolean;
   private _dir: string | null;

src/cli/src/commands/dist.ts

@@ -1,7 +1,7 @@
 import { createReadStream } from 'node:fs';
 import { copyFile } from 'node:fs/promises';
 import commandLineArgs from 'command-line-args';
-import { Command, CommandDetail } from '../command.js';
+import { Command, CommandDetail, CommandSection } from '../command.js';
 import { CargoMessages, CargoReader } from 'cargo-messages';
 
 // FIXME: add options to infer crate name from manifests
@@ -44,6 +44,7 @@ export default class Dist implements Command {
       { name: 'cross-rs', summary: '<https://github.com/cross-rs/cross>' }
     ];
   }
+  static extraSection(): CommandSection | void { }
 
   private _log: string | null;
   private _file: string | null;

src/cli/src/commands/help.ts

@@ -1,5 +1,5 @@
 import { printMainUsage, printCommandUsage } from '../print.js';
-import { Command, CommandName, CommandDetail, asCommandName } from '../command.js';
+import { Command, CommandName, CommandDetail, CommandSection, asCommandName } from '../command.js';
 
 export default class Help implements Command {
   static summary(): string { return 'Display help information about Neon.'; }
@@ -10,6 +10,7 @@ export default class Help implements Command {
     ];
   }
   static seeAlso(): CommandDetail[] | void { }
+  static extraSection(): CommandSection | void { }
 
   private _name?: CommandName;
 

src/cli/src/commands/rust-target.ts

@@ -0,0 +1,95 @@
+import commandLineArgs from 'command-line-args';
+import { Command, CommandDetail, CommandSection } from '../command.js';
+import { isNodeTarget, NodeTarget } from '../target.js';
+import { SourceManifest } from '../manifest.js';
+
+const OPTIONS = [
+  { name: 'platform', alias: 'p', type: String, defaultValue: null },
+  { name: 'arch', alias: 'a', type: String, defaultValue: null },
+  { name: 'abi', type: String, defaultValue: null },
+  { name: 'verbose', alias: 'v', type: Boolean, defaultValue: false }
+];
+
+export default class RustTarget implements Command {
+    static summary(): string { return 'Look up the Rust target triple for a given build target.'; }
+    static syntax(): string { return 'neon rust-target <target> | (-p <plat> -a <arch> [--abi <abi>])'; }
+    static options(): CommandDetail[] {
+      return [
+        { name: '<target>', summary: 'Full target name in Node convention.' },
+        { name: '-p, --platform <plat>', summary: 'Target platform name.' },
+        { name: '-a, --arch <arch>', summary: 'Target architecture name.' },
+        { name: '--abi <abi>', summary: 'Target ABI name. (Default: null)' },
+        { name: '-v, --verbose', summary: 'Enable verbose logging. (Default: false)' }
+    ];
+    }
+    static seeAlso(): CommandDetail[] | void { }
+    static extraSection(): CommandSection | void { }
+
+    private _platform: string | null;
+    private _arch: string | null;
+    private _abi: string | null;
+    private _target: NodeTarget;
+    private _verbose: boolean;
+
+    constructor(argv: string[]) {
+      const options = commandLineArgs(OPTIONS, { argv, partial: true });
+
+      this._platform = options.platform || null;
+      this._arch = options.arch || null;
+      this._abi = options.abi || null;
+      this._verbose = !!options.verbose;
+
+      if (options.platform && !options.arch) {
+        throw new Error("Option --platform requires option --arch to be specified as well.");
+      }
+
+      if (!options.platform && options.arch) {
+        throw new Error("Option --arch requires option --platform to be specified as well.");
+      }
+
+      if (options.abi && (!options.platform || !options.arch)) {
+        throw new Error("Option --abi requires both options --platform and --arch to be specified as well.");
+      }
+
+      let target: string;
+
+      if (!options.platform && !options.arch && !options.abi) {
+        if (!options._unknown || options._unknown.length === 0) {
+          throw new Error("No arguments found, expected <target> or -p and -a options.");
+        }
+        target = options._unknown[0];
+      } else {
+        target = `${options.platform}-${options.arch}`;
+
+        if (!!options.abi) {
+          target = `${target}-${options.abi}`;
+        }
+      }
+
+      if (!isNodeTarget(target)) {
+        throw new Error(`${target} is not a valid Node target.`);
+      }
+
+      this._target = target;
+    }
+
+    log(msg: string) {
+      if (this._verbose) {
+        console.error("[neon rust-target] " + msg);
+      }
+    }
+
+    async run() {
+      this.log(`reading package.json`);
+      const sourceManifest = await SourceManifest.load();
+      this.log(`manifest: ${sourceManifest.stringify()}`);
+
+      const targets = sourceManifest.cfg().targets;
+      const rust = targets[this._target];
+      if (!rust) {
+        throw new Error(`no Rust target found for ${this._target}`);
+      }
+      console.log(rust);
+    }
+  }
+

src/cli/src/commands/tarball.ts

@@ -3,7 +3,7 @@ import * as path from 'node:path';
 import * as temp from 'temp';
 import commandLineArgs from 'command-line-args';
 import { execa } from 'execa';
-import { Command, CommandDetail } from '../command.js';
+import { Command, CommandDetail, CommandSection } from '../command.js';
 import { getCurrentTarget, getTargetDescriptor, isRustTarget } from '../target.js';
 import { SourceManifest, BinaryManifest } from '../manifest.js';
 
@@ -36,6 +36,7 @@ export default class Tarball implements Command {
       { name: 'cross-rs', summary: '<https://github.com/cross-rs/cross>' }
     ];
   }
+  static extraSection(): CommandSection | void { }
 
   private _target: string | null;
   private _addon: string;

src/cli/src/commands/update-targets.ts

@@ -2,7 +2,7 @@ import { execa } from 'execa';
 import commandLineArgs from 'command-line-args';
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
-import { Command, CommandDetail } from '../command.js';
+import { Command, CommandDetail, CommandSection } from '../command.js';
 import { SourceManifest } from '../manifest.js';
 
 const OPTIONS = [
@@ -28,6 +28,7 @@ export default class UpdateTargets implements Command {
       { name: 'ncc', summary: '<https://github.com/vercel/ncc>' }
     ];
   }
+  static extraSection(): CommandSection | void { }
 
   private _bundle: string | null;
   private _verbose: boolean;