@neon-rs/cli 0.0.4 → 0.0.5

package/dist/commands/install-builds.js

@@ -1,65 +0,0 @@
-import { execa } from 'execa';
-import commandLineArgs from 'command-line-args';
-import * as fs from 'node:fs/promises';
-import * as path from 'node:path';
-const OPTIONS = [
-    { name: 'bundle', alias: 'b', type: String, defaultValue: null },
-    { name: 'no-bundle', alias: 'B', type: String, defaultValue: null }
-];
-export default class InstallBuilds {
-    static summary() { return 'Install dependencies on prebuilds in package.json.'; }
-    static syntax() { return 'neon install-builds [-b <file>|-B]'; }
-    static options() {
-        return [
-            { name: '-b, --bundle <file>', summary: 'File to generate bundling metadata. (Default: .targets)' },
-            {
-                name: '',
-                summary: 'This generated file ensures support for bundlers (e.g. @vercel/ncc), which rely on static analysis to detect and enable any addons used by the library.'
-            },
-            { name: '-B, --no-bundle', summary: 'Do not generate bundling metadata.' }
-        ];
-    }
-    static seeAlso() {
-        return [
-            { name: 'ncc', summary: '<https://github.com/vercel/ncc>' }
-        ];
-    }
-    constructor(argv) {
-        const options = commandLineArgs(OPTIONS, { argv });
-        if (options.bundle && options['no-bundle']) {
-            throw new Error("Options --bundle and --no-bundle cannot both be enabled.");
-        }
-        this._bundle = options['no-bundle']
-            ? null
-            : !options.bundle
-                ? '.targets'
-                : options.bundle;
-    }
-    async run() {
-        const manifest = JSON.parse(await fs.readFile(path.join(process.cwd(), 'package.json'), { encoding: 'utf8' }));
-        const version = manifest.version;
-        const targets = Object.values(manifest.neon.targets);
-        const specs = targets.map(name => `${name}@${version}`);
-        const result = await execa('npm', ['install', '--save-exact', '-O', ...specs], { shell: true });
-        if (result.exitCode !== 0) {
-            console.error(result.stderr);
-            process.exit(result.exitCode);
-        }
-        if (!this._bundle) {
-            return;
-        }
-        const PREAMBLE = `// AUTOMATICALLY GENERATED FILE. DO NOT EDIT.
-//
-// This code is never executed but is detected by the static analysis of
-// bundlers such as \`@vercel/ncc\`. The require() expression that selects
-// the right binary module for the current platform is too dynamic to be
-// analyzable by bundler analyses, so this module provides an exhaustive
-// static list for those analyses.
-
-return;
-
-`;
-        const requires = targets.map(name => `require('${name}');`).join('\n');
-        await fs.writeFile(this._bundle, PREAMBLE + requires + '\n');
-    }
-}

package/dist/commands/pack-build.js

@@ -1,108 +0,0 @@
-import * as fs from 'node:fs/promises';
-import * as path from 'node:path';
-import { createRequire } from 'node:module';
-import * as temp from 'temp';
-import commandLineArgs from 'command-line-args';
-import { execa } from 'execa';
-const mktemp = temp.track().mkdir;
-const OPTIONS = [
-    { name: 'file', alias: 'f', type: String, defaultValue: 'index.node' },
-    { name: 'target', alias: 't', type: String, defaultValue: null },
-    { name: 'out-dir', alias: 'd', type: String, defaultValue: null }
-];
-const require = createRequire(import.meta.url);
-const LLVM = require('../../data/llvm.json');
-const NODE = require('../../data/node.json');
-function lookup(target) {
-    const path = LLVM[target];
-    if (!path) {
-        throw new Error(`Rust target ${target} not supported`);
-    }
-    const [platform, arch, abi] = path;
-    return NODE[platform][arch][abi];
-}
-export default class PackBuild {
-    static summary() { return 'Create an npm tarball from a prebuild.'; }
-    static syntax() { return 'neon pack-build [-f <addon>] [-t <target>] [-d <dir>]'; }
-    static options() {
-        return [
-            { name: '-f, --file <addon>', summary: 'Prebuilt .node file to pack. (Default: index.node)' },
-            { name: '-t, --target <target>', summary: 'Rust target triple the addon was built for. (Default: rustc default host)' },
-            { name: '-d, --out-dir <path>', summary: 'Output directory, recursively created if needed. (Default: ./dist)' }
-        ];
-    }
-    static seeAlso() {
-        return [
-            { name: 'Rust platform support', summary: '<https://doc.rust-lang.org/rustc/platform-support.html>' },
-            { name: 'npm pack', summary: '<https://docs.npmjs.com/cli/commands/npm-pack>' },
-            { name: 'cross-rs', summary: '<https://github.com/cross-rs/cross>' }
-        ];
-    }
-    constructor(argv) {
-        const options = commandLineArgs(OPTIONS, { argv });
-        this._target = options.target || null;
-        this._addon = options.file;
-        this._outDir = options['out-dir'] || path.join(process.cwd(), 'dist');
-    }
-    async currentTarget() {
-        const result = await execa("rustc", ["-vV"], { shell: true });
-        if (result.exitCode !== 0) {
-            throw new Error(`Could not determine current Rust target: ${result.stderr}`);
-        }
-        const hostLine = result.stdout.split(/\n/).find(line => line.startsWith('host:'));
-        if (!hostLine) {
-            throw new Error("Could not determine current Rust target (unexpected rustc output)");
-        }
-        return hostLine.replace(/^host:\s+/, '');
-    }
-    async run() {
-        await fs.mkdir(this._outDir, { recursive: true });
-        const manifest = JSON.parse(await fs.readFile('package.json', { encoding: 'utf8' }));
-        const version = manifest.version;
-        const targets = manifest.neon.targets;
-        const target = this._target || await this.currentTarget();
-        const name = targets[target];
-        if (!name) {
-            throw new Error(`Rust target ${target} not found in package.json.`);
-        }
-        const targetInfo = lookup(target);
-        const description = `Prebuilt binary package for \`${manifest.name}\` on \`${targetInfo.node}\`.`;
-        let prebuildManifest = {
-            name,
-            description,
-            version,
-            os: [targetInfo.platform],
-            cpu: [targetInfo.arch],
-            main: "index.node",
-            files: ["README.md", "index.node"]
-        };
-        const OPTIONAL_KEYS = [
-            'author', 'repository', 'keywords', 'bugs', 'homepage', 'license', 'engines'
-        ];
-        for (const key of OPTIONAL_KEYS) {
-            if (manifest[key]) {
-                prebuildManifest[key] = manifest[key];
-            }
-        }
-        const tmpdir = await mktemp('neon-');
-        await fs.writeFile(path.join(tmpdir, "package.json"), JSON.stringify(prebuildManifest, null, 2));
-        await fs.copyFile(this._addon, path.join(tmpdir, "index.node"));
-        await fs.writeFile(path.join(tmpdir, "README.md"), `# \`${name}\`\n\n${description}\n`);
-        const result = await execa("npm", ["pack", "--json"], {
-            shell: true,
-            cwd: tmpdir,
-            stdio: ['pipe', 'pipe', 'inherit']
-        });
-        if (result.exitCode !== 0) {
-            process.exit(result.exitCode);
-        }
-        // FIXME: comment linking to the npm issue this fixes
-        const tarball = JSON.parse(result.stdout)[0].filename.replace('@', '').replace('/', '-');
-        const dest = path.join(this._outDir, tarball);
-        // Copy instead of move since e.g. GitHub Actions Windows runners host temp directories
-        // on a different device (which causes fs.renameSync to fail).
-        await fs.copyFile(path.join(tmpdir, tarball), dest);
-        console.log(dest);
-    }
-    ;
-}

package/dist/index.js

@@ -1,33 +0,0 @@
-#!/usr/bin/env node
-import commandLineCommands from 'command-line-commands';
-import { printErrorWithUsage, printError, printMainUsage } from './print.js';
-import { CommandName, asCommandName, commandFor } from './command.js';
-class Cli {
-    parse() {
-        try {
-            const { command, argv } = commandLineCommands([null, ...Object.values(CommandName)]);
-            if (!command) {
-                printMainUsage();
-                process.exit(0);
-            }
-            const ctor = commandFor(asCommandName(command));
-            return new ctor(argv);
-        }
-        catch (e) {
-            printErrorWithUsage(e);
-            process.exit(1);
-        }
-    }
-}
-async function main() {
-    const cli = new Cli();
-    const command = cli.parse();
-    try {
-        await command.run();
-    }
-    catch (e) {
-        printError(e);
-        process.exit(1);
-    }
-}
-main();

