feat(cli): add introspect command for index facets and searchable attributes

jest.config.js

@@ -24,6 +24,7 @@ const config = {
     '<rootDir>/packages/react-instantsearch-nextjs/__tests__',
     '/__utils__/',
     algoliaSearchMajor !== '5' && '<rootDir>/packages/algolia-experiences',
+    algoliaSearchMajor !== '5' && '<rootDir>/packages/instantsearch-cli',
   ].filter((x) => x !== false),
   watchPathIgnorePatterns: [
     '<rootDir>/packages/*/cjs',

packages/instantsearch-cli/__tests__/__utils__/helpers.ts

@@ -13,3 +13,26 @@ export async function runCapturing(
 
   return { exitCode, stdout: stdout.join(''), stderr: stderr.join('') };
 }
+
+type CapturedIO = {
+  stdout: string[];
+  stderr: string[];
+  io: { stdout: (chunk: string) => void; stderr: (chunk: string) => void };
+};
+
+export function captureIO(): CapturedIO {
+  const stdout: string[] = [];
+  const stderr: string[] = [];
+  return {
+    stdout,
+    stderr,
+    io: {
+      stdout: (chunk: string) => stdout.push(chunk),
+      stderr: (chunk: string) => stderr.push(chunk),
+    },
+  };
+}
+
+export function readEnvelope(stdout: string[]): Record<string, unknown> {
+  return JSON.parse(stdout.join(''));
+}

packages/instantsearch-cli/__tests__/global-options.test.ts

@@ -9,7 +9,7 @@ describe('global options', () => {
   describe('--json implies --yes', () => {
     it('sets yes=true when --json is passed', async () => {
       const program = createProgram(silentIO);
-      await program.parseAsync(['init', '--json'], { from: 'user' });
+      await program.parseAsync(['add', '--json'], { from: 'user' });
 
       expect(program.opts()).toMatchObject({ json: true, yes: true });
     });
@@ -18,14 +18,14 @@ describe('global options', () => {
   describe('--yes', () => {
     it('is a standalone global flag (yes=true, json=false)', async () => {
       const program = createProgram(silentIO);
-      await program.parseAsync(['init', '--yes'], { from: 'user' });
+      await program.parseAsync(['add', '--yes'], { from: 'user' });
 
       expect(program.opts()).toMatchObject({ json: false, yes: true });
     });
 
     it('defaults to false when neither --yes nor --json is passed', async () => {
       const program = createProgram(silentIO);
-      await program.parseAsync(['init'], { from: 'user' });
+      await program.parseAsync(['add'], { from: 'user' });
 
       expect(program.opts()).toMatchObject({ json: false, yes: false });
     });

packages/instantsearch-cli/__tests__/human-output.test.ts

@@ -1,15 +1,12 @@
 import { runCapturing } from './__utils__/helpers';
 
-describe.each(['init', 'add', 'introspect'])(
-  '%s (no --json)',
-  (command) => {
-    it('emits human-readable output, not a JSON envelope', async () => {
-      const { exitCode, stdout, stderr } = await runCapturing([command]);
+describe('add (no --json)', () => {
+  it('emits human-readable output, not a JSON envelope', async () => {
+    const { exitCode, stdout, stderr } = await runCapturing(['add']);
 
-      expect(exitCode).toBe(0);
-      expect(stderr).toBe('');
-      expect(stdout).toContain(command);
-      expect(stdout.trimStart().startsWith('{')).toBe(false);
-    });
-  }
-);
+    expect(exitCode).toBe(0);
+    expect(stderr).toBe('');
+    expect(stdout).toContain('add');
+    expect(stdout.trimStart().startsWith('{')).toBe(false);
+  });
+});

packages/instantsearch-cli/__tests__/init-exit-code.test.ts

@@ -0,0 +1,47 @@
+import path from 'path';
+
+import { runCapturing } from './__utils__/helpers';
+
+const FIXTURES_ROOT = path.join(__dirname, 'fixtures', 'detector');
+
+describe('init exit code', () => {
+  it('returns a non-zero process exit code when runInit fails', async () => {
+    const originalCwd = process.cwd();
+    process.chdir(path.join(FIXTURES_ROOT, 'vanilla'));
+    try {
+      const { exitCode } = await runCapturing([
+        'init',
+        '--json',
+        '--app-id',
+        'X',
+        '--search-api-key',
+        'Y',
+      ]);
+
+      expect(exitCode).not.toBe(0);
+    } finally {
+      process.chdir(originalCwd);
+    }
+  });
+
+  it('surfaces the human-mode failure message on stderr', async () => {
+    const originalCwd = process.cwd();
+    process.chdir(path.join(FIXTURES_ROOT, 'vanilla'));
+    try {
+      const { exitCode, stdout, stderr } = await runCapturing([
+        'init',
+        '--yes',
+        '--app-id',
+        'X',
+        '--search-api-key',
+        'Y',
+      ]);
+
+      expect(exitCode).not.toBe(0);
+      expect(stdout).toBe('');
+      expect(stderr).toMatch(/react/i);
+    } finally {
+      process.chdir(originalCwd);
+    }
+  });
+});