How web-slate/react-chef works
Project Type & Purpose
• This is an open-source Node.js CLI tool (npm module) that scaffolds React boilerplates (“react-chef”).
• It prescribes best practices by shipping multiple “recipes” (basic, slim, twixtui)—each containing config, snippet templates, and install logic—and generates a ready-to-run React app.
File Structure Analysis
• Top-level entry:
• index.js – the CLI entrypoint
• recipes/ – recipe definitions (config.js, snippets folder)
• utils.js, moduleMatrix.js, install.js – shared utilities for file operations, recipe dispatch, and dependency installation
• .circleci/, package.json, .gitignore, README.md – CI, metadata, docs
• Under each recipe:
• config.js – description of prompts, ports, dependency lists
• snippets/ – raw template files (JSX sources, webpack configs, env files, etc.)
Core Components
a. CLI Frontend
• index.js (parses CLI args, selects recipe)
• moduleMatrix.js (maps projectType → recipe module)
b. Recipe Modules
• recipes/basic, recipes/slim, recipes/twixtui
• each exposes: config, snippet directory, install logic
c. Template Engine / File Generator
• utils.js & install.js orchestrate copying snippet files into a new project folder, applying file renames, running any text interpolation
d. Dependency Installer
• uses Node’s child_process (npm install) to fetch dependencies/devDependencies listed in config.js
e. External Services & Resources
• npm registry (for react, webpack, loaders, etc.)
• File system of the user’s machine (writes scaffolding code)
Relationships & Data Flow
1. User invokes npx react-chef <project-name> --type slim
2. index.js
–→ reads moduleMatrix to resolve the “slim” recipe
3. Recipe Module
–→ reads config.js (port, deps)
–→ points to snippet folder
4. File Generator
–→ scans snippets, copies files into new project tree under <project-name>
–→ writes boilerplate (src/, public/, webpack.config.js, env files)
5. Installer
–→ spawns npm install for runtime + devDependencies from recipe config
6. End result
–→ directory structure with React app, ready for npm run dev
Architectural Patterns & Principles
• Plugin-like recipe modules: easy to add/override recipes
• Single-responsibility: index.js (CLI parsing), moduleMatrix (lookup), utils.js (FS ops), install.js (dependency management)
• Convention over configuration: snippet folder structure dictates final app layout
Relevant Technologies & Libraries
• Node.js core: fs, path, child_process
• npm / npx for execution & package install
• Webpack + Babel (in generated apps, not the CLI itself)
• json files (.babelrc, .eslintrc, webpack.config.js) live in snippets