create-tririga-react-ts-vite-app 1.0.0 → 1.0.3

package/README.md

@@ -1,28 +1,28 @@
-# create-pb-tririga-react-app
-
-A CLI tool to scaffold modern TRIRIGA UX applications using React, TypeScript, and Vite.
-
-## Usage
-
-You don't need to install this package locally. You can run it directly using `npx` and replace `my-tririga-app` with your desired app name:
-
-```bash
-npx create-pb-tririga-react-app my-tririga-app
-```
-
-## Features
-
-- **Framework**: React 18 + TypeScript
-- **Build Tool**: Vite (Fast HMR & Bundling)
-- **UI Library**: ShadCN
-- **Routing**: HashRouter (Compatible with TRIRIGA context paths)
-- **Deployment**: Ready-to-use scripts for `tri-deploy`
-
-## Getting Started with your new app
-
-Once created:
-
-1. `cd my-tririga-app`
-2. Install pnpm `npm install -g pnpm`
-3. Install dependencies `pnpm install`
+# create-pb-tririga-react-app
+
+A CLI tool to scaffold modern TRIRIGA UX applications using React, TypeScript, and Vite.
+
+## Usage
+
+You don't need to install this package locally. You can run it directly using `npx` and replace `my-tririga-app` with your desired app name:
+
+```bash
+npx create-pb-tririga-react-app my-tririga-app
+```
+
+## Features
+
+- **Framework**: React 18 + TypeScript
+- **Build Tool**: Vite (Fast HMR & Bundling)
+- **UI Library**: ShadCN
+- **Routing**: HashRouter (Compatible with TRIRIGA context paths)
+- **Deployment**: Ready-to-use scripts for `tri-deploy`
+
+## Getting Started with your new app
+
+Once created:
+
+1. `cd my-tririga-app`
+2. Install pnpm `npm install -g pnpm`
+3. Install dependencies `pnpm install`
 4. Make your first deployment with `pnpm run build:deploy`

package/index.js

