@squeditor/squeditor-framework 1.0.0 → 1.0.2

package/README.md

@@ -45,21 +45,16 @@ Every project includes an automatically generated `style-guide.php` page that re
 
 ## 🏁 Getting Started
 
-### 1. Installation
-Clone the repository into your desired workspace folder. This folder will house both the framework and your generated projects:
-```bash
-git clone https://github.com/unistudioco/squeditor-framework.git
-```
-
-### 2. Scaffold a New Project
-Squeditor includes a robust CLI scaffolding tool. It generates a completely clean, minimalist `project-template/` instance next to the core framework, fully pre-configured to utilize the advanced GSAP and UIKit engines without demo bloat.
+### 1. Scaffold a New Project
+Squeditor includes a robust CLI scaffolding tool. It generates a completely clean, minimalist project instance fully pre-configured to utilize the advanced GSAP and UIKit engines without demo bloat.
 
-To scaffold your new project as a sibling to the framework directory, run the following command from your workspace root (outside `squeditor-framework`):
+To scaffold your new project, simply run the following command in your terminal:
 ```bash
-npx squeditor-framework your-project-name
+npx @squeditor/squeditor-framework your-project-name
 ```
+*(Replace `your-project-name` with your desired folder name).*
 
-### 3. Development
+### 2. Development
 Navigate into your newly generated project folder, install its dependencies, and start the development server:
 ```bash
 cd your-project-name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squeditor/squeditor-framework",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Squeditor Framework is a high-performance, developer-first framework for building lightning-fast, static websites. It combines the power of PHP-style templating with the modern performance of Tailwind CSS, the interactivity of UIKit 3, and the speed of Vite.",
   "main": "index.js",
   "publishConfig": {
@@ -31,6 +31,6 @@
   },
   "homepage": "https://github.com/unistudioco/squeditor-framework#readme",
   "bin": {
-    "squeditor": "./scripts/scaffold.js"
+    "@squeditor/squeditor-framework": "./scripts/scaffold.js"
   }
 }

package/scripts/scaffold.js

@@ -26,17 +26,17 @@ if (fs.existsSync(targetDir)) {
     process.exit(1);
 }
 
-function copyDirectory(src, dest) {
+function copyDirectory(src, dest, ignoreList = []) {
     fs.mkdirSync(dest, { recursive: true });
     const entries = fs.readdirSync(src, { withFileTypes: true });
 
     for (const entry of entries) {
-        if (entry.name === '.DS_Store') continue;
+        if (entry.name === '.DS_Store' || ignoreList.includes(entry.name)) continue;
         const srcPath = path.join(src, entry.name);
         const destPath = path.join(dest, entry.name);
 
         if (entry.isDirectory()) {
-            copyDirectory(srcPath, destPath);
+            copyDirectory(srcPath, destPath, ignoreList);
         } else {
             // Must use copyFileSync to preserve binary data (fonts, images)
             fs.copyFileSync(srcPath, destPath);
@@ -45,6 +45,18 @@ function copyDirectory(src, dest) {
 }
 
 console.log(`[Squeditor] Scaffolding new project: ${projectName}...`);
+
+// 1. Copy the framework core
+const frameworkSourceDir = path.join(__dirname, '..');
+const frameworkTargetDir = path.resolve(process.cwd(), 'squeditor-framework');
+
+if (!fs.existsSync(frameworkTargetDir)) {
+    console.log(`[Squeditor] Installing local framework core at ./squeditor-framework...`);
+    const ignoreCoreList = ['project-template', 'showcase', 'node_modules', '.git', '.github'];
+    copyDirectory(frameworkSourceDir, frameworkTargetDir, ignoreCoreList);
+}
+
+// 2. Copy the project template
 copyDirectory(sourceDir, targetDir);
 
 // Update package.json name