Update naming to routesSchema

Author: TheRealFlyingCoder

README.md

@@ -5,7 +5,7 @@
 
 Remix scaffold, is a code-gen tool for [Remix](https://remix.run/) designed to increase your productivity, and manage your route heirarchy.
 
-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.
+After initialising the `routes.yml` file at the root of your app, you can define the site structure from which your routes and views are automatically generated.
 
 ## Getting Started
 

src/commands/generate.ts

@@ -4,7 +4,7 @@ import fs from 'fs';
 import yaml from 'js-yaml';
 import chalk from 'chalk';
 import { YamlConfig } from '../typings/Config';
-import { validateConfig } from '../utils/routeSchema';
+import { validateConfig } from '../utils/routesSchema';
 
 type Options = {
 	definition: string;

src/templates/definitions/default.yml

@@ -1,3 +1,10 @@
-structure: split
-routes:
-  - name: Todo
+structure: co-locate
+routes:
+  - name: Home
+    type: index
+  - name: Login
+  - name: Jokes
+    children:
+      - name: New
+      - name: Joke
+        slug: jokeId

src/utils/routeSchema.ts renamed to src/utils/routesSchema.ts

@@ -15,15 +15,15 @@ const routeObject: z.Schema<RouteObject> = z.late.object(() => ({
     children: z.array(routeObject).optional()
 }));
 
-export const configSchema = z.object({
+export const routesSchema = z.object({
     structure: z.enum(['co-locate', 'split'],).default('co-locate'),
     routes: z.array(routeObject)
 })
 
-export type ScaffoldConfig = z.infer<typeof configSchema>
+export type RoutesConfig = z.infer<typeof routesSchema>
 
-export const validateConfig = (doc: YamlConfig): ScaffoldConfig => {
-    const checks = configSchema.safeParse(doc);
+export const validateConfig = (doc: YamlConfig): RoutesConfig => {
+    const checks = routesSchema.safeParse(doc);
 
     if(!checks.success) {
         throw checks.error.issues.reduce((acc, curr) => {