create-zephyr-apps 0.0.7 → 0.0.8

package/package/utils/constants.ts

@@ -6,63 +6,69 @@ const BASE_REPO = `${REPO_OWNER}/${REPO_NAME}`;
 
 const REPACK_REPO_PATH = `${REPO_OWNER}/${REPACK_REPO}`;
 
-
 const TEMPLATES = {
-    'rspack-project': {
-        label: 'React + Rspack',
-        hint: 'A simple application build by Rspack.',
-        framework: 'react'
-    },
-    'react-vite-ts': {
-        label: 'A simple React application build by Vite',
-        hint: 'You will be building React app powered by Vite.',
-        framework: 'react'
-    },
-    'react-vite-mf': {
-        label: 'React + Vite + Webpack + Rspack',
-        hint: 'You will be building federated React apps powered by Vite, Webpack and Rspack.',
-        framework: 'react'
-    },
-    'angular-vite': {
-        label: 'Angular app with Vite',
-        hint: 'You will be building an Angular app powered by Vite.',
-        framework: 'angular'
-    },
-    'react-webpack-mf': {
-        label: 'React + Webpack',
-        hint: 'A React application with Module Federation, using Webpack as the bundler.',
-        framework: 'react'
-    },
-    'nx-rspack-mf': {
-        label: 'React + Nx + Rspack',
-        hint: 'A React application with Module Federation, using Nx as Monorepo manager and Rspack as the bundler.',
-        framework: 'react'
-    },
-    'nx-webpack-mf': {
-        label: 'React + Nx + Webpack',
-        hint: 'React applications with Module Federation, using Nx as Monorepo manager and Webpack as the bundler.',
-        framework: 'react'
-    },
-    'ng-nx': {
-        label: 'Angular app with Nx',
-        hint: 'An Angular application with Nx as Monorepo manager.',
-        framework: 'angular'
-    },
-    'qwik-1.5': {
-        label: 'Qwik + Vite',
-        hint: 'A Qwik v1.5 app using Vite as the bundler.',
-        framework: 'qwik'
-    },
-    'react-rspack-tractor-2.0': {
-        label: 'React + Rspack + Tractor 2.0',
-        hint: 'A React application using Rspack as the bundler and Tractor 2.0 as the module federation manager.',
-        framework: 'react'
-    },
-    'turbo-rspack-mf': {
-        label: 'Turbo + Rspack + Module Federation',
-        hint: 'A monorepo using Turborepo, React, and Rspack as the bundler.',
-        framework: 'react'
-    }
-}
+  'rspack-project': {
+    label: 'React + Rspack',
+    hint: 'A simple application build by Rspack.',
+    framework: 'react',
+  },
+  'react-vite-ts': {
+    label: 'A simple React application build by Vite',
+    hint: 'You will be building React app powered by Vite.',
+    framework: 'react',
+  },
+  'react-vite-mf': {
+    label: 'React + Vite + Webpack + Rspack',
+    hint: 'You will be building federated React apps powered by Vite, Webpack and Rspack.',
+    framework: 'react',
+  },
+  'angular-vite': {
+    label: 'Angular app with Vite',
+    hint: 'You will be building an Angular app powered by Vite.',
+    framework: 'angular',
+  },
+  'react-webpack-mf': {
+    label: 'React + Webpack',
+    hint: 'A React application with Module Federation, using Webpack as the bundler.',
+    framework: 'react',
+  },
+  'nx-rspack-mf': {
+    label: 'React + Nx + Rspack',
+    hint: 'A React application with Module Federation, using Nx as Monorepo manager and Rspack as the bundler.',
+    framework: 'react',
+  },
+  'nx-webpack-mf': {
+    label: 'React + Nx + Webpack',
+    hint: 'React applications with Module Federation, using Nx as Monorepo manager and Webpack as the bundler.',
+    framework: 'react',
+  },
+  'ng-nx': {
+    label: 'Angular app with Nx',
+    hint: 'An Angular application with Nx as Monorepo manager.',
+    framework: 'angular',
+  },
+  'qwik-1.5': {
+    label: 'Qwik + Vite',
+    hint: 'A Qwik v1.5 app using Vite as the bundler.',
+    framework: 'qwik',
+  },
+  'react-rspack-tractor-2.0': {
+    label: 'React + Rspack + Tractor 2.0',
+    hint: 'A React application using Rspack as the bundler and Tractor 2.0 as the module federation manager.',
+    framework: 'react',
+  },
+  'turbo-rspack-mf': {
+    label: 'Turbo + Rspack + Module Federation',
+    hint: 'A monorepo using Turborepo, React, and Rspack as the bundler.',
+    framework: 'react',
+  },
+};
 