@@ -1,138 +1,138 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const path = require('path');
-const readline = require('readline');
-
-// 1. Get project name from command line
-const projectName = process.argv[2] || 'my-tririga-app';
-const currentDir = process.cwd();
-const projectDir = path.join(currentDir, projectName);
-
-// 2. Create Directory
-if (fs.existsSync(projectDir)) {
-  console.error(`Directory ${projectName} already exists.`);
-  process.exit(1);
-}
-fs.mkdirSync(projectDir);
-
-// 3. Copy Template Files
-const templateDir = path.join(__dirname, 'template');
-
-function copyRecursiveSync(src, dest) {
-  const exists = fs.existsSync(src);
-  const stats = exists && fs.statSync(src);
-  const isDirectory = exists && stats.isDirectory();
-
-  if (isDirectory) {
-    fs.mkdirSync(dest, { recursive: true });
-    fs.readdirSync(src).forEach(childItemName => {
-      copyRecursiveSync(path.join(src, childItemName), path.join(dest, childItemName));
-    });
-  } else {
-    fs.copyFileSync(src, dest);
-  }
-}
-
-copyRecursiveSync(templateDir, projectDir);
-
-// Rename _gitignore to .gitignore
-const gitignorePath = path.join(projectDir, '_gitignore');
-if (fs.existsSync(gitignorePath)) {
-  fs.renameSync(gitignorePath, path.join(projectDir, '.gitignore'));
-}
-
-// Helper function for user prompts
-function askQuestion(query, hidden = false) {
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-
-  if (hidden) {
-    let stdinListener = (char) => {
-      char = char + '';
-      switch (char) {
-        case '\n':
-        case '\r':
-        case '\u0004':
-          process.stdin.removeListener('data', stdinListener);
-          break;
-        default:
-          process.stdout.write('\x1B[2K\x1B[200D' + query + Array(rl.line.length + 1).join('*'));
-          break;
-      }
-    };
-    process.stdin.on('data', stdinListener);
-  }
-
-  return new Promise((resolve) => rl.question(query, (ans) => {
-    rl.close();
-    if (hidden) console.log(); // Add newline after hidden input
-    resolve(ans);
-  }));
-}
-
-async function configureApp() {
-  console.log('\n--- Configuration Setup ---\n');
-
-  const triUrl = await askQuestion('TRIRIGA Environment URL (e.g., https://your-tririga-server.com): ');
-  const triUser = await askQuestion('TRIRIGA Username: ');
-  const triPassword = await askQuestion('TRIRIGA Password: ', true);
-  const appTitle = await askQuestion('App Title (e.g., TRIRIGA Service Request): ');
-  const appExposedName = await askQuestion('Application Exposed Name (e.g., myTririgaApp): ');
-  const modelAndView = await askQuestion('Model and View Name (e.g., myTririgaApp): ');
-  const webViewMetadataName = await askQuestion(`Web View Metadata Exposed Name (default: ${projectName}): `);
-
-  const finalWebViewName = webViewMetadataName || projectName;
-
-  // 4. Update package.json name with Web View Metadata Exposed Name
-  const pkgJsonPath = path.join(projectDir, 'package.json');
-  const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf8'));
-  pkgJson.name = finalWebViewName;
-  fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
-
-  // 5. Update .env file
-  const envExamplePath = path.join(projectDir, '.env.example');
-  const envPath = path.join(projectDir, '.env');
-  if (fs.existsSync(envExamplePath)) {
-    let envContent = fs.readFileSync(envExamplePath, 'utf8');
-    envContent = envContent.replace(/TRI_URL=.*/g, `TRI_URL=${triUrl}`);
-    envContent = envContent.replace(/TRI_USER=.*/g, `TRI_USER=${triUser}`);
-    envContent = envContent.replace(/TRI_PASSWORD=.*/g, `TRI_PASSWORD=${triPassword}`);
-    fs.writeFileSync(envPath, envContent);
-    // Delete .env.example
-    fs.unlinkSync(envExamplePath);
-  }
-
-  // 6. Update tririgaService.ts
-  const tririgaServicePath = path.join(projectDir, 'src', 'services', 'tririgaService.ts');
-  if (fs.existsSync(tririgaServicePath)) {
-    let tsContent = fs.readFileSync(tririgaServicePath, 'utf8');
-    tsContent = tsContent.replace(/modelAndView:\s*"[^"]*"/, `modelAndView: "${modelAndView}"`);
-    tsContent = tsContent.replace(/appExposedName:\s*"[^"]*"/, `appExposedName: "${appExposedName}"`);
-    fs.writeFileSync(tririgaServicePath, tsContent);
-  }
-
-  // 7. Update vite.config.ts base path
-  const viteConfigPath = path.join(projectDir, 'vite.config.ts');
-  if (fs.existsSync(viteConfigPath)) {
-    let viteContent = fs.readFileSync(viteConfigPath, 'utf8');
-    // Regex matches the whole base line and replaces it, handling single or double quotes
-    viteContent = viteContent.replace(/base:\s*['"]\/app\/[^/]+\/['"],/, `base: '/app/${appExposedName}/',`);
-    fs.writeFileSync(viteConfigPath, viteContent);
-  }
-
-  // 8. Update index.html Title
-  const indexHtmlPath = path.join(projectDir, 'index.html');
-  if (fs.existsSync(indexHtmlPath) && appTitle) {
-    let htmlContent = fs.readFileSync(indexHtmlPath, 'utf8');
-    htmlContent = htmlContent.replace(/<title>.*<\/title>/, `<title>${appTitle}</title>`);
-    fs.writeFileSync(indexHtmlPath, htmlContent);
-  }
-
-  console.log(`\nSuccess! Created and configured ${projectName}.`);
-  console.log(`\nTo get started:\n  cd ${projectName}\n  npm install -g pnpm\n  pnpm install\n  pnpm run build:deploy\n`);
-}
-
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline');
+
+// 1. Get project name from command line
+const projectName = process.argv[2] || 'my-tririga-app';
+const currentDir = process.cwd();
+const projectDir = path.join(currentDir, projectName);
+
+// 2. Create Directory
+if (fs.existsSync(projectDir)) {
+  console.error(`Directory ${projectName} already exists.`);
+  process.exit(1);
+}
+fs.mkdirSync(projectDir);
+
+// 3. Copy Template Files
+const templateDir = path.join(__dirname, 'template');
+
+function copyRecursiveSync(src, dest) {
+  const exists = fs.existsSync(src);
+  const stats = exists && fs.statSync(src);
+  const isDirectory = exists && stats.isDirectory();
+
+  if (isDirectory) {
+    fs.mkdirSync(dest, { recursive: true });
+    fs.readdirSync(src).forEach(childItemName => {
+      copyRecursiveSync(path.join(src, childItemName), path.join(dest, childItemName));
+    });
+  } else {
+    fs.copyFileSync(src, dest);
+  }
+}
+
+copyRecursiveSync(templateDir, projectDir);
+
+// Rename _gitignore to .gitignore
+const gitignorePath = path.join(projectDir, '_gitignore');
+if (fs.existsSync(gitignorePath)) {
+  fs.renameSync(gitignorePath, path.join(projectDir, '.gitignore'));
+}
+
+// Helper function for user prompts
+function askQuestion(query, hidden = false) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  if (hidden) {
+    let stdinListener = (char) => {
+      char = char + '';
+      switch (char) {
+        case '\n':
+        case '\r':
+        case '\u0004':
+          process.stdin.removeListener('data', stdinListener);
+          break;
+        default:
+          process.stdout.write('\x1B[2K\x1B[200D' + query + Array(rl.line.length + 1).join('*'));
+          break;
+      }
+    };
+    process.stdin.on('data', stdinListener);
+  }
+
+  return new Promise((resolve) => rl.question(query, (ans) => {
+    rl.close();
+    if (hidden) console.log(); // Add newline after hidden input
+    resolve(ans);
+  }));
+}
+
+async function configureApp() {
+  console.log('\n--- Configuration Setup ---\n');
+
+  const triUrl = await askQuestion('TRIRIGA Environment URL (e.g., https://your-tririga-server.com): ');
+  const triUser = await askQuestion('TRIRIGA Username: ');
+  const triPassword = await askQuestion('TRIRIGA Password: ', true);
+  const appTitle = await askQuestion('App Title (e.g., TRIRIGA Service Request): ');
+  const appExposedName = await askQuestion('Application Exposed Name (e.g., myTririgaApp): ');
+  const modelAndView = await askQuestion('Model and View Name (e.g., myTririgaApp): ');
+  const webViewMetadataName = await askQuestion(`Web View Metadata Exposed Name (default: ${projectName}): `);
+
+  const finalWebViewName = webViewMetadataName || projectName;
+
+  // 4. Update package.json name with Web View Metadata Exposed Name
+  const pkgJsonPath = path.join(projectDir, 'package.json');
+  const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf8'));
+  pkgJson.name = finalWebViewName;
+  fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
+
+  // 5. Update .env file
+  const envExamplePath = path.join(projectDir, '.env.example');
+  const envPath = path.join(projectDir, '.env');
+  if (fs.existsSync(envExamplePath)) {
+    let envContent = fs.readFileSync(envExamplePath, 'utf8');
+    envContent = envContent.replace(/TRI_URL=.*/g, `TRI_URL=${triUrl}`);
+    envContent = envContent.replace(/TRI_USER=.*/g, `TRI_USER=${triUser}`);
+    envContent = envContent.replace(/TRI_PASSWORD=.*/g, `TRI_PASSWORD=${triPassword}`);
+    fs.writeFileSync(envPath, envContent);
+    // Delete .env.example
+    fs.unlinkSync(envExamplePath);
+  }
+
+  // 6. Update tririgaService.ts
+  const tririgaServicePath = path.join(projectDir, 'src', 'services', 'tririgaService.ts');
+  if (fs.existsSync(tririgaServicePath)) {
+    let tsContent = fs.readFileSync(tririgaServicePath, 'utf8');
+    tsContent = tsContent.replace(/modelAndView:\s*"[^"]*"/, `modelAndView: "${modelAndView}"`);
+    tsContent = tsContent.replace(/appExposedName:\s*"[^"]*"/, `appExposedName: "${appExposedName}"`);
+    fs.writeFileSync(tririgaServicePath, tsContent);
+  }
+
+  // 7. Update vite.config.ts base path
+  const viteConfigPath = path.join(projectDir, 'vite.config.ts');
+  if (fs.existsSync(viteConfigPath)) {
+    let viteContent = fs.readFileSync(viteConfigPath, 'utf8');
+    // Regex matches the whole base line and replaces it, handling single or double quotes
+    viteContent = viteContent.replace(/base:\s*['"]\/app\/[^/]+\/['"],/, `base: '/app/${appExposedName}/',`);
+    fs.writeFileSync(viteConfigPath, viteContent);
+  }
+
+  // 8. Update index.html Title
+  const indexHtmlPath = path.join(projectDir, 'index.html');
+  if (fs.existsSync(indexHtmlPath) && appTitle) {
+    let htmlContent = fs.readFileSync(indexHtmlPath, 'utf8');
+    htmlContent = htmlContent.replace(/<title>.*<\/title>/, `<title>${appTitle}</title>`);
+    fs.writeFileSync(indexHtmlPath, htmlContent);
+  }
+
+  console.log(`\nSuccess! Created and configured ${projectName}.`);
+  console.log(`\nTo get started:\n  cd ${projectName}\n  npm install -g pnpm\n  pnpm install\n  pnpm run build:deploy\n`);
+}
+
 configureApp();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-tririga-react-ts-vite-app",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Scaffold a TRIRIGA React app with Vite and TypeScript",
   "main": "index.js",
   "bin": {
@@ -17,6 +17,10 @@
     "vite",
     "scaffold"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nrichard1/create-tririga-react-ts-vite-app.git"
+  },
   "author": "Noah Richard",
   "license": "ISC"
 }

package/template/.env.example

@@ -1,14 +1,14 @@
-# Local Development Config
-VITE_TRIRIGA_URL=http://localhost:8001
-VITE_INSTANCE_ID=-1
-VITE_CONTEXT_PATH=/app
-VITE_MODEL_AND_VIEW=devView
-VITE_BASE_PATH=/app/devView
-VITE_EXPOSED_NAME=devView
-VITE_SSO=false
-VITE_AUTO_LOGIN=true
-
-# Deployment Config (used by tri-deploy)
-TRI_URL=https://your-tririga-server.com
-TRI_USER=your-username
-TRI_PASSWORD=your-password
+# Local Development Config
+VITE_TRIRIGA_URL=http://localhost:8001
+VITE_INSTANCE_ID=-1
+VITE_CONTEXT_PATH=/app
+VITE_MODEL_AND_VIEW=devView
+VITE_BASE_PATH=/app/devView
+VITE_EXPOSED_NAME=devView
+VITE_SSO=false
+VITE_AUTO_LOGIN=true
+
+# Deployment Config (used by tri-deploy)
+TRI_URL=https://your-tririga-server.com
+TRI_USER=your-username
+TRI_PASSWORD=your-password

package/template/README.md

@@ -1,73 +1,73 @@
-# TRIRIGA React App Template
-
-This is a template for building IBM TRIRIGA UX applications using React, TypeScript, and Vite.
-
-## Getting Started
-
-1.  **Install pnpm** (If not already installed)
-    ```
-    npm install -g pnpm
-    ```
-
-2.  **Install Dependencies**
-    ```
-    pnpm install
-    ```
-    
-
-## Deployment
-
-To deploy to a TRIRIGA environment:
-
-1.  **Install Depoyment Tool** (If not already installed globally)
-    ```
-    npm install -g @tririga/tri-deploy
-    ```
-    *Note: If you prefer not to install globally, you can add `@tririga/tri-deploy` to your devDependencies.*
-
-2.  **Configure Credentials**
-    Copy `.env.example` to `.env` and update the values for your deployment settings.
-    ```
-    cp .env.example .env
-    ```
-    Ensure your `.env` file has the correct `TRI_URL`, `TRI_USER`, and `TRI_PASSWORD`.
-
-3.  **Configure tririgaService.js file**
-    Update the TriAppConfig values `modelAndView` and `appExposedName` to match your app configuration in TRIRIGA.
-    Example: 
-    `modelAndView: "myTririgaApp",`
-    `appExposedName: "myTririgaApp",`
-
-4.  **Configure vite.config.ts file**
-    Update the base value to match your application's exposed name in TRIRIGA. 
-    Example: 
-    base: '/app/myReactApp/',
-
-5.  **Configure package.json**
-    "name": "my-tririga-app",
-
-    *Note: the name should match your Web View Metadata Exposed Name n TRIRIGA*
-
-6.  **Run Deployment**
-    The view name will be taken from the `name` field in `package.json`.
-    ```
-    pnpm run build:deploy
-    ```
-
-## Browser Support & Polyfills
-
-## Project Structure
-
--   `src/components`: Reusable UI components.
--   `src/pages`: Top-level page definitions (routes).
--   `src/model`: TRIRIGA AppModel (Datasources).
--   `src/services`: API services (Auth, Config).
--   `public/tri-app-config.json`: Local development configuration mocking the server response.
-
-## Tech Stack
-
--   [React](https://react.dev/)
--   [TypeScript](https://www.typescriptlang.org/)
--   [Vite](https://vitejs.dev/)
--   [Carbon Design System](https://carbondesignsystem.com/)
--   [@tririga/tririga-react-components](https://www.npmjs.com/package/@tririga/tririga-react-components)
+# TRIRIGA React App Template
+
+This is a template for building IBM TRIRIGA UX applications using React, TypeScript, and Vite.
+
+## Getting Started
+
+1.  **Install pnpm** (If not already installed)
+    ```
+    npm install -g pnpm
+    ```
+
+2.  **Install Dependencies**
+    ```
+    pnpm install
+    ```
+    
+
+## Deployment
+
+To deploy to a TRIRIGA environment:
+
+1.  **Install Depoyment Tool** (If not already installed globally)
+    ```
+    npm install -g @tririga/tri-deploy
+    ```
+    *Note: If you prefer not to install globally, you can add `@tririga/tri-deploy` to your devDependencies.*
+
+2.  **Configure Credentials**
+    Copy `.env.example` to `.env` and update the values for your deployment settings.
+    ```
+    cp .env.example .env
+    ```
+    Ensure your `.env` file has the correct `TRI_URL`, `TRI_USER`, and `TRI_PASSWORD`.
+
+3.  **Configure tririgaService.js file**
+    Update the TriAppConfig values `modelAndView` and `appExposedName` to match your app configuration in TRIRIGA.
+    Example: 
+    `modelAndView: "myTririgaApp",`
+    `appExposedName: "myTririgaApp",`
+
+4.  **Configure vite.config.ts file**
+    Update the base value to match your application's exposed name in TRIRIGA. 
+    Example: 
+    base: '/app/myReactApp/',
+
+5.  **Configure package.json**
+    "name": "my-tririga-app",
+
+    *Note: the name should match your Web View Metadata Exposed Name n TRIRIGA*
+
+6.  **Run Deployment**
+    The view name will be taken from the `name` field in `package.json`.
+    ```
+    pnpm run build:deploy
+    ```
+
+## Browser Support & Polyfills
+
+## Project Structure
+
+-   `src/components`: Reusable UI components.
+-   `src/pages`: Top-level page definitions (routes).
+-   `src/model`: TRIRIGA AppModel (Datasources).
+-   `src/services`: API services (Auth, Config).
+-   `public/tri-app-config.json`: Local development configuration mocking the server response.
+
+## Tech Stack
+
+-   [React](https://react.dev/)
+-   [TypeScript](https://www.typescriptlang.org/)
+-   [Vite](https://vitejs.dev/)
+-   [Carbon Design System](https://carbondesignsystem.com/)
+-   [@tririga/tririga-react-components](https://www.npmjs.com/package/@tririga/tririga-react-components)

package/template/_gitignore

@@ -1,26 +1,26 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
-
-node_modules
-dist
-dist-ssr
-*.local
-.env
-ux-work-task-form
-
-# Editor directories and files
-.vscode/*
-!.vscode/extensions.json
-.idea
-.DS_Store
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+.env
+ux-work-task-form
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

package/template/index.html

@@ -1,13 +1,13 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Tririga React App</title>
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
-  </body>
-</html>
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Tririga React App</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>