trying to get generate-doc-examples.js working #2284
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JoshMock
approved these changes
Jun 10, 2024
JoshMock
requested changes
Jun 10, 2024
…icsearch-js into annieh/adding_doc_examples
JoshMock
requested changes
Jun 25, 2024
Comment on lines
+80
to
+81
| "ts-standard": "11.0.0", | ||
| "typescript": "4.6.4", |
There was a problem hiding this comment.
Suggested change
| "ts-standard": "11.0.0", | |
| "typescript": "4.6.4", | |
| "ts-standard": "^11.0.0", | |
| "typescript": "^4.6.4", |
I'd switch back to what was already there just to keep things consistent. Pinning to an exact version is not ideal unless absolutely necessary.
Comment on lines
+143
to
+151
| const { results } = await new Promise((resolve, reject) => { | ||
| tsStandard.lintText(code, { fix: true }, (err, result) => { | ||
| if (err) { | ||
| reject(err) | ||
| } else { | ||
| resolve(result) | ||
| } | ||
| }) | ||
| }) |
There was a problem hiding this comment.
I don't think we need to wrap this explicitly in a Promise. Since you made generateAsciidoc an async function, any errors thrown by lintText will be thrown just like any other exception would be.
Suggested change
| const { results } = await new Promise((resolve, reject) => { | |
| tsStandard.lintText(code, { fix: true }, (err, result) => { | |
| if (err) { | |
| reject(err) | |
| } else { | |
| resolve(result) | |
| } | |
| }) | |
| }) | |
| const { results } = await tsStandard.lintText(code, { fix: true }) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi Hello!
I've been contributing to the Python doc examples in the Elasticsearch-py repo (with Quentin Pradet's help) and am trying to get the doc examples for the other languages available!
Disclaimer: I'm not a JS or TypeScript developer, but wanted to take a whack at getting a code change up.
The alternative_reports.json file that used to live in the client_teams repo looks to have moved to the client-fliight-recorder repo and is now using the parsed_alternative_report.json file to generate the doc examples.
I was able to get this working making a few changes to the generate_doc_examples.js file.
I was unable to get it working used node, but was able to get it running using 'npx tsx' (You may hate this and I'm sorry!)
I was able to get the doc examples generating locally, but didn't want to add them and clutter this initial PR.