Chore: project structure ts port #1302
Merged
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
brandenrodgers
requested review from
camden11,
kemmerle and
joe-yeager
as code owners
kemmerle
reviewed
Dec 12, 2024
lib/projectStructure.ts
Outdated
| function getIsLegacyApp( | ||
| appConfig: PublicAppComponentConfigType | PrivateAppComponentConfigType, | ||
| appPath: string | ||
| ) { |
kemmerle
reviewed
Dec 12, 2024
lib/projectStructure.ts
Outdated
| } | ||
| } | ||
| }); | ||
|
|
||
| return components; | ||
| } | ||
|
|
||
| function getProjectComponentTypes(components) { | ||
| const projectContents = {}; | ||
| export function getProjectComponentTypes(components: Array<Component>) { |
kemmerle
reviewed
Dec 12, 2024
lib/projectStructure.ts
Outdated
| export function getAppCardConfigs( | ||
| appConfig: PublicAppComponentConfigType | PrivateAppComponentConfigType, | ||
| appPath: string | ||
| ) { |
kemmerle
reviewed
Dec 12, 2024
lib/projectStructure.ts
Outdated
| if (CONFIG_FILES[key] === configFile) { | ||
| return key; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| function loadConfigFile(configPath) { | ||
| function loadConfigFile(configPath: string) { |
kemmerle
reviewed
Dec 12, 2024
camden11
reviewed
Dec 13, 2024
lib/projectStructure.ts
Outdated
| import { logError } from './errorHandlers/index'; | ||
|
|
||
| type ComponentTypes = 'private-app' | 'public-app' | 'hubl-theme'; | ||
| type ValueOf<T> = T[keyof T]; |
There was a problem hiding this comment.
We export ValueOf from @hubspot/local-dev-lib/types/Utils so you don't need to redefine it here
lib/projectStructure.ts
Outdated
| function getTypeFromConfigFile(configFile) { | ||
| for (const key in CONFIG_FILES) { | ||
| function getTypeFromConfigFile( | ||
| configFile: ValueOf<typeof CONFIG_FILES> |
There was a problem hiding this comment.
It looks like this just resolves to string. Which... I think is probably fine but we can just type at that way directly. I messed around with adding an as const to CONFIG_FILES to fix this and it caused its own set of problems
lib/projectStructure.ts
Outdated
| import { logger } from '@hubspot/local-dev-lib/logger'; | ||
| import { logError } from './errorHandlers/index'; | ||
|
|
||
| type ComponentTypes = 'private-app' | 'public-app' | 'hubl-theme'; |
There was a problem hiding this comment.
Since you already declare the COMPONENT_TYPES object below, you could derive this type from that
type ComponentTypes = ValueOf<typeof COMPONENT_TYPES>;
camden11
approved these changes
Dec 16, 2024
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.
Description and Context
Porting projectStructure to TS. I had to add types for project components which doesn't feel great, but I'm not sure that there's another option. Eventually we should offload this type of thing into the new package that will specialize in interacting with project schema, but in the meantime I think we need to keep this here.
I could also add these types to Local Dev Lib, but I think I'd just be adding more work for us down the road when we eventually start to use the translation lib.
Screenshots
TODO
Who to Notify