[FIX]:285 - Type proccess.env based off the available secrets in a no… #333
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
|
fixes #285 @nichochar @benjreinhart I'd like to know your feedback on this approach and whether we can go ahead with this or not. Type error on hover: 
Error in console: Suggestions: 
|
packages/api/srcbook/index.mts
Outdated
| if (!Object.entries(sessionSecrets).length) return; | ||
| const envTypeDeclarationFileContent = generateEnvTypesFile(sessionSecrets); | ||
| const srcbookDir = pathToSrcbook(sessionId); | ||
| const envDtsPath = Path.join(srcbookDir, 'src', 'env.d.ts'); |
There was a problem hiding this comment.
Nit but i would put this in the repo root. I think that's where I've typically seen these global envs.
| @@ -0,0 +1,16 @@ | |||
| // vite.config.ts | |||
There was a problem hiding this comment.
This file doesn't look like it should be checked in. Can we remove.
* Add support for deleting and renaming files * Fix lint
* inital homepage rework, sections, card style, srcbook to notebook * fix lil linter error * move user facing Srcbook (in ref to notebook) to Notebook * style up to match figma
…tdout from vite to get port (srcbookdev#349) * feat: add logic to represent booting state within preview panel and parse stdout from vite to get port * fix: run npm run format
* Add folder delete and rename behavior * Remove unused files state * Fix lint warnings
benjreinhart
approved these changes
Oct 13, 2024
|
Neat, thanks @BeRecursive22 ! |
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.
…tebook
Dynamic Environment Type Declarations for Srcbooks
Approach
Initial Creation:
When creating a new srcbook, an empty environment type declaration file (env.d.ts) is generated under /src.
This file initially assumes all environment secrets are disabled.
Dynamic Updates:
Upon user actions (Add/Enable/Disable/Delete secrets), the system:
a. Retrieves the updated secrets available for the srcbook.
b. Dynamically generates a new env.d.ts file.
c. Writes the updated file to disk under the /src directory.
Type Safety:
All available environment secrets for a srcbook are typed in the ProcessEnv interface.
This enables TSServer to throw type errors when a user attempts to access non-existent environment secrets.
Limitations
This feature is not retroactively applicable to srcbooks created prior to this feature release.
Some assumptions: