Do up the readme and start with some zod scaffolding

Author: TheRealFlyingCoder

.gitignore

@@ -1,4 +1,5 @@
 /node_modules
 /build
 /app
-routes.yml
+routes.yml
+src/index.ts

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "Testing",
+			"args": ["${relativeFile}"],
+			"runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"],
+			"resolveSourceMapLocations": ["${workspaceFolder}/**", "!**/node_modules/**"],
+			"env": { "TS_NODE_PROJECT": "${workspaceFolder}\\tsconfig.json" },
+			"cwd": "${workspaceRoot}",
+			"protocol": "inspector"
+		}
+	]
+}

CONTRIBUTING.md

@@ -1,3 +1,7 @@
-# Contribution
+# Contributing to Remix Scaffold
 
-Just do it
+👍🎉 First off, thanks for taking the time to look here! 🎉👍
+
+Right now there are no hard or fast rules while this project kicks off.
+
+Just reach out if you want to get involved, raise PR's or tickets, and make sure to be a nice human! :D 

README.md

@@ -1,19 +1,85 @@
 ![](/assets/header.png)
 
-# Remix Scaffold - WORK IN PROGRESS
+# Remix Scaffold
+>🚧 *This package is still in development and non-functional, reach out if you'd like to help make it reality.* 🚧  
 
