fm-starter-cli 1.0.0

package/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arthur Gehlen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+# fm-starter-cli
+
+CLI tool to automate the setup of React projects from Frontend Mentor challenges.
+
+This tool automatically creates a new React project using Vite and copies the relevant challenge files into the new project structure, removing the need for manual setup every time you start a new Frontend Mentor project.
+
+---
+
+## Features
+
+When provided with the directory of a Frontend Mentor challenge, the CLI will:
+
+- Create a new React project using Vite
+- Move the `assets` folder into `src/assets`, replacing the existing one
+- Copy the following folder:
+  - `design`
+- Copy the following files:
+  - `preview.jpg`
+  - `README.md`
+  - `README-template.md`
+  - `style-guide.md`
+- Merge the challenge `.gitignore` with the generated project's `.gitignore`
+- Extract all textual content from `index.html` and generate a `.txt` file
+- Automatically install project dependencies
+
+---
+
+## Requirements
+
+- Node.js version 18 or higher
+
+---
+
+## Installation (Global)
+
+Inside the project directory:
+
+```bash
+npm install
+npm install -g .
+```
+
+---
+
+## Usage
+Run the command and provide the path to your Frontend Mentor challenge folder:
+```bash
+fm-scaffold C:\path\to\frontend-mentor-challenge
+```
+A new folder will be created in your current working directory:
+```bash
+challenge-name-react/
+```
+
+## License
+This project is licensed under the MIT License.

package/fm-starter-cli.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+import fs from "fs-extra";
+import path from "path";
+import { execa } from "execa";
+
+const fm_path = process.argv[2];
+const project_name = path.basename(fm_path) + "-react"; // configurando o nome da pasta :)
+
+async function run() {
+  await execa(
+    "npx",
+    ["create-vite@latest", project_name, "--template", "react"],
+    {
+      stdio: "ignore",
+    },
+  );
+
+  const vite_path = path.join(process.cwd(), project_name);
+
+  // substituindo a pasta assets
+  await fs.remove(path.join(vite_path, "src/assets"));
+  await fs.copy(
+    path.join(fm_path, "assets"),
+    path.join(vite_path, "src/assets"),
+  );
+
+  await fs.copy(path.join(fm_path, "design"), path.join(vite_path, "design"));
+
+  const files = [
+    "README.md",
+    "README-template.md",
+    "style-guide.md",
+    "preview.jpg",
+  ];
+
+  for (const file of files) {
+    await fs.copy(path.join(fm_path, file), path.join(vite_path, file), {
+      overwrite: true,
+    });
+  }
+
+  // lendo o arquivo git pra mesclar com o vite + react
+  const fm_git = await fs.readFile(path.join(fm_path, ".gitignore"), "utf-8");
+
+  const vite_git_path = path.join(vite_path, ".gitignore");
+  const vite_git = await fs.readFile(vite_git_path, "utf-8");
+
+  await fs.writeFile(vite_git_path, vite_git + "\n" + fm_git);
+
+  // extraindo o HTML
+  const html = await fs.readFile(path.join(fm_path, "index.html"), "utf-8");
+
+  const text = html
+    .replace(/<script[\s\S]*?<\/script>/gi, "")
+    .replace(/<style[\s\S]*?<\/style>/gi, "")
+    .replace(/<[^>]+>/g, "\n")
+    .replace(/\n+/g, "\n")
+    .trim();
+
+  await fs.writeFile(path.join(vite_path, "text-content-txt"), text);
+
+  // instalando node_modules
+  await execa("npm", ["install"], {
+    cwd: vite_path,
+    stdio: "inherit",
+  });
+}
+
+run();

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "fm-starter-cli",
+  "version": "1.0.0",
+  "description": "CLI que automatiza a criação de um projeto React com Vite a partir de um desafio do Frontend Mentor, copiando e organizando automaticamente os arquivos necessários dentro da nova estrutura.",
+  "author": "Arthur Gehlen",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "fm-starter-cli": "fm-starter-cli.js"
+  },
+  "files": [
+    "fm-starter-cli.js"
+  ],
+  "scripts": {},
+  "dependencies": {
+    "execa": "^9.6.1",
+    "fs-extra": "^11.3.3"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}