fix: updates to typescript w/n the env command #6905
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
Co-authored-by: Thomas Lane <[email protected]> Co-authored-by: Thomas Lane <[email protected]>
Co-authored-by: Thomas Lane <[email protected]> Co-authored-by: Thomas Lane <[email protected]>
Co-authored-by: Thomas Lane <[email protected]>
Co-authored-by: Thomas Lane <[email protected]> Co-authored-by: Thomas Lane <[email protected]>
Co-authored-by: Thomas Lane <[email protected]>
Co-authored-by: Thomas Lane <[email protected]>
Co-authored-by: Will <[email protected]>
Co-authored-by: Thomas Lane <[email protected]>
Co-authored-by: Thomas Lane <[email protected]>
Co-authored-by: Thomas Lane <[email protected]> Co-authored-by: Thomas Lane <[email protected]>
Co-authored-by: Will <[email protected]>
Co-authored-by: Will <[email protected]>
|
@DanielSLew Will you review this when you have a moment? |
DanielSLew
requested changes
Nov 1, 2024
src/commands/api-types.d.ts
Outdated
| body: EnvVar | ||
| } | ||
|
|
||
| interface createEnvVarParams { |
There was a problem hiding this comment.
Suggested change
| interface createEnvVarParams { | |
| interface CreateEnvVarParams { |
| [key: string]: Record<string, unknown>; | ||
| } | ||
|
|
||
| // Processing Settings Interface |
There was a problem hiding this comment.
You don't need all these comments, they're all basically just saying the name of the interfaces are
src/commands/env/env-set.ts
Outdated
| scopes = scopes.filter((sco) => !/post[-_]processing/.test(sco)) | ||
| } | ||
|
|
||
| // if the passed context is unknown, it is actually a branch name | ||
| // @ts-expect-error TS(7006) FIXME: Parameter 'ctx' implicitly has an 'any' type. | ||
| let values = contexts.map((ctx) => | ||
| let values: Value[] = contexts.map((ctx) => |
There was a problem hiding this comment.
What is the Value type supposed to be? Can we give it a more descriptive name
src/utils/env/index.ts
Outdated
| export const AVAILABLE_SCOPES = ['builds', 'functions', 'runtime', 'post_processing'] | ||
| import { GetEnvelopeEnvParams, ProcessedEnvVars } from './types.js' | ||
|
|
||
| export const AVAILABLE_CONTEXTS: Context[] = ['all', 'production', 'deploy-preview', 'branch-deploy', 'dev'] |
There was a problem hiding this comment.
Can we change that to DeployContext, context on its own is too vague
Suggested change
| export const AVAILABLE_CONTEXTS: Context[] = ['all', 'production', 'deploy-preview', 'branch-deploy', 'dev'] | |
| export const AVAILABLE_CONTEXTS: DeployContext[] = ['all', 'production', 'deploy-preview', 'branch-deploy', 'dev'] |
Co-authored-by: Will <[email protected]>
|
Suggested changes were made w/ @wconrad265! |
DanielSLew
reviewed
Nov 6, 2024
| @@ -26,7 +27,7 @@ export const envGet = async (name: string, options: OptionValues, command: BaseC | |||
| } | |||
|
|
|||
| if (!value) { | |||
| const contextType = AVAILABLE_CONTEXTS.includes(context) ? 'context' : 'branch' | |||
| const contextType = context === undefined ? 'branch' : AVAILABLE_CONTEXTS.includes(context) | |||
There was a problem hiding this comment.
Why was this changed? It now returns a boolean instead of a string
Comment on lines
+37
to
+39
| if (isAPIEnvError(error)) { | ||
| throw error.json ? error.json.msg : error | ||
| } |
There was a problem hiding this comment.
if we're doing this we should add an else to throw. Otherwise we're swallowing the error if it if (isAPIEnvError(error)) returns false
There was a problem hiding this comment.
or could we do something like this?
Suggested change
| if (isAPIEnvError(error)) { | |
| throw error.json ? error.json.msg : error | |
| } | |
| throw (error as APIError).json ? (error as APIError).json.msg : error |
Comment on lines
+63
to
+65
| if (error && typeof error === 'object' && 'message' in error && typeof error.message === 'string') { | ||
| log(error.message) | ||
| } |
There was a problem hiding this comment.
Same thing here, we could just do
Suggested change
| if (error && typeof error === 'object' && 'message' in error && typeof error.message === 'string') { | |
| log(error.message) | |
| } | |
| log((error as APIError).message) |
Comment on lines
+96
to
+97
| const errortoThrow = isAPIEnvError(error_) ? error_.json.msg : error_ | ||
| throw errortoThrow |
There was a problem hiding this comment.
Yeah this is what I was mentioning above, to do it this way
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.
🎉 Thanks for submitting a pull request! 🎉
Summary
Fixes #Typescript in Env Command
Fixes all
$TSFixMeand@ts-ignorewithin Env command directory. Added additional types for functions and API methods associated with env command.Thanks for the help @wconrad265!
For us to review and ship your PR efficiently, please perform the following steps:
passes our tests.
A picture of a cute animal (not mandatory, but encouraged)