package/dist/print.js

@@ -1,69 +0,0 @@
-import commandLineUsage from 'command-line-usage';
-import chalk from 'chalk';
-import { commandFor, summaries } from './command.js';
-function pink(text) {
-    return chalk.bold.hex('#e75480')(text);
-}
-function blue(text) {
-    return chalk.bold.cyanBright(text);
-}
-function yellow(text) {
-    return chalk.bold.yellowBright(text);
-}
-function green(text) {
-    return chalk.bold.greenBright(text);
-}
-function commandUsage(name, command) {
-    const sections = [
-        {
-            content: `${pink('Neon:')} ${name} - ${command.summary()}`,
-            raw: true
-        },
-        {
-            header: blue('Usage:'),
-            content: `${blue('$')} ${command.syntax()}`
-        },
-        {
-            header: yellow('Options:'),
-            content: command.options()
-        }
-    ];
-    const seeAlso = command.seeAlso();
-    if (seeAlso) {
-        sections.push({ header: green('See Also:'), content: seeAlso });
-    }
-    return commandLineUsage(sections).trimStart();
-}
-function mainUsage() {
-    const sections = [
-        {
-            content: `${pink('Neon:')} the npm packaging tool for Rust addons`,
-            raw: true
-        },
-        {
-            header: blue('Usage:'),
-            content: `${blue('$')} neon <command> <options>`
-        },
-        {
-            header: yellow('Commands:'),
-            content: summaries()
-        }
-    ];
-    return commandLineUsage(sections).trim();
-}
-export function printCommandUsage(name) {
-    console.error(commandUsage(name, commandFor(name)));
-}
-export function printMainUsage() {
-    console.error(mainUsage());
-    console.error();
-    console.error("See 'neon help <command>' for more information on a specific command.");
-}
-export function printErrorWithUsage(e) {
-    console.error(mainUsage());
-    console.error();
-    printError(e);
-}
-export function printError(e) {
-    console.error(chalk.bold.red("error:") + " " + ((e instanceof Error) ? e.message : String(e)));
-}

package/types/cargo.d.ts

@@ -1,43 +0,0 @@
-export type MessageReason = 'compiler-artifact' | 'compiler-message' | 'build-script-executed' | 'build-finished';
-export type CompilerMessage = {
-    reason: 'compiler-message';
-};
-export type BuildScriptExecuted = {
-    reason: 'build-script-executed';
-};
-export type CompilerTarget = {
-    kind: string[];
-    crate_types: string[];
-    name: string;
-};
-export type CompilerArtifact = {
-    reason: 'compiler-artifact';
-    package_id: string;
-    manifest_path: string;
-    target: CompilerTarget;
-    filenames: string[];
-};
-export type BuildFinished = {
-    reason: 'build-finished';
-    success: boolean;
-};
-export type CargoMessage = CompilerMessage | BuildScriptExecuted | CompilerArtifact | BuildFinished;
-export declare function messageReason(message: CargoMessage): MessageReason;
-export declare function isCompilerMessage(json: unknown): json is CompilerMessage;
-export declare function isBuildScriptExecuted(json: unknown): json is BuildScriptExecuted;
-export declare function isCompilerTarget(json: unknown): json is CompilerTarget;
-export declare function isCompilerArtifact(json: unknown): json is CompilerArtifact;
-export declare function isBuildFinished(json: unknown): json is BuildFinished;
-export declare function parseMessage(line: string): CargoMessage | null;
-export type MessageFilter<T> = (msg: CargoMessage) => T | null;
-export declare class MessageStream {
-    private _stream;
-    constructor(file?: string | null);
-    findPath(pred: MessageFilter<string>): Promise<string | null>;
-}
-export declare class UnmountMessageStream extends MessageStream {
-    private _mount;
-    private _manifestPath;
-    constructor(mount: string, manifestPath: string | null, file?: string | null);
-    findPath(pred: MessageFilter<string>): Promise<string | null>;
-}

package/types/command.d.ts

