API refactors #21
API refactors #21
Conversation
move IBlock to client.ts so it lives with IPageData. this reduces the naming surface area because `contents` always refers to rendered `StringOrTag[]` and `contentsRaw` is always a string.
…ngNode IPageNode extends IHeadingNode for maximal reuse (depth => level)
fix compiler testsPreview: docs |
|
|
||
| /** Parsed nodes of source file. An array of rendered HTML strings or `@tag` objects. */ | ||
| contents: StringOrTag[]; | ||
| contentsRaw: string; |
There was a problem hiding this comment.
thoughts on content vs contents?
There was a problem hiding this comment.
hmmmmm i think i prefer to use plurals for arrays but singular for non arrays
There was a problem hiding this comment.
i definitely prefer consistency. either content or contents. i see no need to use them both in the same interface.
| @@ -5,10 +5,32 @@ | |||
| * repository. | |||
| */ | |||
|
|
|||
| /** Slugify a string: "Really Cool Heading!" => "really-cool-heading-" */ | |||
| export function slugify(str: string) { | |||
| * The basic components of a navigable resource: a "route" at which it can be accessed and | ||
| * its depth in the layout hierarchy. Heading tags and hierarchy nodes both extend this interface. | ||
| */ | ||
| export interface INavigable { |
|
|
||
| /** Parsed nodes of source file. An array of rendered HTML strings or `@tag` objects. */ | ||
| contents: StringOrTag[]; | ||
| contentsRaw: string; |
There was a problem hiding this comment.
hmmmmm i think i prefer to use plurals for arrays but singular for non arrays
| depth: number; | ||
| route: string; | ||
| /* | ||
| LAYOUT HIERARCHY NODES |
There was a problem hiding this comment.
these gigantic capitalized headers indicate to me that these should be a in a separate named "layoutHierarchy.ts" or something
There was a problem hiding this comment.
Maybe in a client subdir with an index.ts so you can import everthing you need
There was a problem hiding this comment.
hmm these are all pretty intertwined and it's nice having all the symbols in one file.
|
|
||
| export type PartialPageData = Pick<IPageData, "absolutePath" | "contentRaw" | "contents" | "metadata">; | ||
| export type PartialPageData = Pick<IPageData, "absolutePath" | keyof IBlock>; |
There was a problem hiding this comment.
oh yeah! tho this type is gonna go away in my next PR
IPageDataextendsIBlock, compiler methods also speakIBlockcontentsalways refers to renderedStringOrTag[]andcontentsRawis always a string.INavigablefor route & level used inIHeadingTag&IHeadingNodeIPageNodeextendsIHeadingNodefor maximal reuse (also rename depth → level)anyarg & check existence first