create-harper 0.0.2 → 0.0.3

package/lib/steps/scaffoldProject.js

@@ -0,0 +1,40 @@
+import * as prompts from '@clack/prompts';
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { crawlTemplateDir } from '../fs/crawlTemplateDir.js';
+
+/**
+ * Step 6: Write out the contents based on all prior steps.
+ * @param {string} targetDir
+ * @param {string} projectName
+ * @param {string} packageName
+ * @param {string} template
+ * @param {{username: string, target: string, password?: string}} envVars
+ * @returns {string} The root directory of the project
+ */
+export function scaffoldProject(targetDir, projectName, packageName, template, envVars) {
+	const cwd = process.cwd();
+	const root = path.join(cwd, targetDir);
+	fs.mkdirSync(root, { recursive: true });
+	prompts.log.step(`Scaffolding project in ${root}...`);
+
+	const substitutions = {
+		'your-project-name-here': projectName,
+		'your-package-name-here': packageName,
+		'your-cluster-username-here': envVars.username,
+		'your-cluster-password-here': envVars.password,
+		'your-fabric.harper.fast-cluster-url-here': envVars.target,
+	};
+
+	const templateDir = path.resolve(
+		fileURLToPath(import.meta.url),
+		'..',
+		'..',
+		'..',
+		`template-${template}`,
+	);
+	crawlTemplateDir(root, templateDir, substitutions);
+
+	return root;
+}

package/lib/steps/showOutro.js

