Improve type safety in leaf node utility modules#7910
Draft
Conversation
Improved type safety in several "leaf node" utility modules by: - Defining proper interfaces for data structures. - Using type predicates and type guards to eliminate `@ts-expect-error` and `@ts-ignore`. - Replacing `any` and `$TSFixMe` with specific types or `Awaited<ReturnType<...>>` where appropriate. - Updating unit tests to match new type signatures. Modules improved: - `src/utils/dot-env.ts` - `src/utils/deploy/hash-config.ts` - `src/utils/deploy/util.ts` - `src/utils/deploy/upload-files.ts` - `src/utils/dev.ts` (partial) - `src/utils/types.ts` (partial) Co-authored-by: serhalp <1377702+serhalp@users.noreply.github.com>
Contributor
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Improved type safety in several "leaf node" utility modules by: - Defining proper interfaces for data structures. - Using type predicates and type guards to eliminate `@ts-expect-error` and `@ts-ignore`. - Replacing `any` and `$TSFixMe` with specific types or `Awaited<ReturnType<...>>` where appropriate. - Updating unit tests to match new type signatures. - Adhering to lint rules by avoiding restricted properties like `process.cwd()` and unnecessary conditionals. Modules improved: - `src/utils/dot-env.ts` - `src/utils/deploy/hash-config.ts` - `src/utils/deploy/util.ts` - `src/utils/deploy/upload-files.ts` - `src/utils/dev.ts` - `src/utils/types.ts` - `tests/unit/utils/deploy/upload-files.test.ts` Co-authored-by: serhalp <1377702+serhalp@users.noreply.github.com>
This commit enhances type safety in several "leaf node" modules within the `src/utils` directory, removing numerous `@ts-expect-error`, `@ts-ignore`, and `any` types. Key changes: - Refactored `src/utils/dot-env.ts` with a `DotEnvResult` interface and type-safe filters. - Improved `src/utils/deploy/hash-config.ts` by strictly typing configuration objects. - Enhanced `src/utils/deploy/util.ts` and `src/utils/deploy/upload-files.ts` with robust interfaces and type guards for API responses and upload logic. - Strengthened `src/utils/dev.ts` environment variable handling, fixing a latent precedence bug where `.env` files could incorrectly overwrite protected internal or UI-sourced variables. - Resolved a lint error in `src/utils/shell.ts` by replacing a suppressive directive with a proper type guard. - Updated relevant unit tests to align with improved type signatures. - Fixed a mutation bug in `dot-env.ts` where reversing the default environment files array would affect global state. These improvements align with principal engineer standards, favoring structural type safety over temporary workarounds. Co-authored-by: serhalp <1377702+serhalp@users.noreply.github.com>
This commit enhances type safety across several utility modules in the `src/utils` directory. It replaces numerous `any` types and `@ts-expect-error` directives with robust interfaces, type predicates, and proper type guards. Key improvements: - Refactored `src/utils/dot-env.ts` with a `DotEnvResult` interface and type-safe filters. - Improved `src/utils/deploy/hash-config.ts` by strictly typing configuration objects. - Enhanced `src/utils/deploy/util.ts` and `src/utils/deploy/upload-files.ts` with robust interfaces and type guards for API responses and upload logic. - Fixed a latent precedence bug in `src/utils/dev.ts` environment variable handling. - Resolved lint errors by replacing suppressive directives with proper type guards and wrapping async signal handlers. - Updated unit tests to align with improved type signatures. These changes follow principal engineer standards by providing structural type safety and runtime resilience. Co-authored-by: serhalp <1377702+serhalp@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This refactor improves the type safety of several utility modules in the
@netlify/cliproject. It removes multiple@ts-expect-errorand@ts-ignorecomments and replaces manyanytypes with more robust TypeScript patterns, such as type predicates,Pick<NetlifyAPI, ...>, and extracted return types. This makes the codebase more maintainable and helps prevent future regressions.PR created automatically by Jules for task 16410968246675207541 started by @serhalp