create-routify 1.5.0 → 1.5.2

package/CONTRIBUTORS.md

@@ -0,0 +1,66 @@
+# Contributors
+
+## Adding your own template repo
+To contribute new templates to the project, you need to create a configuration for it that matches our TemplateRepoConfig type. The configuration is added to `config.js`.
+
+You can contribute two types of template repositories: `single` and `directory`. `single` contains one main template. `directory`, on the other hand, houses multiple templates, each in its own subdirectory.
+
+Here are examples of TemplateRepoConfig objects for each type:
+
+### Single template repo
+```javascript
+{
+    "url": "github:user/repo",
+    "path": "optional/path/inside/repo",
+    "name": "My Custom Template",
+    "description": "This is a custom template contributed to the project.",
+    "templateType": "single",
+    "author": "Your Name",
+}
+```
+
+### Directory templates repo
+```javascript
+{
+    "url": "github:user/repo",
+    "path": "optional/path/inside/repo",
+    "templateType": "directory",
+    "author": "Your Name",
+    "requireManifest": false // folders without a manifest will be skipped
+}
+```
+
+## Template Manifest
+Manifests are optional and located at `<template>/manifest.js`. They enhance the template with extra information and features.
+
+Here's a Template manifest example
+```javascript
+{
+    name: 'my starter template',
+    description: 'description of my template',    
+    test: {
+        // adding tests will enable the `test` feature option
+        // if users enable tests, this will automatically install vitest to the project
+        tests: [{ page: '/', contains: 'Welcome to my starter template' }],
+    },
+    // features are selectable by the user after selecting the template
+    features: [
+        {
+            label: 'My Super Feature',
+            value: 'my-super-feature',
+            hint: 'This adds a super feature to the projet',
+            initial: true, // should the user opt in or opt out
+        },
+    ],    
+    // runs after `npm install`, whether install is skipped or not
+    // options contains the options selected by the user
+    postInstall: async (options)=>{        
+        // it's often easier to remove a feature than add a feature
+        if (!options.features.includes('my-super-feature')) {
+            const { rm } = await import('fs/promises');
+            await rm(`${options.projectDir}/src/components/superFeature.js`);
+        }
+    }
+    // same as postInstall, but runs before `npm install`
+    // preInstall: (options)=>{}
+}

package/config.js

@@ -0,0 +1,43 @@
+const features = {
+    prettier: {
+        label: 'prettier',
+        value: 'prettier',
+        hint: 'Add prettier config',
+        initial: true,
+    },
+};
+
+/** @type {TemplateConfig} */
+export default {
+    versions: {
+        2: {
+            defaultTemplate: 'v2 starter template',
+            templatesRepos: [
+                {
+                    url: 'roxiness/routify-starter',
+                    name: 'v2 starter template',
+                    description: 'Routify v2 starter template',
+                    templateType: 'single',
+                    author: 'Roxi (official)',
+                    includeByDefault: true,
+                },
+            ],
+            features: [features.prettier],
+        },
+        3: {
+            defaultTemplate: 'basic-starter',
+            templatesRepos: [
+                {
+                    url: 'roxiness/routify#next',
+                    // url: 'local:../routify',
+                    path: 'examples',
+                    templateType: 'directory',
+                    author: 'Roxi (official)',
+                    includeByDefault: true,
+                    requireManifest: true,
+                },
+            ],
+            features: [features.prettier],
+        },
+    },
+};

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "create-routify",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "A powerful cli for super-powering your routify development experience",
   "main": "index.js",
   "type": "module",
   "files": [
     "src",
+    "config.js",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "CONTRIBUTORS.md"
   ],
   "bin": {
     "create-routify": "./src/bin.js"

package/src/utils/patcher/test/index.js

@@ -63,6 +63,9 @@ const installVitest = async (dir) => {
     test: {
         environment: 'jsdom',
         globals: true,
+        server: {
+            deps: { inline: ["@roxi/routify"] },
+        }          
     },
     plugins: [`,
             ),

package/src/versions/three/skeleton/index.html

@@ -1,31 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-    <head>
-        <meta charset="utf-8" />
-        <meta name="viewport" content="width=device-width,initial-scale=1" />
-
-        <title>Svelte app</title>
-
-        <!-- Google Fonts -->
-        <link
-            rel="stylesheet"
-            href="https://fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic"
-        />
-
-        <!-- CSS Reset -->
-        <link
-            rel="stylesheet"
-            href="https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.1/normalize.css"
-        />
-
-        <!-- Milligram CSS -->
-        <link
-            rel="stylesheet"
-            href="https://cdnjs.cloudflare.com/ajax/libs/milligram/1.4.1/milligram.css"
-        />
-
-        <script type="module" src="/src/main.js"></script>
-    </head>
-
-    <body></body>
-</html>

package/src/versions/three/skeleton/package.json

