skuilder 0.1.1 → 0.1.3

package/src/utils/template.ts

@@ -0,0 +1,215 @@
+import { promises as fs } from 'fs';
+import { existsSync } from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import chalk from 'chalk';
+import { ProjectConfig, SkuilderConfig } from '../types.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+/**
+ * Find the standalone-ui package in node_modules
+ */
+export async function findStandaloneUiPath(): Promise<string> {
+  // Start from CLI package root and work upward
+  let currentDir = path.join(__dirname, '..', '..');
+  
+  while (currentDir !== path.dirname(currentDir)) {
+    const nodeModulesPath = path.join(currentDir, 'node_modules', '@vue-skuilder', 'standalone-ui');
+    if (existsSync(nodeModulesPath)) {
+      return nodeModulesPath;
+    }
+    currentDir = path.dirname(currentDir);
+  }
+  
+  throw new Error('Could not find @vue-skuilder/standalone-ui package. Please ensure it is installed.');
+}
+
+/**
+ * Copy directory recursively, excluding certain files/directories
+ */
+export async function copyDirectory(
+  source: string,
+  destination: string,
+  excludePatterns: string[] = ['node_modules', 'dist', '.git', 'cypress']
+): Promise<void> {
+  const entries = await fs.readdir(source, { withFileTypes: true });
+  
+  await fs.mkdir(destination, { recursive: true });
+  
+  for (const entry of entries) {
+    const sourcePath = path.join(source, entry.name);
+    const destPath = path.join(destination, entry.name);
+    
+    // Skip excluded patterns
+    if (excludePatterns.some(pattern => entry.name.includes(pattern))) {
+      continue;
+    }
+    
+    if (entry.isDirectory()) {
+      await copyDirectory(sourcePath, destPath, excludePatterns);
+    } else {
+      await fs.copyFile(sourcePath, destPath);
+    }
+  }
+}
+
+/**
+ * Transform package.json to use published dependencies instead of workspace references
+ */
+export async function transformPackageJson(
+  packageJsonPath: string,
+  projectName: string,
+  cliVersion: string
+): Promise<void> {
+  const content = await fs.readFile(packageJsonPath, 'utf-8');
+  const packageJson = JSON.parse(content);
+  
+  // Update basic project info
+  packageJson.name = projectName;
+  packageJson.description = `Skuilder course application: ${projectName}`;
+  packageJson.version = '1.0.0';
+  
+  // Transform workspace dependencies to published versions
+  if (packageJson.dependencies) {
+    for (const [depName, version] of Object.entries(packageJson.dependencies)) {
+      if (typeof version === 'string' && version.startsWith('workspace:')) {
+        // Replace workspace references with CLI's version
+        packageJson.dependencies[depName] = `^${cliVersion}`;
+      }
+    }
+  }
+  
+  // Remove CLI-specific fields that don't belong in generated projects
+  delete packageJson.publishConfig;
+  
+  await fs.writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2));
+}
+
+/**
+ * Generate skuilder.config.json based on project configuration
+ */
+export async function generateSkuilderConfig(
+  configPath: string,
+  config: ProjectConfig
+): Promise<void> {
+  const skuilderConfig: SkuilderConfig = {
+    title: config.title,
+    dataLayerType: config.dataLayerType
+  };
+  
+  if (config.course) {
+    skuilderConfig.course = config.course;
+  }
+  
+  if (config.couchdbUrl) {
+    skuilderConfig.couchdbUrl = config.couchdbUrl;
+  }
+  
+  if (config.theme) {
+    skuilderConfig.theme = config.theme;
+  }
+  
+  await fs.writeFile(configPath, JSON.stringify(skuilderConfig, null, 2));
+}
+
+/**
+ * Generate project README.md
+ */
+export async function generateReadme(
+  readmePath: string,
+  config: ProjectConfig
+): Promise<void> {
+  const dataLayerInfo = config.dataLayerType === 'static' 
+    ? 'This project uses a static data layer with JSON files.'
+    : `This project connects to CouchDB at: ${config.couchdbUrl || '[URL not specified]'}`;
+    
+  const readme = `# ${config.title}
+
+A Skuilder course application built with Vue 3, Vuetify, and Pinia.
+
+## Data Layer
+
+${dataLayerInfo}
+
+## Development
+
+Install dependencies:
+\`\`\`bash
+npm install
+\`\`\`
+
+Start the development server:
+\`\`\`bash
+npm run dev
+\`\`\`
+
+Build for production:
+\`\`\`bash
+npm run build
+\`\`\`
+
+## Configuration
+
+Course configuration is managed in \`skuilder.config.json\`. You can modify:
+- Course title
+- Data layer settings
+- Theme customization
+- Database connection details (for dynamic data layer)
+
+## Theme
+
+Current theme: **${config.theme.name}**
+- Primary: ${config.theme.colors.primary}
+- Secondary: ${config.theme.colors.secondary}  
+- Accent: ${config.theme.colors.accent}
+
+## Testing
+
+Run end-to-end tests:
+\`\`\`bash
+npm run test:e2e
+\`\`\`
+
+Run tests in headless mode:
+\`\`\`bash
+npm run test:e2e:headless
+\`\`\`
+
+## Learn More
+
+Visit the [Skuilder documentation](https://github.com/NiloCK/vue-skuilder) for more information about building course applications.
+`;
+
+  await fs.writeFile(readmePath, readme);
+}
+
+/**
+ * Copy and transform the standalone-ui template to create a new project
+ */
+export async function processTemplate(
+  projectPath: string,
+  config: ProjectConfig,
+  cliVersion: string
+): Promise<void> {
+  console.log(chalk.blue('📦 Locating standalone-ui template...'));
+  const templatePath = await findStandaloneUiPath();
+  
+  console.log(chalk.blue('📂 Copying project files...'));
+  await copyDirectory(templatePath, projectPath);
+  
+  console.log(chalk.blue('⚙️  Configuring package.json...'));
+  const packageJsonPath = path.join(projectPath, 'package.json');
+  await transformPackageJson(packageJsonPath, config.projectName, cliVersion);
+  
+  console.log(chalk.blue('🔧 Generating configuration...'));
+  const configPath = path.join(projectPath, 'skuilder.config.json');
+  await generateSkuilderConfig(configPath, config);
+  
+  console.log(chalk.blue('📝 Creating README...'));
+  const readmePath = path.join(projectPath, 'README.md');
+  await generateReadme(readmePath, config);
+  
+  console.log(chalk.green('✅ Template processing complete!'));
+}

