create-vacancies-scaffold

create-vacancies-scaffold is a CLI tool designed to streamline the setup of Next.js (14+) App Router projects with TypeScript. It automates the scaffolding process by generating a robust file structure—including a job listings page, context providers, reusable components, utilities, and Jest configuration—while handling dependency installation and file conflict resolution.

Table of Contents

• Features
• Installation
• Usage

Features

• Automated Scaffold Generation:

  • Creates a /jobs route with page.tsx (including <Hero /> and <JobListings /> components).
  • Generates a context file at /contexts/JobListingsContext.tsx.
  • Sets up components under /components/organisms, /components/molecules, and /components/atoms, each with accompanying .module.scss and .test.tsx files.
  • Adds a utility file at /utils/data/readVacanciesData.ts for fetching data from a CMS API.
  • Configures Jest for unit testing with jest.config.ts and jest.setup.ts copied to the project root.
  • Automatically updates the project's tsconfig.json to include "types": ["node", "jest", "@testing-library/jest-dom"] if it exists.
  • Installs necessary dependencies if --install is set.

• Smart File Copying:

  • Merges directories if they already exist, prompting for file conflicts (unless --force is used).
  • Copies Jest configuration files from the CLI’s root to the new project root.
  • Detects if a /src folder exists in the project and copies scaffold files accordingly, while ensuring public assets remain in the root.

• Command-Line Options:

  • --force (-f): Overwrite existing files without prompting.
  • --install (-i): Automatically install required dependencies.

Installation

Locally for Development

1. Clone the repository:

git clone https://github.com/yourusername/create-vacancies-scaffold.git

2. Install dependencies

npm install

3. Link the CLI tool globally

npm link

Usage

Run the CLI in the root directory of your Next.js project

npx create-vacancies-scaffold --install