@sanity/cli 6.0.0-alpha.4 → 6.0.0-alpha.6

package/dist/commands/docs/__tests__/search.test.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/commands/docs/__tests__/search.test.ts"],"sourcesContent":["import {runCommand} from '@oclif/test'\nimport {isInteractive} from '@sanity/cli-core'\nimport {select} from '@sanity/cli-core/ux'\nimport {testCommand} from '@sanity/cli-test'\nimport nock from 'nock'\nimport {afterEach, describe, expect, test, vi} from 'vitest'\n\nimport {DocsSearchCommand} from '../search.js'\n\nvi.mock('@sanity/cli-core/ux', async () => {\n  const actual = await vi.importActual<typeof import('@sanity/cli-core/ux')>('@sanity/cli-core/ux')\n  return {\n    ...actual,\n    select: vi.fn(),\n  }\n})\n\nvi.mock('../../../../../cli-core/src/util/isInteractive.js', async () => {\n  return {\n    isInteractive: vi.fn(),\n  }\n})\n\nconst mockedSelect = vi.mocked(select)\nconst mockedIsInteractive = vi.mocked(isInteractive)\n\nafterEach(() => {\n  const pending = nock.pendingMocks()\n  nock.cleanAll()\n  expect(pending, 'pending mocks').toEqual([])\n  vi.resetAllMocks()\n})\n\ndescribe('#docs:search', () => {\n  test('--help works', async () => {\n    const {stdout} = await runCommand('docs search --help')\n    expect(stdout).toMatchInlineSnapshot(`\n      \"Search Sanity docs\n\n      USAGE\n        $ sanity docs search QUERY [--limit <value>]\n\n      ARGUMENTS\n        QUERY  Search query for documentation\n\n      FLAGS\n        --limit=<value>  [default: 10] Maximum number of results to return\n\n      DESCRIPTION\n        Search Sanity docs\n\n      EXAMPLES\n        Search for documentation about schemas\n\n          $ sanity docs search schema\n\n        Search with phrase\n\n          $ sanity docs search \"groq functions\"\n\n        Limit search results\n\n          $ sanity docs search \"deployment\" --limit=5\n\n      \"\n    `)\n  })\n\n  test('searches and displays results', async () => {\n    const searchResponse = [\n      {\n        description: 'Learn how to install Sanity Studio',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n      {\n        description: 'Understanding Sanity schemas',\n        path: '/docs/schemas/overview',\n        title: 'Schema Overview',\n      },\n    ]\n\n    nock('https://www.sanity.io')\n      .get('/docs/api/search/semantic')\n      .query({query: 'studio'})\n      .reply(200, searchResponse)\n\n    const {stdout} = await testCommand(DocsSearchCommand, ['studio'])\n\n    expect(stdout).toContain('Searching documentation for: \"studio\"')\n    expect(stdout).toContain('Found 2 result(s):')\n    expect(stdout).toContain('1. Studio Installation Guide')\n    expect(stdout).toContain('URL: https://www.sanity.io/docs/studio/installation')\n    expect(stdout).toContain('Learn how to install Sanity Studio')\n    expect(stdout).toContain('2. Schema Overview')\n  })\n\n  test('handles no results', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/search/semantic')\n      .query({query: 'nonexistent'})\n      .reply(200, [])\n\n    const {stdout} = await testCommand(DocsSearchCommand, ['nonexistent'])\n\n    expect(stdout).toContain('Searching documentation for: \"nonexistent\"')\n    expect(stdout).toContain('No results found. Try a different search term.')\n  })\n\n  test('handles API errors', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/search/semantic')\n      .query({query: 'test'})\n      .reply(500, 'Internal Server Error')\n\n    const {error} = await testCommand(DocsSearchCommand, ['test']).catch((err) => err)\n    expect(error.message).toBe(\n      'The documentation search API is currently unavailable. Please try again later.',\n    )\n    expect(error.oclif?.exit).toBe(1)\n  })\n\n  test('respects limit flag', async () => {\n    const searchResponse = [\n      {\n        description: 'Learn how to install Sanity Studio 1',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n      {\n        description: 'Learn how to install Sanity Studio 2',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n      {\n        description: 'Learn how to install Sanity Studio 3',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n\n      {\n        description: 'Learn how to install Sanity Studio 4',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n      {\n        description: 'Learn how to install Sanity Studio 5',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n      {\n        description: 'Learn how to install Sanity Studio 6',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n    ]\n\n    nock('https://www.sanity.io')\n      .get('/docs/api/search/semantic')\n      .query({query: 'studio'})\n      .reply(200, searchResponse)\n\n    const {stdout} = await testCommand(DocsSearchCommand, ['studio', '--limit=3'])\n\n    expect(stdout).toContain('Found 3 result(s):')\n    expect(stdout).toContain('1. Studio Installation Guide')\n    expect(stdout).toContain('2. Studio Installation Guide')\n    expect(stdout).toContain('3. Studio Installation Guide')\n  })\n\n  test('handles results with empty descriptions', async () => {\n    const searchResponse = [\n      {\n        description: '', // Empty description\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n      {\n        description: '', // Empty description\n        path: '/docs/schemas/overview',\n        title: 'Schema Overview',\n      },\n    ]\n\n    nock('https://www.sanity.io')\n      .get('/docs/api/search/semantic')\n      .query({query: 'studio'})\n      .reply(200, searchResponse)\n\n    const {stdout} = await testCommand(DocsSearchCommand, ['studio'])\n\n    expect(stdout).toContain('Searching documentation for: \"studio\"')\n    expect(stdout).toContain('Found 2 result(s):')\n    expect(stdout).toContain('1. Studio Installation Guide')\n    expect(stdout).toContain('URL: https://www.sanity.io/docs/studio/installation')\n    expect(stdout).toContain('2. Schema Overview')\n    // Should not show empty description lines\n    expect(stdout).not.toContain('Learn how to install')\n    expect(stdout).not.toContain('Understanding Sanity schemas')\n  })\n\n  test('shows usage hints in non-interactive mode', async () => {\n    mockedIsInteractive.mockReturnValue(false)\n\n    const searchResponse = [\n      {\n        description: 'Learn how to install Sanity Studio',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n    ]\n\n    nock('https://www.sanity.io')\n      .get('/docs/api/search/semantic')\n      .query({query: 'studio'})\n      .reply(200, searchResponse)\n\n    const {stdout} = await testCommand(DocsSearchCommand, ['studio'])\n\n    expect(stdout).toContain('Found 1 result(s):')\n    expect(stdout).toContain('Use `sanity docs read <url>` to read an article in terminal.')\n    expect(stdout).toContain('Use `sanity docs read <path>` to follow links found within articles.')\n  })\n\n  test('handles network errors with default message', async () => {\n    nock('https://www.sanity.io')\n      .get('/docs/api/search/semantic')\n      .query({query: 'test'})\n      .reply(500, 'Internal Server Error')\n\n    const {error} = await testCommand(DocsSearchCommand, ['test']).catch((err) => err)\n    expect(error.message).toBe(\n      'The documentation search API is currently unavailable. Please try again later.',\n    )\n    expect(error.oclif?.exit).toBe(1)\n  })\n\n  test('handles interactive mode article selection', async () => {\n    mockedIsInteractive.mockReturnValue(true)\n    mockedSelect.mockResolvedValue(0)\n\n    const searchResponse = [\n      {\n        description: 'Learn how to install Sanity Studio',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n    ]\n\n    nock('https://www.sanity.io')\n      .get('/docs/api/search/semantic')\n      .query({query: 'studio'})\n      .reply(200, searchResponse)\n\n    nock('https://www.sanity.io')\n      .get('/docs/studio/installation.md')\n      .reply(200, '# Studio Installation\\n\\nThis is how you install the studio.')\n\n    const {stdout} = await testCommand(DocsSearchCommand, ['studio'])\n\n    expect(stdout).toContain('Found 1 result(s):')\n    expect(stdout).toContain('---')\n    expect(stdout).toContain('# Studio Installation')\n    expect(stdout).toContain('This is how you install the studio.')\n  })\n\n  test('handles interactive mode exit selection', async () => {\n    mockedIsInteractive.mockReturnValue(true)\n    mockedSelect.mockResolvedValue(-1) // User selects exit option\n\n    const searchResponse = [\n      {\n        description: 'Learn how to install Sanity Studio',\n        path: '/docs/studio/installation',\n        title: 'Studio Installation Guide',\n      },\n    ]\n\n    nock('https://www.sanity.io')\n      .get('/docs/api/search/semantic')\n      .query({query: 'studio'})\n      .reply(200, searchResponse)\n\n    const {stdout} = await testCommand(DocsSearchCommand, ['studio'])\n\n    expect(stdout).toContain('Found 1 result(s):')\n    expect(stdout).not.toContain('---') // Should not show article content\n    expect(stdout).not.toContain('# Studio Installation')\n  })\n})\n"],"names":["runCommand","isInteractive","select","testCommand","nock","afterEach","describe","expect","test","vi","DocsSearchCommand","mock","actual","importActual","fn","mockedSelect","mocked","mockedIsInteractive","pending","pendingMocks","cleanAll","toEqual","resetAllMocks","stdout","toMatchInlineSnapshot","searchResponse","description","path","title","get","query","reply","toContain","error","catch","err","message","toBe","oclif","exit","not","mockReturnValue","mockResolvedValue"],"mappings":"AAAA,SAAQA,UAAU,QAAO,cAAa;AACtC,SAAQC,aAAa,QAAO,mBAAkB;AAC9C,SAAQC,MAAM,QAAO,sBAAqB;AAC1C,SAAQC,WAAW,QAAO,mBAAkB;AAC5C,OAAOC,UAAU,OAAM;AACvB,SAAQC,SAAS,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,EAAEC,EAAE,QAAO,SAAQ;AAE5D,SAAQC,iBAAiB,QAAO,eAAc;AAE9CD,GAAGE,IAAI,CAAC,uBAAuB;IAC7B,MAAMC,SAAS,MAAMH,GAAGI,YAAY,CAAuC;IAC3E,OAAO;QACL,GAAGD,MAAM;QACTV,QAAQO,GAAGK,EAAE;IACf;AACF;AAEAL,GAAGE,IAAI,CAAC,qDAAqD;IAC3D,OAAO;QACLV,eAAeQ,GAAGK,EAAE;IACtB;AACF;AAEA,MAAMC,eAAeN,GAAGO,MAAM,CAACd;AAC/B,MAAMe,sBAAsBR,GAAGO,MAAM,CAACf;AAEtCI,UAAU;IACR,MAAMa,UAAUd,KAAKe,YAAY;IACjCf,KAAKgB,QAAQ;IACbb,OAAOW,SAAS,iBAAiBG,OAAO,CAAC,EAAE;IAC3CZ,GAAGa,aAAa;AAClB;AAEAhB,SAAS,gBAAgB;IACvBE,KAAK,gBAAgB;QACnB,MAAM,EAACe,MAAM,EAAC,GAAG,MAAMvB,WAAW;QAClCO,OAAOgB,QAAQC,qBAAqB,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA6BtC,CAAC;IACH;IAEAhB,KAAK,iCAAiC;QACpC,MAAMiB,iBAAiB;YACrB;gBACEC,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;YACA;gBACEF,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;SACD;QAEDxB,KAAK,yBACFyB,GAAG,CAAC,6BACJC,KAAK,CAAC;YAACA,OAAO;QAAQ,GACtBC,KAAK,CAAC,KAAKN;QAEd,MAAM,EAACF,MAAM,EAAC,GAAG,MAAMpB,YAAYO,mBAAmB;YAAC;SAAS;QAEhEH,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;IAC3B;IAEAxB,KAAK,sBAAsB;QACzBJ,KAAK,yBACFyB,GAAG,CAAC,6BACJC,KAAK,CAAC;YAACA,OAAO;QAAa,GAC3BC,KAAK,CAAC,KAAK,EAAE;QAEhB,MAAM,EAACR,MAAM,EAAC,GAAG,MAAMpB,YAAYO,mBAAmB;YAAC;SAAc;QAErEH,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;IAC3B;IAEAxB,KAAK,sBAAsB;QACzBJ,KAAK,yBACFyB,GAAG,CAAC,6BACJC,KAAK,CAAC;YAACA,OAAO;QAAM,GACpBC,KAAK,CAAC,KAAK;QAEd,MAAM,EAACE,KAAK,EAAC,GAAG,MAAM9B,YAAYO,mBAAmB;YAAC;SAAO,EAAEwB,KAAK,CAAC,CAACC,MAAQA;QAC9E5B,OAAO0B,MAAMG,OAAO,EAAEC,IAAI,CACxB;QAEF9B,OAAO0B,MAAMK,KAAK,EAAEC,MAAMF,IAAI,CAAC;IACjC;IAEA7B,KAAK,uBAAuB;QAC1B,MAAMiB,iBAAiB;YACrB;gBACEC,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;YACA;gBACEF,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;YACA;gBACEF,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;YAEA;gBACEF,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;YACA;gBACEF,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;YACA;gBACEF,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;SACD;QAEDxB,KAAK,yBACFyB,GAAG,CAAC,6BACJC,KAAK,CAAC;YAACA,OAAO;QAAQ,GACtBC,KAAK,CAAC,KAAKN;QAEd,MAAM,EAACF,MAAM,EAAC,GAAG,MAAMpB,YAAYO,mBAAmB;YAAC;YAAU;SAAY;QAE7EH,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;IAC3B;IAEAxB,KAAK,2CAA2C;QAC9C,MAAMiB,iBAAiB;YACrB;gBACEC,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;YACA;gBACEF,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;SACD;QAEDxB,KAAK,yBACFyB,GAAG,CAAC,6BACJC,KAAK,CAAC;YAACA,OAAO;QAAQ,GACtBC,KAAK,CAAC,KAAKN;QAEd,MAAM,EAACF,MAAM,EAAC,GAAG,MAAMpB,YAAYO,mBAAmB;YAAC;SAAS;QAEhEH,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzB,0CAA0C;QAC1CzB,OAAOgB,QAAQiB,GAAG,CAACR,SAAS,CAAC;QAC7BzB,OAAOgB,QAAQiB,GAAG,CAACR,SAAS,CAAC;IAC/B;IAEAxB,KAAK,6CAA6C;QAChDS,oBAAoBwB,eAAe,CAAC;QAEpC,MAAMhB,iBAAiB;YACrB;gBACEC,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;SACD;QAEDxB,KAAK,yBACFyB,GAAG,CAAC,6BACJC,KAAK,CAAC;YAACA,OAAO;QAAQ,GACtBC,KAAK,CAAC,KAAKN;QAEd,MAAM,EAACF,MAAM,EAAC,GAAG,MAAMpB,YAAYO,mBAAmB;YAAC;SAAS;QAEhEH,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;IAC3B;IAEAxB,KAAK,+CAA+C;QAClDJ,KAAK,yBACFyB,GAAG,CAAC,6BACJC,KAAK,CAAC;YAACA,OAAO;QAAM,GACpBC,KAAK,CAAC,KAAK;QAEd,MAAM,EAACE,KAAK,EAAC,GAAG,MAAM9B,YAAYO,mBAAmB;YAAC;SAAO,EAAEwB,KAAK,CAAC,CAACC,MAAQA;QAC9E5B,OAAO0B,MAAMG,OAAO,EAAEC,IAAI,CACxB;QAEF9B,OAAO0B,MAAMK,KAAK,EAAEC,MAAMF,IAAI,CAAC;IACjC;IAEA7B,KAAK,8CAA8C;QACjDS,oBAAoBwB,eAAe,CAAC;QACpC1B,aAAa2B,iBAAiB,CAAC;QAE/B,MAAMjB,iBAAiB;YACrB;gBACEC,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;SACD;QAEDxB,KAAK,yBACFyB,GAAG,CAAC,6BACJC,KAAK,CAAC;YAACA,OAAO;QAAQ,GACtBC,KAAK,CAAC,KAAKN;QAEdrB,KAAK,yBACFyB,GAAG,CAAC,gCACJE,KAAK,CAAC,KAAK;QAEd,MAAM,EAACR,MAAM,EAAC,GAAG,MAAMpB,YAAYO,mBAAmB;YAAC;SAAS;QAEhEH,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQS,SAAS,CAAC;IAC3B;IAEAxB,KAAK,2CAA2C;QAC9CS,oBAAoBwB,eAAe,CAAC;QACpC1B,aAAa2B,iBAAiB,CAAC,CAAC,IAAG,2BAA2B;QAE9D,MAAMjB,iBAAiB;YACrB;gBACEC,aAAa;gBACbC,MAAM;gBACNC,OAAO;YACT;SACD;QAEDxB,KAAK,yBACFyB,GAAG,CAAC,6BACJC,KAAK,CAAC;YAACA,OAAO;QAAQ,GACtBC,KAAK,CAAC,KAAKN;QAEd,MAAM,EAACF,MAAM,EAAC,GAAG,MAAMpB,YAAYO,mBAAmB;YAAC;SAAS;QAEhEH,OAAOgB,QAAQS,SAAS,CAAC;QACzBzB,OAAOgB,QAAQiB,GAAG,CAACR,SAAS,CAAC,QAAO,kCAAkC;QACtEzB,OAAOgB,QAAQiB,GAAG,CAACR,SAAS,CAAC;IAC/B;AACF"}