package/tsconfig.json

@@ -1,27 +1,18 @@
 {
-  "exclude": [
-    "node_modules"
-  ],
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "declaration": false,
-    "noResolve": false,
-    "jsx": "react",
-    "reactNamespace": "RX",
-    "module": "commonjs",
-    "target": "es5",
-    "experimentalDecorators": true,
-    "sourceMap": true,
-    "noImplicitAny": true,
-    "noImplicitReturns": true,
-    "outDir": "./dist/",
-    "types": [
-      "node"
-    ]
-  },
-  "typeAcquisition": {
-    "enable": true
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "dist",
+    "rootDir": "src",
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": false
   },
   "include": [
-    "./src/**/*"
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
   ]
 }

package/.npmignore

@@ -1,56 +0,0 @@
-# OSX
-#
-.DS_Store
-
-# Xcode
-#
-build/
-*.pbxuser
-!default.pbxuser
-*.mode1v3
-!default.mode1v3
-*.mode2v3
-!default.mode2v3
-*.perspectivev3
-!default.perspectivev3
-xcuserdata
-*.xccheckout
-*.moved-aside
-DerivedData
-*.hmap
-*.ipa
-*.xcuserstate
-project.xcworkspace
-
-# Android/IntelliJ
-#
-build/
-.idea
-.gradle
-local.properties
-*.iml
-
-# node.js
-#
-node_modules/
-npm-debug.log
-yarn-error.log
-
-# BUCK
-buck-out/
-\.buckd/
-*.keystore
-
-# fastlane
-#
-# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
-# screenshots whenever they are needed.
-# For more information about the recommended setup visit:
-# https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Gitignore.md
-
-fastlane/report.xml
-fastlane/Preview.html
-fastlane/screenshots
-
-.vscode
-dist/

package/android/app/BUCK

