Skip to content

Commit 2f2ce23

Browse files
committed
docs: add various doc comments in the code
1 parent 97774b2 commit 2f2ce23

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

packages/create/src/utils/constants.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ export const JS_CONFIG = {
4040

4141
// Supported templates
4242

43+
/**Supported Vanilla Templates */
4344
const VANILLA_TEMPLATES = [
4445
"ts",
4546
"ts-vitest",
@@ -58,6 +59,7 @@ const VANILLA_TEMPLATES = [
5859
] as const satisfies string[];
5960
export type VanillaTemplate = (typeof VANILLA_TEMPLATES)[number];
6061

62+
/**Supported Start Templates */
6163
const START_TEMPLATES = [
6264
"basic",
6365
"bare",
@@ -80,12 +82,17 @@ const START_TEMPLATES = [
8082
] as const satisfies string[];
8183
export type StartTemplate = (typeof START_TEMPLATES)[number];
8284

85+
/**Supported Library Templates */
8386
export const LIBRARY_TEMPLATES = ["solid-lib-starter"] as const satisfies string[];
8487
export type LibraryTemplate = (typeof LIBRARY_TEMPLATES)[number];
8588

8689
export const PROJECT_TYPES = ["start", "vanilla", "library"] as const satisfies string[];
8790
export type ProjectType = (typeof PROJECT_TYPES)[number];
8891

92+
/**
93+
* Fetches the template list for the project type given
94+
* @param projectType type of project
95+
*/
8996
export function getTemplatesList(projectType: "vanilla"): StartTemplate[];
9097
export function getTemplatesList(projectType: "start"): VanillaTemplate[];
9198
export function getTemplatesList(projectType: "library"): VanillaTemplate[];

packages/create/src/utils/ts-conversion.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { join, resolve } from "node:path";
44
import { transform } from "sucrase";
55
import { rm } from "node:fs/promises";
66
import { JS_CONFIG } from "./constants";
7+
78
const convertToJS = async (file: Dirent, startPath: string) => {
89
const src = join(startPath, file.name);
910
const dest = resolve(startPath.replace(".project", ""), file.name);

0 commit comments

Comments
 (0)