feat: add a placeholder README file in codegen'd directory
#774
Conversation
kanadgupta
added
enhancement
| Here's some additional info about the generated SDK: | ||
| \`api\` version: ${PACKAGE_VERSION} | ||
| Generated at ${new Date().toISOString()} |
There was a problem hiding this comment.
After #775 is merged in you should be able to grab the createdAt date from the lockfile for this with this code:
storage.getFromLockfile().createdAtThere was a problem hiding this comment.
should be able to pull this in now that createdAt has been added to the lockfile.
| */ | ||
| createREADME() { | ||
| let createdAt = new Date().toISOString(); | ||
| const currentAPI = Storage.getLockfile().apis.find(api => api.identifier === this.identifier); |
There was a problem hiding this comment.
This is duplicating work in the getFromLockfile storage instance method but this whole storage class is really becoming a bit of a pain with its mix of instance and static methods. You don't have a great way of accessing an instance of `storage though here so it's fine.
Maybe the whole storage class should just be refactored to be entirely static. 🤔
There was a problem hiding this comment.
yeah i noticed that getFromLockfile method but wasn't able to get it working without some deeper refactors 😮💨
Maybe the whole storage class should just be refactored to be entirely static. 🤔
into this idea!
kanadgupta
deleted the
kanad/rm-8188-create-readmemd-in-codegend-directory
branch
🧰 Changes
This PR enhances our SDK generation to automatically create placeholder
README.mdfiles in the codegen'd directories.As part of this, I made a few test enhancements so the
UPDATE_FIXTURESenv variable will now create any missing fixtures.🧬 QA & Testing
Does the copy look good? And do tests pass?