-### Simple scaffolding tool for [Remix](https://remix.run/)
+Remix scaffold, is a code-gen tool for [Remix](https://remix.run/) designed to increase your productivity, and manage your route heirarchy.
 
-## Features
+To do this, we provide a `routes.yml` file at the root of your app, which allows you to define the structure and behaviour of your site (Or utilise pre-built structures from the community) from which your routes and views are automatically generated.
 
-- TODO
+## Getting Started
 
-## Overview
+```bash
+#Install globally
+npm install -g remix-scaffold
 
-TODO
+#initialise
+remix-scaffold init
 
-## Getting Started
+#Or simply use npx without installing
+npx remix-scaffold init
+```
+
+This will initialise a `routes.yml` file at the root of your project:
+
+```yml
+structure: co-locate
+routes:
+  - name: Home
+    type: index
+  - name: Login
+  - name: Jokes
+    children:
+      - name: New
+      - name: Joke
+        slug: jokeId
+
+```
+>*Note: The default structure is based off the [remix jokes](https://remix.run/docs/en/v1/tutorials/jokes) tutorial, check it out if you are new to Remix*
+
+This is where you lay out the structure of your site, but for now simply run the following to generate your routes
 
 ```bash
-npm install -D remix-scaffold
+remix-scaffold generate
 ```
+
+Take a look in your `/app/routes` folder and you should see some new routes
+
+![](/assets/generate.png)
+
+And it's really as simple as that!
+
+## Full structure for `routes.yml`
+
+```yml
+structure: split | co-locate #Default - co-locate
+templates: /pathToTemplates #TODO - Define your own templates
+routes:
+  - name: Home #Becomes the route name in lowercase
+    type: basic | index | layout | pathless #Default - basic
+  - name: Blog
+    type: layout
+    children:
+      - name: Post
+        slug: postId #Defines a dynamic route $postId.tsx
+  - name: BlogAuthors
+    route: blog.authors #This will generate Dot Delimeter route
+  - name: CatchAll
+    slug: . #This will generate a $.tsx Splat route
+```
+
+### Route references
+- [Dynamic routes](https://remix.run/docs/en/v1/api/conventions#dynamic-route-parameters)
+- [Layout routes](https://remix.run/docs/en/v1/api/conventions#layout-routes)
+- [Pathless layout routes](https://remix.run/docs/en/v1/api/conventions#pathless-layout-routes)
+- [Dot Delimeters](https://remix.run/docs/en/v1/api/conventions#dot-delimeters)
+- [Splat routes](https://remix.run/docs/en/v1/api/conventions#splat-routes)
+
+## CLI Options (Planned)
+
+### `remix-scaffold init`
+- `--template` - Use a predefined `routes.yml` template from the community (TODO)
+
+### `remix-scaffold generate`
+- `--clear` - Clears folders and routes that no longer exist in the `routes.yml` (TODO)
+- `--reset` - Override existing routes, and clears non-existent routes (TODO)

assets/generate.png

@@ -43,6 +43,7 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "js-yaml": "^4.1.0",
-    "yargs": "^17.3.0"
+    "yargs": "^17.3.0",
+    "zod": "^3.11.6"
   }
 }

package.json

@@ -1,50 +1,59 @@
-import type { Arguments, CommandBuilder } from 'yargs';
-import path from 'path';
-import fs from 'fs';
-import yaml from 'js-yaml';
-import chalk from 'chalk';
-import { YamlConfig } from '../typings/Config';
-
-type Options = {
-	definition: string;
-	// clear: boolean;
-};
-
-export const command: string = 'generate';
-export const desc: string = 'Generate the structure defined in your YAML routes definition file';
-
-export const builder: CommandBuilder<Options, Options> = yargs =>
-	yargs.options({
-		definition: {
-			type: 'string',
-			alias: 'd',
-			default: './routes.yml',
-			description: 'Path to your YAML routes definition',
-		},
-		// clear: {
-		// 	type: 'boolean',
-		// 	alias: 'c',
-		// 	default: false,
-		// 	description: 'Clear folders that no longer exist in the YAML routes definition',
-		// },
-	});
-
-export const handler = (argv: Arguments<Options>): void => {
-	try {
-		const { definition } = argv;
-
-		let defPath = path.join(process.cwd(), definition);
-		if (!defPath.endsWith('.yml')) defPath = `${defPath}.yml`;
-
-		if (!fs.existsSync(defPath)) {
-			throw `Missing YAML route definition at ${defPath}`;
-		}
-
-		const doc = yaml.load(fs.readFileSync(defPath, 'utf8'), { json: true }) as YamlConfig;
-    console.log(JSON.stringify(doc))
-
-	} catch (e) {
-		console.log(chalk.red(e));
-		process.exit();
-	}
-};
+import type { Arguments, CommandBuilder } from 'yargs';
+import path from 'path';
+import fs from 'fs';
+import yaml from 'js-yaml';
+import chalk from 'chalk';
+import { YamlConfig } from '../typings/Config';
+import { routeSchema } from '../utils/routeSchema';
+
+type Options = {
+	definition: string;
+	// clear: boolean;
+	// reset: boolean;
+};
+
+export const command: string = 'generate';
+export const desc: string = 'Generate the structure defined in your YAML routes definition file';
+
+export const builder: CommandBuilder<Options, Options> = yargs =>
+	yargs.options({
+		definition: {
+			type: 'string',
+			alias: 'd',
+			default: './routes.yml',
+			description: 'Path to your YAML routes definition',
+		},
+		// clear: {
+		// 	type: 'boolean',
+		// 	alias: 'c',
+		// 	default: false,
+		// 	description: 'Clear folders and files that no longer exist in the YAML routes definition',
+		// },
+		// reset: {
+		// 	type: 'boolean',
+		// 	alias: 'r',
+		// 	default: false,
+		// 	description: 'Override existing route folders and files, and clear missing ones',
+		// },
+	});
+
+export const handler = (argv: Arguments<Options>): void => {
+	try {
+		const { definition } = argv;
+
+		let defPath = path.join(process.cwd(), definition);
+		if (!defPath.endsWith('.yml')) defPath = `${defPath}.yml`;
+
+		if (!fs.existsSync(defPath)) {
+			throw `Missing YAML route definition at ${defPath}`;
+		}
+
+		const doc = yaml.load(fs.readFileSync(defPath, 'utf8'), { json: true }) as YamlConfig;
+    	const checks = routeSchema.safeParse(doc);
+		console.log(checks.success);
+
+	} catch (e) {
+		console.log(chalk.red(e));
+		process.exit();
+	}
+};

src/commands/generate.ts

@@ -1,30 +1,30 @@
-import type { Arguments, CommandBuilder } from 'yargs';
-import path from 'path';
-import fs from 'fs';
-import chalk from 'chalk';
-
-export const command: string = 'init [type]';
-export const desc: string = 'Creates a pre-defined YAML definition based off the provided type.';
-
-type Options = {
-	type: 'blog' | 'portal'
-}
-
-const getDefinitionOptions = () => {
-	const files = fs.readdirSync(path.join(__dirname, '../templates/definitions'));
-	return files.map(file => path.basename(file, '.yml'));
-}
-
-export const builder: CommandBuilder<Options> = yargs =>
-	yargs.positional('type', { choices: getDefinitionOptions(), default: 'default' });
-
-export const handler = (argv: Arguments<Options>): void => {
-	try {
-		const { type } = argv;
-		console.log(type);
-
-	} catch (e) {
-		console.log(chalk.red(e));
-		process.exit();
-	}
-};
+import type { Arguments, CommandBuilder } from 'yargs';
+import path from 'path';
+import fs from 'fs';
+import chalk from 'chalk';
+
+export const command: string = 'init [type]';
+export const desc: string = 'Creates a pre-defined YAML definition based off the provided type.';
+
+type Options = {
+	type: 'blog' | 'portal'
+}
+
+const getDefinitionOptions = () => { 
+	const files = fs.readdirSync(path.join(__dirname, '../templates/definitions'));
+	return files.map(file => path.basename(file, '.yml'));
+}
+
+export const builder: CommandBuilder<Options> = yargs =>
+	yargs.positional('type', { choices: getDefinitionOptions(), default: 'default' });
+
+export const handler = (argv: Arguments<Options>): void => {
+	try {
+		const { type } = argv;
+		console.log(type);
+
+	} catch (e) {
+		console.log(chalk.red(e));
+		process.exit();
+	}
+};

src/commands/init.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+
+interface RouteObject {
+    slug?: string;
+    type?: "basic" | "layout" | "pathless" | "index";
+    name: string;
+    children?: RouteObject[]
+}
+
+const routeObject: z.Schema<RouteObject> = z.late.object(() => ({
+    name: z.string().regex(/^[A-Z]([A-Za-z]+)/g, 'Name should be PascalCase with no numbers or  special characters'),
+    type: z.enum(['basic', 'layout', 'pathless', 'index']).default('basic'),
+    slug: z.string().regex(/^[a-z]([A-Za-z]+)/g, 'Slug should be camelCase with no numbers or special characters').optional(),
+    children: z.array(routeObject).optional()
+}));
+
+export const routeSchema = z.object({
+    structure: z.enum(['co-locate', 'split'],).default('co-locate'),
+    routes: z.array(routeObject)
+})