You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: buildUtils/buildNotes/todo.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,19 @@
1
1
# ULLD To-Do
2
2
3
3
4
+
## When Online
5
+
6
+
-[ ] Write tests for all package managers and make sure all are passing as that will be pretty much impossible when offline.
7
+
4
8
## Priority
5
9
6
-
-[ ] Create utility scripts to read and right each file in `/Users/bigsexy/Desktop/current/ulld/buildUtils/buildNotes/` similar to the `whenOnline` scripts.
10
+
-[ ] Setup `BasePathFs` described [here](https://github.com/spf13/afero#using-afero-for-testing). This is pretty much exactly what we want to accomodate the `targetdir`.
-[ ] Create utility scripts to read and write each file in `/Users/bigsexy/Desktop/current/ulld/buildUtils/buildNotes/` similar to the `whenOnline` scripts.
7
17
-[ ] Cli script to render markdown using the UlldServer throught he cli and display as an independent page, similar to grip.
@@ -26,57 +26,57 @@ export const embeddableConfigSchema = z
26
26
});
27
27
28
28
// TODO: Dynamically generate more strict types after the baseline build process is handled. The component slots should be more strict based on the parents type.
"Help user's find your component both before they install it, and while searching for documentation.",
40
-
)
41
-
.default([]),
42
-
slot: z
43
-
.string()
44
-
.optional()
45
-
.describe(
46
-
"This only applys if the component is meant to override an existing slot. All 'slots' in the appConfigSchema exported from @ulld/configschema/main/zod at the slots key will have an accompanying 'subslot' schema exported from @ulld/configschema/subslots/<name of that slot>. This schema will be a record of a specific set of keys unique to that slot, and a path to a component. All of these paths are initially populated by internally developed components, but can be overridden if your plugin defines the initial slot at the developerConfigSchema.slot path, and then overrides one or more subslots unique to that slot. This componentConfigSchema.slot path will be that subslot if it applies. Most components that are embedded in a user's notes, and don't modify the app as a whole do not occupy slots.",
47
-
),
48
-
export: z
49
-
.string()
50
-
.describe(
51
-
"The path that this component is exported as in your package.json.",
!val ? undefined : Array.isArray(val) ? val : [val],
60
-
)
61
-
.describe(
62
-
"This can be an array to apply aliases to the same component. The component won't be imported twice.",
63
-
),
64
-
exportedPropsName: z.string().optional(),
65
-
docsExport: z
66
-
.string()
67
-
.optional()
68
-
.describe(
69
-
"The package.json export that points to a .md or .mdx file that provides a quick reference for the component. This should be simple enough to be opened in the command palette in split view. If only docsExport or fullDocsExport is provided, this shorter docsExport is heavily preferred.",
70
-
),
71
-
fullDocsExport: z
72
-
.string()
73
-
.optional()
74
-
.describe(
75
-
"Similar to docsExport, but will be shown when users redirect to an entire page. This markdown can be more complex and include examples, but the components used must only consist of core ULLD components and your plugin, since we don't know what plugins other user's will be using.",
76
-
),
77
-
componentId: z.string().uuid("Your component id must be a UUID string.").default(defaultUUID)
"Help user's find your component both before they install it, and while searching for documentation.",
39
+
)
40
+
.default([]),
41
+
slot: z
42
+
.string()
43
+
.optional()
44
+
.describe(
45
+
"This only applys if the component is meant to override an existing slot. All 'slots' in the appConfigSchema exported from @ulld/configschema/main/zod at the slots key will have an accompanying 'subslot' schema exported from @ulld/configschema/subslots/<name of that slot>. This schema will be a record of a specific set of keys unique to that slot, and a path to a component. All of these paths are initially populated by internally developed components, but can be overridden if your plugin defines the initial slot at the developerConfigSchema.slot path, and then overrides one or more subslots unique to that slot. This componentConfigSchema.slot path will be that subslot if it applies. Most components that are embedded in a user's notes, and don't modify the app as a whole do not occupy slots.",
46
+
),
47
+
export: z
48
+
.string()
49
+
.describe(
50
+
"The path that this component is exported as in your package.json.",
!val ? undefined : Array.isArray(val) ? val : [val],
58
+
)
59
+
.describe(
60
+
"This can be an array to apply aliases to the same component. The component won't be imported twice.",
61
+
),
62
+
exportedPropsName: z.string().optional(),
63
+
docsExport: z
64
+
.string()
65
+
.optional()
66
+
.describe(
67
+
"The package.json export that points to a .md or .mdx file that provides a quick reference for the component. This should be simple enough to be opened in the command palette in split view. If only docsExport or fullDocsExport is provided, this shorter docsExport is heavily preferred.",
68
+
),
69
+
fullDocsExport: z
70
+
.string()
71
+
.optional()
72
+
.describe(
73
+
"Similar to docsExport, but will be shown when users redirect to an entire page. This markdown can be more complex and include examples, but the components used must only consist of core ULLD components and your plugin, since we don't know what plugins other user's will be using.",
0 commit comments