@@ -1,16 +0,0 @@
-{
-    "name": "starter",
-    "type": "module",
-    "scripts": {
-        "build": "vite build",
-        "preview": "vite preview",
-        "dev": "vite"
-    },
-    "devDependencies": {
-        "@roxi/routify": "^3.0.0-next.1",
-        "@sveltejs/vite-plugin-svelte": "^1.0.0-next.13",
-        "mdsvex": "^0.9.3",
-        "svelte": "^3.39.0",
-        "vite": "^2.2.3"
-    }
-}

package/src/versions/three/skeleton/src/App.svelte

@@ -1,6 +0,0 @@
-<script>
-    import { Router } from '@roxi/routify'
-    import routes from '../.routify/routes.default.js'
-</script>
-
-<Router {routes} />

package/src/versions/three/skeleton/src/main.js

@@ -1,5 +0,0 @@
-import App from './App.svelte'
-
-const app = new App({ target: document.body })
-
-export default app

package/src/versions/three/skeleton/src/routes/index.md

@@ -1 +0,0 @@
-# Routify 3 App

package/src/versions/three/skeleton/vite.config.js

@@ -1,24 +0,0 @@
-import { svelte } from '@sveltejs/vite-plugin-svelte'
-import routify from '@roxi/routify/vite-plugin'
-import { defineConfig } from 'vite'
-import { mdsvex } from 'mdsvex'
-
-const production = process.env.NODE_ENV === 'production'
-
-export default defineConfig({
-    clearScreen: false,
-
-    plugins: [
-        routify(),
-        svelte({
-            emitCss: true,
-            compilerOptions: {
-                dev: !production,
-            },
-            extensions: ['.md', '.svelte'],
-            preprocess: [mdsvex({ extension: 'md' })],
-        }),
-    ],
-
-    server: { port: 1337 },
-})

package/src/versions/two.js

@@ -1,18 +0,0 @@
-import logSymbols from 'log-symbols';
-import simpleGit from 'simple-git';
-import { rmSync } from 'fs';
-import { join } from 'path';
-import k from 'kleur';
-
-export const run = async ({ projectDir, args }) => {
-    const git = simpleGit(projectDir);
-
-    console.log(k.blue(`\n${logSymbols.info} Cloning template...`));
-
-    await git.clone('https://github.com/roxiness/routify-starter', projectDir);
-
-    rmSync(join(projectDir, '.git'), {
-        recursive: true,
-        force: true,
-    });
-};

package/src/versions404/three/index.js

@@ -1,29 +0,0 @@
-import { getTemplate, onCancel } from '../../utils/prompts.js';
-import { readdir, cp, rm } from 'fs/promises';
-import { join, dirname } from 'path';
-import { fileURLToPath, pathToFileURL } from 'url';
-import prompts from 'prompts';
-import k from 'kleur';
-import { getRoutifyExamplesDir, routifyIntro } from './utils.js';
-import { existsSync } from 'fs';
-import { addTests } from '../../utils/patcher/test/index.js';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-export const run = async (options) => {
-    const { dir, force, version, starter } = options;
-    console.log('options', options);
-    routifyIntro();
-
-    const routifyExamplesDir = getRoutifyExamplesDir();
-    const project = await getTemplate(routifyExamplesDir, starter);
-    console.log('project', project);
-    if (project.test) {
-        const { tests } = project.test;
-        console.log(tests);
-        addTests(projectDir, project.test);
-    }
-
-    // await cp(exampleDir, projectDir, { recursive: true });
-    // await rm(join(projectDir, 'manifest.js'));
-};

package/src/versions404/three/utils.js

@@ -1,24 +0,0 @@
-import { createRequire } from 'module';
-import { resolve } from 'path';
-import k from 'kleur';
-const require = createRequire(import.meta.url);
-
-export function routifyIntro() {
-    console.log();
-    console.log(
-        `  ${k.underline(
-            `${k.bold().magenta('Routify')} ${k.bold('3')} beta`,
-        )}`,
-    );
-    console.log(
-        `  - Follow our twitter to get updates: ${k.blue(
-            'https://twitter.com/routifyjs',
-        )}`,
-    );
-    console.log(
-        `  - Or join our discord: ${k.blue(
-            'https://discord.com/invite/ntKJD5B',
-        )}`,
-    );
-    console.log();
-}

package/src/versions404/two.js

@@ -1,18 +0,0 @@
-import logSymbols from 'log-symbols';
-import simpleGit from 'simple-git';
-import { rmSync } from 'fs';
-import { join } from 'path';
-import k from 'kleur';
-
-export const run = async ({ projectDir, args }) => {
-    const git = simpleGit(projectDir);
-
-    console.log(k.blue(`\n${logSymbols.info} Cloning template...`));
-
-    await git.clone('https://github.com/roxiness/routify-starter', projectDir);
-
-    rmSync(join(projectDir, '.git'), {
-        recursive: true,
-        force: true,
-    });
-};