@@ -1,24 +0,0 @@
-export interface Command {
-    run(): Promise<void>;
-}
-export interface CommandStatics {
-    summary(): string;
-    syntax(): string;
-    options(): CommandDetail[];
-    seeAlso(): CommandDetail[] | void;
-}
-export type CommandClass = (new (argv: string[]) => Command) & CommandStatics;
-export type CommandDetail = {
-    name: string;
-    summary: string;
-};
-export declare enum CommandName {
-    Help = "help",
-    Dist = "dist",
-    PackBuild = "pack-build",
-    InstallBuilds = "install-builds"
-}
-export declare function isCommandName(s: string): s is CommandName;
-export declare function asCommandName(name: string): CommandName;
-export declare function commandFor(name: CommandName): CommandClass;
-export declare function summaries(): CommandDetail[];

package/types/commands/cross-dist.d.ts

@@ -1,14 +0,0 @@
-import { Command, CommandDetail } from '../command.js';
-export default class CrossDist implements Command {
-    static summary(): string;
-    static syntax(): string;
-    static options(): CommandDetail[];
-    static seeAlso(): CommandDetail[] | void;
-    private _file;
-    private _log;
-    private _crateName;
-    private _dir;
-    private _out;
-    constructor(argv: string[]);
-    run(): Promise<void>;
-}

package/types/commands/cross-install.d.ts

@@ -1,10 +0,0 @@
-import { Command, CommandDetail } from '../command.js';
-export default class CrossInstall implements Command {
-    static summary(): string;
-    static syntax(): string;
-    static options(): CommandDetail[];
-    static seeAlso(): CommandDetail[] | void;
-    private _bundle;
-    constructor(argv: string[]);
-    run(): Promise<void>;
-}

package/types/commands/cross-pack.d.ts

@@ -1,12 +0,0 @@
-import { Command, CommandDetail } from '../command.js';
-export default class CrossPack implements Command {
-    static summary(): string;
-    static syntax(): string;
-    static options(): CommandDetail[];
-    static seeAlso(): CommandDetail[] | void;
-    private _target;
-    private _addon;
-    private _outDir;
-    constructor(argv: string[]);
-    run(): Promise<void>;
-}

package/types/commands/dist.d.ts

@@ -1,16 +0,0 @@
-import { Command, CommandDetail } from '../command.js';
-export default class Dist implements Command {
-    static summary(): string;
-    static syntax(): string;
-    static options(): CommandDetail[];
-    static seeAlso(): CommandDetail[] | void;
-    private _log;
-    private _file;
-    private _mount;
-    private _manifestPath;
-    private _crateName;
-    private _out;
-    constructor(argv: string[]);
-    findArtifact(): Promise<string | null>;
-    run(): Promise<void>;
-}

package/types/commands/help.d.ts

@@ -1,10 +0,0 @@
-import { Command, CommandDetail } from '../command.js';
-export default class Help implements Command {
-    static summary(): string;
-    static syntax(): string;
-    static options(): CommandDetail[];
-    static seeAlso(): CommandDetail[] | void;
-    private _name?;
-    constructor(argv: string[]);
-    run(): Promise<void>;
-}

package/types/commands/install-builds.d.ts

@@ -1,10 +0,0 @@
-import { Command, CommandDetail } from '../command.js';
-export default class InstallBuilds implements Command {
-    static summary(): string;
-    static syntax(): string;
-    static options(): CommandDetail[];
-    static seeAlso(): CommandDetail[] | void;
-    private _bundle;
-    constructor(argv: string[]);
-    run(): Promise<void>;
-}

package/types/commands/pack-build.d.ts

@@ -1,13 +0,0 @@
-import { Command, CommandDetail } from '../command.js';
-export default class PackBuild implements Command {
-    static summary(): string;
-    static syntax(): string;
-    static options(): CommandDetail[];
-    static seeAlso(): CommandDetail[] | void;
-    private _target;
-    private _addon;
-    private _outDir;
-    constructor(argv: string[]);
-    currentTarget(): Promise<string>;
-    run(): Promise<void>;
-}

package/types/index.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/types/print.d.ts

@@ -1,5 +0,0 @@
-import { CommandName } from './command.js';
-export declare function printCommandUsage(name: CommandName): void;
-export declare function printMainUsage(): void;
-export declare function printErrorWithUsage(e: any): void;
-export declare function printError(e: any): void;

package/types/usage.d.ts

@@ -1,2 +0,0 @@
-import type { CommandName } from './index.js';
-export declare function printUsage(command?: CommandName): void;