@@ -1,65 +0,0 @@
-# To learn about Buck see [Docs](https://buckbuild.com/).
-# To run your application with Buck:
-# - install Buck
-# - `npm start` - to start the packager
-# - `cd android`
-# - `keytool -genkey -v -keystore keystores/debug.keystore -storepass android -alias androiddebugkey -keypass android -dname "CN=Android Debug,O=Android,C=US"`
-# - `./gradlew :app:copyDownloadableDepsToLibs` - make all Gradle compile dependencies available to Buck
-# - `buck install -r android/app` - compile, install and run application
-#
-
-lib_deps = []
-
-for jarfile in glob(['libs/*.jar']):
-  name = 'jars__' + jarfile[jarfile.rindex('/') + 1: jarfile.rindex('.jar')]
-  lib_deps.append(':' + name)
-  prebuilt_jar(
-    name = name,
-    binary_jar = jarfile,
-  )
-
-for aarfile in glob(['libs/*.aar']):
-  name = 'aars__' + aarfile[aarfile.rindex('/') + 1: aarfile.rindex('.aar')]
-  lib_deps.append(':' + name)
-  android_prebuilt_aar(
-    name = name,
-    aar = aarfile,
-  )
-
-android_library(
-    name = "all-libs",
-    exported_deps = lib_deps,
-)
-
-android_library(
-    name = "app-code",
-    srcs = glob([
-        "src/main/java/**/*.java",
-    ]),
-    deps = [
-        ":all-libs",
-        ":build_config",
-        ":res",
-    ],
-)
-
-android_build_config(
-    name = "build_config",
-    package = "com.rxphelloworld",
-)
-
-android_resource(
-    name = "res",
-    package = "com.rxphelloworld",
-    res = "src/main/res",
-)
-
-android_binary(
-    name = "app",
-    keystore = "//android/keystores:debug",
-    manifest = "src/main/AndroidManifest.xml",
-    package_type = "debug",
-    deps = [
-        ":app-code",
-    ],
-)

package/android/app/build.gradle