@@ -0,0 +1,30 @@
+import * as prompts from '@clack/prompts';
+import path from 'node:path';
+import { install } from '../install.js';
+import { getInstallCommand } from '../pkg/getInstallCommand.js';
+import { getRunCommand } from '../pkg/getRunCommand.js';
+import { start } from '../start.js';
+
+/**
+ * Step 7: Log out the next steps.
+ * @param {string} root
+ * @param {string} pkgManager
+ * @param {boolean} immediate
+ */
+export function showOutro(root, pkgManager, immediate) {
+	if (immediate) {
+		install(root, pkgManager);
+		start(root, pkgManager);
+	} else {
+		let doneMessage = '';
+		const cwd = process.cwd();
+		const cdProjectName = path.relative(cwd, root);
+		doneMessage += `Done. Now run:\n`;
+		if (root !== cwd) {
+			doneMessage += `\n  cd ${cdProjectName.includes(' ') ? `"${cdProjectName}"` : cdProjectName}`;
+		}
+		doneMessage += `\n  ${getInstallCommand(pkgManager).join(' ')}`;
+		doneMessage += `\n  ${getRunCommand(pkgManager, 'dev').join(' ')}`;
+		prompts.outro(doneMessage);
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-harper",
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"type": "module",
 	"author": {
 		"name": "HarperDB",
@@ -13,22 +13,25 @@
 	"files": [
 		"index.js",
 		"lib/",
+		"!lib/**/*.test.js",
 		"template-barebones/",
 		"template-react/",
 		"template-react-ts/",
-		"template-shared/",
 		"template-studio/",
 		"template-studio-ts/",
 		"template-vanilla/",
 		"template-vanilla-ts/"
 	],
 	"scripts": {
-		"lint": "oxlint .",
-		"lint:fix": "oxlint . --fix",
-		"format": "dprint check",
+		"commitlint": "commitlint --edit",
+		"format:check": "dprint check",
 		"format:fix": "dprint fmt",
 		"format:staged": "dprint check --staged",
-		"test": "vitest"
+		"lint:check": "oxlint .",
+		"lint:fix": "oxlint . --fix",
+		"test": "vitest run",
+		"test:coverage": "vitest run --coverage",
+		"test:watch": "vitest"
 	},
 	"engines": {
 		"node": "^20.19.0 || >=22.12.0"
@@ -45,13 +48,14 @@
 		"@clack/prompts": "^1.0.0-alpha.9",
 		"@vercel/detect-agent": "^1.0.0",
 		"cross-spawn": "^7.0.6",
-		"lodash": "^4.17.21",
 		"mri": "^1.2.0",
 		"picocolors": "^1.1.1"
 	},
 	"devDependencies": {
+		"@commitlint/cli": "^20.0.0",
+		"@commitlint/config-conventional": "^20.0.0",
+		"@vitest/coverage-v8": "^4.0.17",
 		"dprint": "^0.51.1",
-		"harperdb": "^4.7.15",
 		"oxlint": "^1.38.0",
 		"vitest": "^4.0.17"
 	}

package/template-barebones/README.md

@@ -1,4 +1,4 @@
-# <<projectName>>
+# your-project-name-here
 
 This repository is intended for use alongside the Harper Learn ["Getting Started > Create Your First Application"](https://docs.harperdb.io/learn/getting-started/create-your-first-application) guide.
 

package/template-barebones/_env

@@ -0,0 +1,3 @@
+CLI_TARGET_USERNAME='your-cluster-username-here'
+CLI_TARGET_PASSWORD='your-cluster-password-here'
+CLI_TARGET='your-fabric.harper.fast-cluster-url-here'

package/template-barebones/_env.example

@@ -0,0 +1,3 @@
+CLI_TARGET_USERNAME='YOUR_CLUSTER_USERNAME'
+CLI_TARGET_PASSWORD='YOUR_CLUSTER_PASSWORD'
+CLI_TARGET='YOUR_FABRIC.HARPER.FAST_CLUSTER_URL_HERE'

package/template-barebones/package.json

@@ -1,5 +1,5 @@
 {
-	"name": "<<packageName>>",
+	"name": "your-package-name-here",
 	"version": "1.0.0",
 	"description": "Your new Harper app",
 	"type": "module",

package/template-react/README.md

@@ -1,4 +1,4 @@
-# <<projectName>>
+# your-project-name-here
 
 ## Installation
 

package/template-react/_aiignore

@@ -0,0 +1 @@
+.env

package/template-react/_env

@@ -0,0 +1,3 @@
+CLI_TARGET_USERNAME='your-cluster-username-here'
+CLI_TARGET_PASSWORD='your-cluster-password-here'
+CLI_TARGET='your-fabric.harper.fast-cluster-url-here'

package/template-react/_env.example

@@ -0,0 +1,3 @@
+CLI_TARGET_USERNAME='YOUR_CLUSTER_USERNAME'
+CLI_TARGET_PASSWORD='YOUR_CLUSTER_PASSWORD'
+CLI_TARGET='YOUR_FABRIC.HARPER.FAST_CLUSTER_URL_HERE'

package/template-react/_github/workflow/deploy.yaml

@@ -26,7 +26,7 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Run unit tests
-        run: npm run test
+        run: npm test
       - name: Run lint
         run: npm run lint
       - name: Build

package/template-react/_gitignore

@@ -0,0 +1,147 @@
+.DS_Store
+
+#
+# https://raw.githubusercontent.com/github/gitignore/refs/heads/main/Node.gitignore
+#
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.*
+!.env.example
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+.output
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Sveltekit cache directory
+.svelte-kit/
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Firebase cache directory
+.firebase/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v3
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Vite files
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
+.vite/

package/template-react/graphql.config.yml

@@ -0,0 +1,3 @@
+schema: schema.graphql
+include: node_modules/harperdb/schema.graphql
+documents: '**/*.graphql'

package/template-react/index.html

@@ -4,7 +4,7 @@
     <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><<projectName>></title>
+    <title>your-project-name-here</title>
   </head>
   <body>
     <div id="app"></div>

package/template-react/package.json

@@ -1,5 +1,5 @@
 {
-	"name": "<<packageName>>",
+	"name": "your-package-name-here",
 	"private": true,
 	"version": "0.0.0",
 	"type": "module",
@@ -8,7 +8,8 @@
 		"test": "echo 'No tests implemented yet'",
 		"lint": "echo 'No lint implemented yet'",
 		"build": "vite build",
-		"preview": "vite preview"
+		"preview": "vite preview",
+		"deploy": "npx -y dotenv-cli -- harperdb deploy . restart=rolling replicated=true"
 	},
 	"devDependencies": {
 		"@harperfast/vite-plugin": "^0.0.1",
@@ -16,9 +17,9 @@
 		"harperdb": "^4.7.15",
 		"react": "^19.2.3",
 		"react-dom": "^19.2.3",
-		"vite": "npm:rolldown-vite@7.2.5"
+		"vite": "npm:rolldown-vite@7.3.1"
 	},
 	"overrides": {
-		"vite": "npm:rolldown-vite@7.2.5"
+		"vite": "npm:rolldown-vite@7.3.1"
 	}
 }

package/template-react-ts/README.md

@@ -1,4 +1,4 @@
-# <<projectName>>
+# your-project-name-here
 
 ## Installation
 

package/template-react-ts/_aiignore

@@ -0,0 +1 @@
+.env

package/template-react-ts/_env

@@ -0,0 +1,3 @@
+CLI_TARGET_USERNAME='your-cluster-username-here'
+CLI_TARGET_PASSWORD='your-cluster-password-here'
+CLI_TARGET='your-fabric.harper.fast-cluster-url-here'

package/template-react-ts/_env.example

@@ -0,0 +1,3 @@
+CLI_TARGET_USERNAME='YOUR_CLUSTER_USERNAME'
+CLI_TARGET_PASSWORD='YOUR_CLUSTER_PASSWORD'
+CLI_TARGET='YOUR_FABRIC.HARPER.FAST_CLUSTER_URL_HERE'

package/template-react-ts/_github/workflow/deploy.yaml

@@ -26,7 +26,7 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Run unit tests
-        run: npm run test
+        run: npm test
       - name: Run lint
         run: npm run lint
       - name: Build

package/template-react-ts/_gitignore

@@ -0,0 +1,147 @@
+.DS_Store
+
+#
+# https://raw.githubusercontent.com/github/gitignore/refs/heads/main/Node.gitignore
+#
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.*
+!.env.example
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+.output
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Sveltekit cache directory
+.svelte-kit/
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Firebase cache directory
+.firebase/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v3
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Vite files
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
+.vite/

package/template-react-ts/graphql.config.yml

@@ -0,0 +1,3 @@
+schema: schema.graphql
+include: node_modules/harperdb/schema.graphql
+documents: '**/*.graphql'

package/template-react-ts/index.html

@@ -4,7 +4,7 @@
     <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><<projectName>></title>
+    <title>your-project-name-here</title>
   </head>
   <body>
     <div id="app"></div>

package/template-react-ts/package.json

@@ -1,5 +1,5 @@
 {
-	"name": "<<packageName>>",
+	"name": "your-package-name-here",
 	"private": true,
 	"version": "0.0.0",
 	"type": "module",
@@ -8,7 +8,8 @@
 		"test": "echo 'No tests implemented yet'",
 		"lint": "echo 'No lint implemented yet'",
 		"build": "tsc -b && vite build",
-		"preview": "vite preview"
+		"preview": "vite preview",
+		"deploy": "npx -y dotenv-cli -- harperdb deploy . restart=rolling replicated=true"
 	},
 	"devDependencies": {
 		"@harperfast/vite-plugin": "^0.0.1",
@@ -20,9 +21,9 @@
 		"react": "^19.2.3",
 		"react-dom": "^19.2.3",
 		"typescript": "~5.9.3",
-		"vite": "npm:rolldown-vite@7.2.5"
+		"vite": "npm:rolldown-vite@7.3.1"
 	},
 	"overrides": {
-		"vite": "npm:rolldown-vite@7.2.5"
+		"vite": "npm:rolldown-vite@7.3.1"
 	}
 }

package/template-studio/README.md

@@ -1,4 +1,4 @@
-# <<projectName>>
+# your-project-name-here
 
 Your new app is now deployed and running on Harper Fabric!
 

package/template-studio/_aiignore

@@ -0,0 +1 @@
+.env