-export { REPO_OWNER, REPO_NAME, REPACK_REPO, BASE_REPO, REPACK_REPO_PATH, TEMPLATES };
+export {
+  REPO_OWNER,
+  REPO_NAME,
+  REPACK_REPO,
+  BASE_REPO,
+  REPACK_REPO_PATH,
+  TEMPLATES,
+};

package/package/utils/end.ts

@@ -1,41 +1,29 @@
-import { CLIOptions } from './types';
-import c from 'chalk';
-import { exec } from 'child_process';
+import { exec } from 'node:child_process';
 import { note } from '@clack/prompts';
+import c from 'chalk';
+import type { CLIOptions } from './types';
 
 export default function end_note({ project }: { project: CLIOptions }) {
   try {
-    exec(`git config user.name`, (err, stdout, stderr) => {
+    exec('git config user.name', (err, stdout, stderr) => {
       const user_name = stdout.toString().trim();
-
       const repo_name = project.path.split('/').pop();
 
-      let next_steps;
+      let next_steps: string[];
 
       if (project.type === 'web') {
-        next_steps = [
-          `cd ${repo_name}`,
-          `pnpm install`,
-          `rm -rf .git`,
-          `git init`,
-          `git remote add origin https://github.com/${user_name.length >= 1 ? user_name : 'YourUsername'}/${repo_name}.git`,
-          `git add .`,
-          `git commit -m "Initial commit"`,
-          `pnpm run build`,
-        ];
+        next_steps = [`cd ${repo_name}`, 'pnpm install', 'pnpm run build'];
       } else {
         next_steps = [
           `cd ${repo_name}`,
-          `pnpm install`,
-          `rm -rf .git`,
-          `git init`,
-          c.magenta(`git remote add origin https://github.com/${user_name.length >= 1 ? user_name : 'YourUsername'}/${repo_name}.git`),
-          `git add .`,
-          `git commit -m "Initial commit"`,
-          `ZC=1 pnpm run start`,
-          `\n--------------------------------\n`,
-          `Make your first commit and link it to the remote repository!`,
-          `Read more about how Module Federation works with Zephyr and why steps above are required: ${c.underline(c.cyan('https://docs.zephyr-cloud.io/how-to/mf-guide'))}`,
+          'pnpm install',
+          c.magenta(
+            `git remote add origin https://github.com/${user_name.length >= 1 ? user_name : 'YourUsername'}/${repo_name}.git`,
+          ),
+          'ZC=1 pnpm run start',
+          '\n--------------------------------\n',
+          'Make sure to commit and add a remote to the remote repository!',
+          `Read more about how Module Federation works with Zephyr: ${c.underline(c.cyan('https://docs.zephyr-cloud.io/how-to/mf-guide'))}`,
         ];
       }
 
@@ -53,4 +41,3 @@ export default function end_note({ project }: { project: CLIOptions }) {
     note(Object.values(end_notes).join('\n'), 'Problems?');
   }
 }
-

package/package/utils/types.ts

@@ -29,4 +29,4 @@ export interface CLIOptions {
   //host_name: string | undefined;
   //remote_names: string[] | undefined;
   install: boolean;
-}
+}

package/package.json

@@ -1,12 +1,8 @@
 {
   "name": "create-zephyr-apps",
   "module": "./src/index.ts",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "type": "module",
-  "scripts": {
-    "build": "rslib build",
-    "dev": "tsx package/index.ts"
-  },
   "author": {
     "name": "ZephyrCloudIO",
     "url": "https://github.com/ZephyrCloudIO"
@@ -14,6 +10,33 @@
   "bin": {
     "create-zephyr-apps": "dist/index.mjs"
   },
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "zephyr",
+    "create-zephyr-apps",
+    "zephyr-apps",
+    "zephyr-cli",
+    "zephyr-example",
+    "zephyr-template",
+    "example",
+    "template"
+  ],
+  "lint-staged": {
+    "*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}": [
+      "biome check --files-ignore-unknown=true"
+    ]
+  },
+  "simple-git-hooks": {
+    "pre-commit": "npx lint-staged"
+  },
+  "scripts": {
+    "build": "rslib build",
+    "dev": "tsx package/index.ts",
+    "lint": "biome check",
+    "fix": "biome format && biome check --fix --unsafe"
+  },
   "dependencies": {
     "@clack/core": "^0.4.1",
     "@clack/prompts": "^0.9.1",
@@ -22,6 +45,9 @@
     "tempy": "^3.1.0"
   },
   "devDependencies": {
+    "lint-staged": "^15.4.3",
+    "simple-git-hooks": "^2.11.1",
+    "@biomejs/biome": "1.9.4",
     "@rslib/core": "^0.3.2",
     "@types/degit": "^2.8.6",
     "@types/node": "^22.10.7",
@@ -32,18 +58,5 @@
   "peerDependencies": {
     "typescript": "^5.0.0"
   },
-  "packageManager": "pnpm@9.15.0",
-  "engines": {
-    "node": ">=18"
-  },
-  "keywords": [
-    "zephyr",
-    "create-zephyr-apps",
-    "zephyr-apps",
-    "zephyr-cli",
-    "zephyr-example",
-    "zephyr-template",
-    "example",
-    "template"
-  ]
-}
+  "packageManager": "pnpm@9.15.0"
+}

package/rslib.config.ts

@@ -1,42 +1,41 @@
 import { defineConfig } from '@rslib/core';
 
 export default defineConfig({
-    source: {
-        entry: {
-            index: './package/index.ts',
-        }
+  source: {
+    entry: {
+      index: './package/index.ts',
     },
-    lib: [
-        {
-            format: 'cjs',
-            autoExtension: false,
-            syntax: 'es2020',
-            dts: {
-                build: true,
-            },
-            output: {
-                target: 'node',
-                filename: {
-                    js: '[name].cjs',
-                },
-                cleanDistPath: true,
-            },
+  },
+  lib: [
+    {
+      format: 'cjs',
+      autoExtension: false,
+      syntax: 'es2020',
+      dts: {
+        build: true,
+      },
+      output: {
+        target: 'node',
+        filename: {
+          js: '[name].cjs',
         },
-        {
-            format: 'esm',
-            autoExtension: false,
-            syntax: 'es2020',
-            dts: {
-                build: true,
-            },
-            output: {
-                target: 'node',
-                filename: {
-                    js: '[name].mjs',
-                },
-                cleanDistPath: true,
-            },
-        }
-    ],
-
-});
+        cleanDistPath: true,
+      },
+    },
+    {
+      format: 'esm',
+      autoExtension: false,
+      syntax: 'es2020',
+      dts: {
+        build: true,
+      },
+      output: {
+        target: 'node',
+        filename: {
+          js: '[name].mjs',
+        },
+        cleanDistPath: true,
+      },
+    },
+  ],
+});

package/tsconfig.json

@@ -6,7 +6,6 @@
     "module": "ES2020",
     "moduleDetection": "force",
 
-  //"jsx": "react-jsx",
     "allowJs": true,
 
     // Bundler mode
@@ -24,7 +23,7 @@
     // Some stricter flags (disabled by default)
     "noUnusedLocals": false,
     "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false, 
+    "noPropertyAccessFromIndexSignature": false,
     "outDir": "./dist",
     "types": ["node"]
   }