feat(scripts): move helpers to snippet files for algolia doc #3197
Conversation
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
a4dd3e5 to
0996a50
Compare
| }; | ||
|
|
||
| export const waitForTask = { | ||
| csharp: `await client.WaitForTaskAsync("<<indexName>>", response.TaskID);`, |
There was a problem hiding this comment.
I've used this format for templating for now but it will most likely evolve from @kai687 's PoC
There was a problem hiding this comment.
maybe we can use the same format as for our CTS, we use ${{localhost}} for example
There was a problem hiding this comment.
It will change for sure later anyway so... I guess we don't really mind for now
scripts/specs/snippets.ts
Outdated
| if (!('waitForAppTask' in snippetSamples[language])) { | ||
| snippetSamples[language].waitForAppTask = { | ||
| default: waitForAppTask[language], | ||
| }; | ||
| } | ||
|
|
||
| if (!('waitForApiKey' in snippetSamples[language])) { | ||
| snippetSamples[language].waitForApiKey = { | ||
| default: waitForApiKey[language], | ||
| }; | ||
| } | ||
|
|
||
| if (!('waitForTask' in snippetSamples[language])) { | ||
| snippetSamples[language].waitForTask = { | ||
| default: waitForTask[language], | ||
| }; | ||
| } |
There was a problem hiding this comment.
this is actually the only bits that changed, lmk if you want 2 PRs instead for the file move
scripts/specs/snippets.ts
Outdated
| import fsp from 'fs/promises'; | ||
|
|
||
| import { GENERATORS, capitalize, createClientName, toAbsolutePath } from '../common.js'; | ||
| import type { CodeSamples, Language, SnippetForMethod, SnippetSamples } from '../types.js'; |
There was a problem hiding this comment.
can you move some of those types to the new types.ts file pls ?
| }; | ||
|
|
||
| export const waitForTask = { | ||
| csharp: `await client.WaitForTaskAsync("<<indexName>>", response.TaskID);`, |
There was a problem hiding this comment.
maybe we can use the same format as for our CTS, we use ${{localhost}} for example
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-2458
Changes included:
duplicates the snippets for our netlify doc to the JSON of the initial snippet, with a template pattern, this allows us to ship a single file to the documentation, which doesn't use JS anyway so it's better if we let them do the templating/variable replace directly
also move the specs logic to its own folder, the file was pretty complicate to navigate in