Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
feat(shell-api): Generate shell-api metadata from source #784
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
 1¤7 not commit generated file
…in metadata and show useful error
…pescript more than needed
 1¤7 node versions happy
addaleax
reviewed
Apr 16, 2021
| ); | ||
|
|
||
| const metadata = await generateMetadata(files, config); | ||
|
|
||
| await fs.writeFile( | ||
| await promisify(fs.writeFile)( |
There was a problem hiding this comment.
Just curious, we use fs.promises a lot in mongosh, and the only release lines without fs.promises but with promisify are 8.x & 9.x, which have been EOL for a while, what’s the situation where we can’t use fs.promises?
There was a problem hiding this comment.
Ohhh, yeah, you're totally right, we use it a lot and it doesn't fail. I refactored from failing fs/promises import that was added only in 14 directly to using promisify, totally skipped my mind that fs.promises was added before fs/promises. I'll change it to fs.promises as it's definitely a better option here
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.
Here's my🦨 exploration. This PR adds a script that generates metadata from shell-api collecting type info and documentation of all exposed classes and class members in one place. For the PoC I added only very basic error validation for shell method calls to have some kind of example of how we can use it:
I think if we decide to keep it, we can polish error messages and also move
helplogic to be based on this metadata which can provide a better visual based on shell environment. Also VSCode can consume it instead of i18n data for better intellisense suggestions (e.g., deprecated data is available in the metadata)I excluded the metadata from source as it's a generated file, so if you want to see how the file looks you'll need to pull the branch and run
npm run metadatainshell-apipackage