@@ -1,139 +0,0 @@
-apply plugin: "com.android.application"
-
-import com.android.build.OutputFile
-
-/**
- * The react.gradle file registers a task for each build variant (e.g. bundleDebugJsAndAssets
- * and bundleReleaseJsAndAssets).
- * These basically call `react-native bundle` with the correct arguments during the Android build
- * cycle. By default, bundleDebugJsAndAssets is skipped, as in debug/dev mode we prefer to load the
- * bundle directly from the development server. Below you can see all the possible configurations
- * and their defaults. If you decide to add a configuration block, make sure to add it before the
- * `apply from: "../../node_modules/react-native/react.gradle"` line.
- *
- * project.ext.react = [
- *   // the name of the generated asset file containing your JS bundle
- *   bundleAssetName: "index.android.bundle",
- *
- *   // the entry file for bundle generation
- *   entryFile: "index.android.js",
- *
- *   // whether to bundle JS and assets in debug mode
- *   bundleInDebug: false,
- *
- *   // whether to bundle JS and assets in release mode
- *   bundleInRelease: true,
- *
- *   // whether to bundle JS and assets in another build variant (if configured).
- *   // See http://tools.android.com/tech-docs/new-build-system/user-guide#TOC-Build-Variants
- *   // The configuration property can be in the following formats
- *   //         'bundleIn${productFlavor}${buildType}'
- *   //         'bundleIn${buildType}'
- *   // bundleInFreeDebug: true,
- *   // bundleInPaidRelease: true,
- *   // bundleInBeta: true,
- *
- *   // the root of your project, i.e. where "package.json" lives
- *   root: "../../",
- *
- *   // where to put the JS bundle asset in debug mode
- *   jsBundleDirDebug: "$buildDir/intermediates/assets/debug",
- *
- *   // where to put the JS bundle asset in release mode
- *   jsBundleDirRelease: "$buildDir/intermediates/assets/release",
- *
- *   // where to put drawable resources / React Native assets, e.g. the ones you use via
- *   // require('./image.png')), in debug mode
- *   resourcesDirDebug: "$buildDir/intermediates/res/merged/debug",
- *
- *   // where to put drawable resources / React Native assets, e.g. the ones you use via
- *   // require('./image.png')), in release mode
- *   resourcesDirRelease: "$buildDir/intermediates/res/merged/release",
- *
- *   // by default the gradle tasks are skipped if none of the JS files or assets change; this means
- *   // that we don't look at files in android/ or ios/ to determine whether the tasks are up to
- *   // date; if you have any other folders that you want to ignore for performance reasons (gradle
- *   // indexes the entire tree), add them here. Alternatively, if you have JS files in android/
- *   // for example, you might want to remove it from here.
- *   inputExcludes: ["android/**", "ios/**"],
- *
- *   // override which node gets called and with what additional arguments
- *   nodeExecutableAndArgs: ["node"]
- *
- *   // supply additional arguments to the packager
- *   extraPackagerArgs: []
- * ]
- */
-
-apply from: "../../node_modules/react-native/react.gradle"
-
-/**
- * Set this to true to create two separate APKs instead of one:
- *   - An APK that only works on ARM devices
- *   - An APK that only works on x86 devices
- * The advantage is the size of the APK is reduced by about 4MB.
- * Upload all the APKs to the Play Store and people will download
- * the correct one based on the CPU architecture of their device.
- */
-def enableSeparateBuildPerCPUArchitecture = false
-
-/**
- * Run Proguard to shrink the Java bytecode in release builds.
- */
-def enableProguardInReleaseBuilds = false
-
-android {
-    compileSdkVersion 23
-    buildToolsVersion '25.0.0'
-
-    defaultConfig {
-        applicationId "com.rxphelloworld"
-        minSdkVersion 16
-        targetSdkVersion 22
-        versionCode 1
-        versionName "1.0"
-        ndk {
-            abiFilters "armeabi-v7a", "x86"
-        }
-    }
-    splits {
-        abi {
-            reset()
-            enable enableSeparateBuildPerCPUArchitecture
-            universalApk false  // If true, also generate a universal APK
-            include "armeabi-v7a", "x86"
-        }
-    }
-    buildTypes {
-        release {
-            minifyEnabled enableProguardInReleaseBuilds
-            proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"
-        }
-    }
-    // applicationVariants are e.g. debug, release
-    applicationVariants.all { variant ->
-        variant.outputs.each { output ->
-            // For each separate APK per architecture, set a unique version code as described here:
-            // http://tools.android.com/tech-docs/new-build-system/user-guide/apk-splits
-            def versionCodes = ["armeabi-v7a":1, "x86":2]
-            def abi = output.getFilter(OutputFile.ABI)
-            if (abi != null) {  // null for the universal-debug, universal-release variants
-                output.versionCodeOverride =
-                        versionCodes.get(abi) * 1048576 + defaultConfig.versionCode
-            }
-        }
-    }
-}
-
-dependencies {
-    compile fileTree(dir: "libs", include: ["*.jar"])
-    compile "com.android.support:appcompat-v7:23.0.1"
-    compile "com.facebook.react:react-native:+"  // From node_modules
-}
-
-// Run this once to be able to run the application with BUCK
-// puts all compile dependencies into folder libs for BUCK to use
-task copyDownloadableDepsToLibs(type: Copy) {
-    from configurations.compile
-    into 'libs'
-}

package/android/app/proguard-rules.pro

