@solidstarters/create-solid-app 1.2.17 → 1.2.19

package/Issues.txt

@@ -0,0 +1,5 @@
+1. Keeping semver versioned packages, seems to not force the latest package version.
+2. Add launch.json, upgrade.sh as well to the newly generated repos. Find a js compatible version for upgrade.sh
+3. Fix the rebuild.sh to run the latest version of node i.e one that is running on the server
+4. Need to check how tell the server to download and run a particular version of node on the system.
+5. Also find appropriate js versions of rebuild.sh & upgrade.sh

package/helpers.js

@@ -10,11 +10,17 @@ import { fileURLToPath } from 'url';
 // Simulate __dirname
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
+export const HIDDEN_TEMPLATES_FOLDER = 'dot-templates';
+export const SOURCE_TEMPLATE_FOLDER_API = 'nest-template';
+export const SOURCE_TEMPLATE_FOLDER_UI = 'next-template';
+export const TARGET_FOLDER_API = 'solid-api';
+export const TARGET_FOLDER_UI = 'solid-ui';
+export const EXCLUDED_DIRS_FOR_INITIAL_COPY = [SOURCE_TEMPLATE_FOLDER_API, SOURCE_TEMPLATE_FOLDER_UI];
 
 export async function copyAndInstallTemplate(source, target, showLogs) {
   try {
     // Copy the source folder to the target folder
-    await copyTemplate(source, target); 
+    await copyTemplate(source, target);
 
     // Run `npm install` in the target directory
     return await installTemplate(target, showLogs);
@@ -30,30 +36,60 @@ async function installTemplate(target, showLogs) {
   return output;
 }
 
-export async function copyTemplate(source, target) {
+export async function copyTemplate(source, target, excludedDirs = []) {
   try {
-    await fs.copy(source, target);
-    // console.log(chalk.green(`Files copied from ${source} to ${target}`));
-    // Check if there is a dot-templates folder in the target
+    await handleCopy(source, target, excludedDirs);
     handleHiddenTemplateFiles(target);
   }
   catch (error) {
-    console.error(chalk.red('Error in copyTemplate:', error));
+    console.error(chalk.red(`Error in copyTemplate: for ${source} to ${target}`, error));
     throw error;
   }
 }
 
-function handleHiddenTemplateFiles(target) {
-  const dotTemplatesPath = path.join(target, 'dot-templates');
-  // move all the files from dot-templates to the target after remove .template in the file name
-  if (fs.existsSync(dotTemplatesPath)) {
-    const files = fs.readdirSync(dotTemplatesPath);
-    files.forEach(file => {
-      const newFileName = file.replace('dot.', '.').replace('.template', '');
-      fs.moveSync(path.join(dotTemplatesPath, file), path.join(target, newFileName));
-    });
-    fs.removeSync(dotTemplatesPath);
+/**
+ * Recursively copies from source to target, excluding specified directories.
+ *
+ * @param {string} source - Source directory
+ * @param {string} target - Target directory
+ * @param {string[]} excludedDirs - Relative paths (from source) to exclude
+ */
+export async function handleCopy(source, target, excludedDirs = []) {
+  await fs.copy(source, target, {
+    filter: (src) => {
+      const relativePath = path.relative(source, src);
+
+      // Always include root path (empty string)
+      if (!relativePath) return true;
+
+      // Normalize path separators for cross-platform compatibility
+      const normalizedPath = relativePath.split(path.sep).join('/');
+
+      const isExcluded = excludedDirs.some(dir =>
+        normalizedPath === dir || normalizedPath.startsWith(`${dir}/`)
+      );
+
+      return !isExcluded;
+    },
+  });
+}
+
+// Check if there is a dot-templates folder in the target
+function handleHiddenTemplateFiles(targetDir) {
+  if (!fs.lstatSync(targetDir).isDirectory()) { // If targetDir is not a directory, return
+    return;
+  }
+  const hiddenTemplatesPath = path.join(targetDir, HIDDEN_TEMPLATES_FOLDER);
+  if (!fs.existsSync(hiddenTemplatesPath)) { // If dot-templates folder does not exist, return
+    return;
   }
+  // move all the files from dot-templates to the target after remove .template in the file name
+  const files = fs.readdirSync(hiddenTemplatesPath);
+  files.forEach(file => {
+    const newFileName = file.replace('dot.', '.').replace('.template', '');
+    fs.moveSync(path.join(hiddenTemplatesPath, file), path.join(targetDir, newFileName));
+  });
+  fs.removeSync(hiddenTemplatesPath);
 }
 
 export function getSourceFolderPath(folder) {
@@ -117,6 +153,7 @@ export function getBackendEnvConfig(answers) {
       ENV: 'prod', //FIXME: preferred dev, Need to asses impact of keeping it as dev
       PORT: answers.solidApiPort,
       SOLID_APP_NAME: answers.projectName,
+      BASE_URL: `http://localhost:${answers.solidApiPort}`,
     },
     "Default DB Configuration": {
       DEFAULT_DATABASE_USER: answers.solidApiDatabaseUsername,
@@ -154,8 +191,9 @@ export function getFrontendEnvJson(answers) {
       NEXT_PUBLIC_SOLID_APP_DESCRIPTION: '',
       NEXT_PUBLIC_ENABLE_CUSTOM_HEADER_FOOTER: false,
       NEXT_PUBLIC_DEFAULT_MENU_KEY: `${answers.projectName}-tracker`,
-      NEXT_PUBLIC_SHOW_SETTINGS:false,
-      NEXT_PUBLIC_LOGIN_REDIRECT_URL:`/admin/core/solid-core/user/list`
+      NEXT_PUBLIC_SHOW_SETTINGS: false,
+      NEXT_PUBLIC_LOGIN_REDIRECT_URL: `/admin/core/solid-core/user/list`,
+      NEXT_PUBLIC_REMOTE_PATTERNS: '[{"protocol":"http","hostname":"localhost","pathname":"/media-files-storage/**"}]'
     }
   };
   return envConfig;

package/index.js

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 
 import chalk from 'chalk';
-import { copyAndInstallTemplate, generateEnvFileFromConfig, getBackendEnvConfig, getFrontendEnvJson, getSourceFolderPath, updatePackageName, installSolidAsGlobalBinary, prettyOutput, updatePortInPackageJson, copyTemplate } from './helpers.js';
+import fs from 'fs-extra';
 import inquirer from 'inquirer';
+import _ from 'lodash';
 import path from 'path';
-import fs from 'fs-extra';
+import { copyAndInstallTemplate, copyTemplate, EXCLUDED_DIRS_FOR_INITIAL_COPY, generateEnvFileFromConfig, getBackendEnvConfig, getFrontendEnvJson, getSourceFolderPath, installSolidAsGlobalBinary, prettyOutput, SOURCE_TEMPLATE_FOLDER_API, SOURCE_TEMPLATE_FOLDER_UI, TARGET_FOLDER_API, TARGET_FOLDER_UI, updatePackageName, updatePortInPackageJson } from './helpers.js';
 import { setupQuestions } from './setup-questions.js';
-import _ from 'lodash';
 
 
 async function main() {
@@ -32,26 +32,26 @@ async function main() {
         // Step 2: Setup the sub projects from the templates
         console.log(prettyOutput('Step 1','Setting up boilerplate for the backend'));
         const templatesPath = getSourceFolderPath('templates');
-        // copyTemplate(path.join(templatesPath, 'dot.templates'), targetPath);
+        await copyTemplate(templatesPath, targetPath, EXCLUDED_DIRS_FOR_INITIAL_COPY);
 
-        await copyAndInstallTemplate(path.join(templatesPath, 'nest-template'), path.join(targetPath, 'solid-api'), showLogs);
+        await copyAndInstallTemplate(path.join(templatesPath, SOURCE_TEMPLATE_FOLDER_API), path.join(targetPath, TARGET_FOLDER_API), showLogs);
         
         console.log(prettyOutput('Step 2','Installing solid binary globally'));
-        const ignore = await installSolidAsGlobalBinary(path.join(targetPath, 'solid-api'), showLogs);
+        await installSolidAsGlobalBinary(path.join(targetPath, TARGET_FOLDER_API), showLogs);
 
         console.log(prettyOutput('Step 3',`Setting up boilerplate for the frontend`));
-        await copyAndInstallTemplate(path.join(templatesPath, 'next-template'), path.join(targetPath, 'solid-ui'), showLogs);
+        await copyAndInstallTemplate(path.join(templatesPath, SOURCE_TEMPLATE_FOLDER_UI), path.join(targetPath, TARGET_FOLDER_UI), showLogs);
 
         // Step 3: Update project package json details
-        updatePackageName(targetPath, 'solid-ui', `@${projectName}/solid-ui`);
-        updatePackageName(targetPath, 'solid-api', `@${projectName}/solid-api`);
-        updatePortInPackageJson(targetPath, 'solid-ui', answers.solidUiPort);
+        updatePackageName(targetPath, TARGET_FOLDER_UI, `@${projectName}/${TARGET_FOLDER_UI}`);
+        updatePackageName(targetPath, TARGET_FOLDER_API, `@${projectName}/${TARGET_FOLDER_API}`);
+        updatePortInPackageJson(targetPath, TARGET_FOLDER_UI, answers.solidUiPort);
 
         // Step 4: Generate the .env files for backend and frontend
-        const backendPath = path.join(targetPath, 'solid-api');
+        const backendPath = path.join(targetPath, TARGET_FOLDER_API);
         console.log(prettyOutput('Step 4',`Generating .env file for the backend at ${chalk.cyan(backendPath)}`));
         generateEnvFileFromConfig(backendPath, getBackendEnvConfig(answers));
-        const frontendPath = path.join(targetPath, 'solid-ui');
+        const frontendPath = path.join(targetPath, TARGET_FOLDER_UI);
         console.log(prettyOutput('Step 5',`Generating .env file for the frontend at ${chalk.cyan(frontendPath)}`));
         generateEnvFileFromConfig(frontendPath, getFrontendEnvJson(answers));
 
@@ -60,14 +60,11 @@ async function main() {
         console.log(chalk.cyan(`\nEnsure the database is created and connection is established correctly.`));
         console.log(chalk.cyan(`\nNext steps:`));
         console.log(chalk.cyan(`Run the api:`));
-        console.log(prettyOutput('',`cd ${projectName}/solid-api`));
+        console.log(prettyOutput('',`cd ${projectName}/${TARGET_FOLDER_API}`));
         console.log(prettyOutput('','solid seed','This will seed the database with the required metadata'));
 
         // Development mode (with watch )
-        console.log(prettyOutput('', 'npm run start:dev', `Starts the backend in development mode with live reload on @http://localhost:${answers.solidApiPort}`));
-
-        // Development mode (debug)
-        console.log(prettyOutput('', 'npm run start:debug', `Starts the backend in development mode with debugging on @http://localhost:${answers.solidApiPort}`));
+        console.log(prettyOutput('', 'npm run solidx:dev', `Starts the backend in development mode with live reload on @http://localhost:${answers.solidApiPort}`));
 
         // Production mode
         console.log(prettyOutput('', 'npm run start', `Starts the backend in production mode on @http://localhost:${answers.solidApiPort}`));
@@ -76,7 +73,7 @@ async function main() {
 
         // console.log(prettyOutput('','npm run start',`This will start the backend server @http://localhost:${answers.solidApiPort}`));
         console.log(chalk.cyan(`\nRun the frontend:`));
-        console.log(prettyOutput('',`cd ${projectName}/solid-ui`));
+        console.log(prettyOutput('',`cd ${projectName}/${TARGET_FOLDER_UI}`));
         console.log(prettyOutput('','npm run dev',`This will start the frontend server @http://localhost:${answers.solidUiPort}`));
     }
     catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidstarters/create-solid-app",
-  "version": "1.2.17",
+  "version": "1.2.19",
   "main": "index.js",
   "private": false,
   "publishConfig": {

package/templates/dot-templates/dot.vscode.template/launch.json

@@ -0,0 +1,35 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug solid-api",
+            "args": [
+                "${workspaceFolder}/solid-api/src/main.ts"
+            ],
+            "runtimeArgs": [
+                "--nolazy",
+                "-r",
+                "ts-node/register",
+                "-r",
+                "tsconfig-paths/register"
+            ],
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceFolder}/dist/**/*.js",
+                "${workspaceFolder}/solid-api/node_modules/@solidstarters/solid-core-module/dist/**/*.js"
+            ],
+            "resolveSourceMapLocations": [
+                "${workspaceFolder}/**",
+                "${workspaceFolder}/solid-api/node_modules/@solidstarters/solid-core/**"
+            ],
+            "cwd": "${workspaceFolder}/solid-api",
+            "console": "integratedTerminal",
+            "autoAttachChildProcesses": true
+        },
+    ]
+}

package/templates/nest-template/dot-templates/dot.gitignore.template

@@ -50,3 +50,6 @@ pids
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+media-uploads
+media-files-storage

package/templates/nest-template/nodemon.json

@@ -0,0 +1,13 @@
+{
+    "watch": [
+        "src"
+    ],
+    "ext": "ts,json",
+    "ignore": [
+        "src/**/*.spec.ts",
+        "dist",
+        "node_modules"
+    ],
+    "delay": 2000,
+    "exec": "ts-node -r tsconfig-paths/register src/main.ts"
+}