refactor: human-readable resource IDs use double underscore #2310
Conversation
🦋 Changeset detectedLatest commit: 122b309 The changes in this PR will be included in the next version bump. This PR includes changesets to release 30 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
packages/common/src/resourceLabel.ts
Outdated
| name, | ||
| }: { | ||
| readonly namespace: string; | ||
| readonly name: string; |
There was a problem hiding this comment.
not blocking but this could also be Pick<Resource, 'namespace' | 'name'>
(we should also make Resource type use readonly props)
There was a problem hiding this comment.
Kicking this one until we fix Resource: #2321
packages/common/src/resourceLabel.ts
Outdated
| @@ -0,0 +1,11 @@ | |||
| export type ResourceLabel = `${string}__${string}`; | |||
|
|
|||
| export function resourceLabel({ | |||
There was a problem hiding this comment.
thoughts on getResourceLabel or resourceToLabel?
There was a problem hiding this comment.
Definitely prefer one of them
There was a problem hiding this comment.
Going with resourceToLabel for consistency with resourceToHex
packages/common/src/resourceLabel.ts
Outdated
| @@ -0,0 +1,11 @@ | |||
| export type ResourceLabel = `${string}__${string}`; | |||
There was a problem hiding this comment.
if you wanted to get real fancy, could make this generic, e.g.
export type ResourceLabel<namespace extends string = string, name extends string = string> = `${namespace}__${name}`;only case I can think in which this might be useful is the RECS component metadata for a given table, where tableName would show up as e.g. store__Tables
There was a problem hiding this comment.
Ohhh I like that! I was thinking namespace and name should kinda be types
Co-authored-by: Kevin Ingersoll <[email protected]>
related to #2173