@@ -1,66 +0,0 @@
-# Add project specific ProGuard rules here.
-# By default, the flags in this file are appended to flags specified
-# in /usr/local/Cellar/android-sdk/24.3.3/tools/proguard/proguard-android.txt
-# You can edit the include path and order by changing the proguardFiles
-# directive in build.gradle.
-#
-# For more details, see
-#   http://developer.android.com/guide/developing/tools/proguard.html
-
-# Add any project specific keep options here:
-
-# If your project uses WebView with JS, uncomment the following
-# and specify the fully qualified class name to the JavaScript interface
-# class:
-#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
-#   public *;
-#}
-
-# Disabling obfuscation is useful if you collect stack traces from production crashes
-# (unless you are using a system that supports de-obfuscate the stack traces).
--dontobfuscate
-
-# React Native
-
-# Keep our interfaces so they can be used by other ProGuard rules.
-# See http://sourceforge.net/p/proguard/bugs/466/
--keep,allowobfuscation @interface com.facebook.proguard.annotations.DoNotStrip
--keep,allowobfuscation @interface com.facebook.proguard.annotations.KeepGettersAndSetters
--keep,allowobfuscation @interface com.facebook.common.internal.DoNotStrip
-
-# Do not strip any method/class that is annotated with @DoNotStrip
--keep @com.facebook.proguard.annotations.DoNotStrip class *
--keep @com.facebook.common.internal.DoNotStrip class *
--keepclassmembers class * {
-    @com.facebook.proguard.annotations.DoNotStrip *;
-    @com.facebook.common.internal.DoNotStrip *;
-}
-
--keepclassmembers @com.facebook.proguard.annotations.KeepGettersAndSetters class * {
-  void set*(***);
-  *** get*();
-}
-
--keep class * extends com.facebook.react.bridge.JavaScriptModule { *; }
--keep class * extends com.facebook.react.bridge.NativeModule { *; }
--keepclassmembers,includedescriptorclasses class * { native <methods>; }
--keepclassmembers class *  { @com.facebook.react.uimanager.UIProp <fields>; }
--keepclassmembers class *  { @com.facebook.react.uimanager.annotations.ReactProp <methods>; }
--keepclassmembers class *  { @com.facebook.react.uimanager.annotations.ReactPropGroup <methods>; }
-
--dontwarn com.facebook.react.**
-
-# okhttp
-
--keepattributes Signature
--keepattributes *Annotation*
--keep class okhttp3.** { *; }
--keep interface okhttp3.** { *; }
--dontwarn okhttp3.**
-
-# okio
-
--keep class sun.misc.Unsafe { *; }
--dontwarn java.nio.file.*
--dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
--dontwarn okio.**

package/android/app/src/main/AndroidManifest.xml

@@ -1,32 +0,0 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.rxphelloworld"
-    android:versionCode="1"
-    android:versionName="1.0">
-
-    <uses-permission android:name="android.permission.INTERNET" />
-    <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
-
-    <uses-sdk
-        android:minSdkVersion="16"
-        android:targetSdkVersion="22" />
-
-    <application
-      android:name=".MainApplication"
-      android:allowBackup="true"
-      android:label="@string/app_name"
-      android:icon="@mipmap/ic_launcher"
-      android:theme="@style/AppTheme">
-      <activity
-        android:name=".MainActivity"
-        android:label="@string/app_name"
-        android:configChanges="keyboard|keyboardHidden|orientation|screenSize"
-        android:windowSoftInputMode="adjustResize">
-        <intent-filter>
-            <action android:name="android.intent.action.MAIN" />
-            <category android:name="android.intent.category.LAUNCHER" />
-        </intent-filter>
-      </activity>
-      <activity android:name="com.facebook.react.devsupport.DevSettingsActivity" />
-    </application>
-
-</manifest>

package/android/app/src/main/java/com/rxphelloworld/MainActivity.java

@@ -1,15 +0,0 @@
-package com.rxphelloworld;
-
-import com.facebook.react.ReactActivity;
-
-public class MainActivity extends ReactActivity {
-
-    /**
-     * Returns the name of the main component registered from JavaScript.
-     * This is used to schedule rendering of the component.
-     */
-    @Override
-    protected String getMainComponentName() {
-        return "RXApp";
-    }
-}

package/android/app/src/main/java/com/rxphelloworld/MainApplication.java

@@ -1,40 +0,0 @@
-package com.rxphelloworld;
-
-import android.app.Application;
-
-import com.facebook.react.ReactApplication;
-import com.facebook.react.ReactNativeHost;
-import com.facebook.react.ReactPackage;
-import com.facebook.react.shell.MainReactPackage;
-import com.facebook.soloader.SoLoader;
-
-import java.util.Arrays;
-import java.util.List;
-
-public class MainApplication extends Application implements ReactApplication {
-
-  private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
-    @Override
-    public boolean getUseDeveloperSupport() {
-      return BuildConfig.DEBUG;
-    }
-
-    @Override
-    protected List<ReactPackage> getPackages() {
-      return Arrays.<ReactPackage>asList(
-          new MainReactPackage()
-      );
-    }
-  };
-
-  @Override
-  public ReactNativeHost getReactNativeHost() {
-    return mReactNativeHost;
-  }
-
-  @Override
-  public void onCreate() {
-    super.onCreate();
-    SoLoader.init(this, /* native exopackage */ false);
-  }
-}

package/android/app/src/main/res/values/strings.xml

@@ -1,3 +0,0 @@
-<resources>
-    <string name="app_name">RXPHelloWorld</string>
-</resources>