@hydranium/cli 1.0.0-next.31 → 1.0.0-next.312

package/src/commands/init-args.ts

@@ -137,8 +137,8 @@ export function parseInitArgs(args: string[], onError: UsageError = exitWithUsag
             scoped().diagram = true;
             break;
          case '--heads': {
-            // Validated in `resolveInitComposition`, which owns the rule that
-            // `lsp` is mandatory; the cast only gets the strings that far.
+            // Validated in `resolveInitComposition`; the cast only gets the
+            // strings that far.
             heads = next().split(',') as InitHead[];
             break;
          }
@@ -185,41 +185,46 @@ export const INIT_HELP: readonly string[] = [
    '                            ( --grammar <Name> [--extensions <list>]',
    '                                              [--language-id <id>] [--diagram] )...',
    '',
-   'Scaffold a new Hydranium language project end-to-end: a starter grammar per',
-   '--grammar, the `create<Name>Services` DI wiring, an LSP + data-server launch,',
-   'langium-config, package.json, and build scripts. Does NOT run `npm install` or',
-   '`langium generate` — those are printed as next steps. Refuses a non-empty',
-   'directory without --force.',
+   'Scaffold a new Hydranium language project end-to-end: two packages and a',
+   'starter workspace, each in its own directory. server/ holds a starter grammar',
+   'per --grammar, the `create<Name>Services` DI wiring, a launch of every head',
+   'and build scripts; protocol/ holds what the server and its clients both',
+   'import; workspace/ holds two starter model files per grammar. A standalone',
+   'project also gets a root manifest naming the two packages as npm workspaces.',
+   'Does NOT run `npm install` or `langium generate` — those are printed as next',
+   'steps. Refuses a non-empty directory without --force.',
    '',
    'Run it with no --name on a terminal to be prompted instead. The wizard echoes',
    'the command it composed before running it, so every answer is reproducible as',
    'flags. Without a terminal a missing --name stays an error, so CI never hangs.',
    '',
    'Project options (position-free):',
-   '  <target-dir>          Directory to scaffold into (required).',
+   '  <target-dir>          The project directory to scaffold into (required).',
    '  --name <Name>         PascalCase PROJECT name; drives the services and the',
    '                        Langium projectName, i.e. the shared generated symbols',
    '                        (<Name>AstReflection, <Name>GeneratedSharedModule) (required).',
-   '  --heads <list>        Comma-separated protocol heads: lsp, data, glsp.',
-   '                        `lsp` is mandatory — it owns the workspace, the build',
-   '                        pipeline and the shared tier the others read through.',
-   '                        The emitted dependencies, main.ts and module bindings',
-   '                        all follow this set. Default: lsp,data.',
+   '  --heads <list>        Comma-separated protocol heads: lsp, data, glsp, any',
+   '                        non-empty set. Without lsp, main.ts serves the socket',
+   '                        heads from a workspace path it is given and prints',
+   '                        their ports. The emitted dependencies, main.ts and',
+   '                        module bindings all follow this set. Default: lsp,data.',
    '  --force               Scaffold into a non-empty directory anyway.',
-   '  --monorepo            Scaffold a member of the surrounding npm workspace:',
-   '                        tsconfig extends the root config that actually carries',
-   '                        compilerOptions, .gitignore is left to the root, and the',
-   '                        scripts address the package by --prefix. Errors when no',
-   '                        ancestor declares `workspaces`. Never writes outside the',
-   '                        target — the root `workspaces` entry is printed, not added.',
-   '  --scope <@scope>      npm scope for the package name, e.g. @acme. Not inferred:',
+   '  --monorepo            Scaffold the packages as members of the surrounding npm',
+   '                        workspace, with no root of their own: each tsconfig',
+   '                        extends the root config that actually carries',
+   '                        compilerOptions, and the scripts address the server by',
+   '                        --prefix. Errors when no ancestor declares `workspaces`.',
+   '                        Never writes outside the target — the root `workspaces`',
+   '                        entries and dependency pins are printed, not added.',
+   '  --scope <@scope>      npm scope for the package names, e.g. @acme. Not inferred:',
    '                        a root manifest is usually named for the repo, not the',
    '                        scope. The wizard offers the siblings’ scope as a default.',
-   '  --public              Omit "private": true, so the package can be published.',
-   '                        The scaffold emits it by default, because the manifest',
-   '                        it also emits declares license "UNLICENSED": a package',
-   '                        granting no rights on a public registry contradicts',
-   '                        itself. Pass this once the project has picked a licence.',
+   '  --public              Omit "private": true from the server and protocol',
+   '                        packages, so they can be published together. The',
+   '                        scaffold emits it by default, because the manifests',
+   '                        also declare license "UNLICENSED": a package granting',
+   '                        no rights on a public registry contradicts itself. Pass',
+   '                        this once the project has picked a licence.',
    '',
    'Grammar options — each applies to the PRECEDING --grammar:',
    '  --grammar <Name>      PascalCase GRAMMAR name; drives the `grammar X` declaration',
@@ -233,8 +238,8 @@ export const INIT_HELP: readonly string[] = [
    '                        (default: <project-id>-<grammar-id>).',
    '  --diagram             Scaffold a GLSP diagram for that grammar. Requires',
    '                        `glsp` in --heads. Derived when there is exactly one',
-   '                        grammar; required when there are several, because a',
-   '                        diagram type binds exactly one grammar.',
+   '                        grammar; required when there are several, because the',
+   '                        scaffolded diagram is typed over one grammar’s model.',
    '',
    'Example — three grammars, one with a differing extension, three heads:',
    '  hydranium-cli init ./order-flow --name OrderFlow --heads lsp,data,glsp \\',

package/src/commands/init-prompt.ts

@@ -66,7 +66,7 @@ export interface PromptPort {
       readonly choices: ReadonlyArray<PromptChoice<Value>>;
       readonly initialValue?: Value;
    }) => Promise<Value>;
-   /** Ask for any number of several choices, including none. */
+   /** Ask for at least one of several choices. */
    readonly multiselect: <Value extends string>(options: {
       readonly message: string;
       readonly choices: ReadonlyArray<PromptChoice<Value>>;
@@ -78,8 +78,9 @@ export interface PromptPort {
    readonly outro: (message: string) => void;
 }
 
-/** The optional heads, as a checkbox list. `lsp` is not offered — see `askHeads`. */
-export const OPTIONAL_HEAD_CHOICES: ReadonlyArray<PromptChoice<Exclude<InitHead, 'lsp'>>> = [
+/** The heads, as a checkbox list. */
+export const HEAD_CHOICES: ReadonlyArray<PromptChoice<InitHead>> = [
+   { value: 'lsp', label: 'lsp', hint: 'text editing in an LSP client' },
    { value: 'data', label: 'data', hint: 'typed JSON-RPC for forms, trees and code-gen' },
    { value: 'glsp', label: 'glsp', hint: 'graphical editing; adds a scaffolded diagram' }
 ];
@@ -138,9 +139,7 @@ export async function createClackPrompt(): Promise<PromptPort> {
                message: options.message,
                options: toOptions(options.choices),
                initialValues: options.initialValues ? [...options.initialValues] : [],
-               // Legal and meaningful: an `lsp`-only project is a plain LSP
-               // server, so an empty selection must not be rejected.
-               required: false
+               required: true
             })
          ),
       confirm: async options => unwrap(await clack.confirm({ message: options.message, initialValue: options.initialValue })),