create-harper 0.0.1 → 0.0.2

package/lib/constants/defaultTargetDir.js

@@ -0,0 +1 @@
+export const defaultTargetDir = 'harper-project';

package/lib/constants/frameworks.js

@@ -0,0 +1,75 @@
+import colors from 'picocolors';
+
+const {
+	blue,
+	cyan,
+	gray,
+	yellow,
+} = colors;
+
+export const FRAMEWORKS = [
+	{
+		name: 'vanilla',
+		display: 'Vanilla',
+		color: yellow,
+		variants: [
+			{
+				name: 'vanilla-ts',
+				display: 'TypeScript',
+				color: blue,
+			},
+			{
+				name: 'vanilla',
+				display: 'JavaScript',
+				color: yellow,
+			},
+		],
+	},
+	{
+		name: 'react',
+		display: 'React',
+		color: cyan,
+		variants: [
+			{
+				name: 'react-ts',
+				display: 'TypeScript',
+				color: blue,
+			},
+			{
+				name: 'react',
+				display: 'JavaScript',
+				color: yellow,
+			},
+		],
+	},
+	{
+		name: 'studio',
+		hidden: true,
+		display: 'Studio',
+		color: gray,
+		variants: [
+			{
+				name: 'studio-ts',
+				display: 'TypeScript',
+				color: gray,
+			},
+			{
+				name: 'studio',
+				display: 'JavaScript',
+				color: gray,
+			},
+		],
+	},
+	{
+		name: 'barebones',
+		display: 'Barebones',
+		color: gray,
+		variants: [
+			{
+				name: 'barebones',
+				display: 'Barebones',
+				color: gray,
+			},
+		],
+	},
+];

package/lib/constants/helpMessage.js

@@ -0,0 +1,23 @@
+import colors from 'picocolors';
+
+const {
+	cyan,
+	green,
+	yellow,
+} = colors;
+
+export const helpMessage = `\
+Usage: create-harper [OPTION]... [DIRECTORY]
+
+Create a new Harper project in JavaScript or TypeScript.
+When running in TTY, the CLI will start in interactive mode.
+
+Options:
+  -t, --template NAME                   use a specific template
+  -i, --immediate                       install dependencies and start dev
+  --interactive / --no-interactive      force interactive / non-interactive mode
+
+Available templates:
+${yellow('vanilla-ts          vanilla')}
+${green('vue-ts              vue')}
+${cyan('react-ts            react')}`;

package/lib/constants/renameFiles.js

@@ -0,0 +1,6 @@
+export const renameFiles = {
+	_aiignore: '.aiignore',
+	_gitignore: '.gitignore',
+	_github: '.github',
+	'_env.example': '.env.example',
+};

package/lib/constants/templates.js

@@ -0,0 +1,6 @@
+import { FRAMEWORKS } from './frameworks.js';
+
+export const TEMPLATES = FRAMEWORKS.map((f) => f.variants.map((v) => v.name)).reduce(
+	(a, b) => a.concat(b),
+	[],
+);

package/lib/fs/applyAndWriteTemplateFile.js

@@ -0,0 +1,9 @@
+import template from 'lodash/template.js';
+import fs from 'node:fs';
+
+export function applyAndWriteTemplateFile(targetPath, templatePath, context) {
+	const templateContent = fs.readFileSync(templatePath, 'utf-8');
+	const templateFn = template(templateContent, { interpolate: /<<([\s\S]+?)>>/g });
+	const updatedContent = templateFn(context);
+	fs.writeFileSync(targetPath, updatedContent);
+}

package/lib/fs/copy.js

@@ -0,0 +1,11 @@
+import fs from 'node:fs';
+import { copyDir } from './copyDir.js';
+
+export function copy(src, dest) {
+	const stat = fs.statSync(src);
+	if (stat.isDirectory()) {
+		copyDir(src, dest);
+	} else {
+		fs.copyFileSync(src, dest);
+	}
+}

package/lib/fs/copyDir.js

@@ -0,0 +1,12 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { copy } from './copy.js';
+
+export function copyDir(srcDir, destDir) {
+	fs.mkdirSync(destDir, { recursive: true });
+	for (const file of fs.readdirSync(srcDir)) {
+		const srcFile = path.resolve(srcDir, file);
+		const destFile = path.resolve(destDir, file);
+		copy(srcFile, destFile);
+	}
+}

package/lib/fs/crawlTemplateDir.js

@@ -0,0 +1,18 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { renameFiles } from '../constants/renameFiles.js';
+import { applyAndWriteTemplateFile } from './applyAndWriteTemplateFile.js';
+
+export function crawlTemplateDir(root, dir, context) {
+	const files = fs.readdirSync(dir);
+	for (const file of files) {
+		const targetPath = path.join(root, renameFiles[file] ?? file);
+		const templatePath = path.join(dir, file);
+		if (fs.lstatSync(templatePath).isDirectory()) {
+			fs.mkdirSync(targetPath, { recursive: true });
+			crawlTemplateDir(targetPath, templatePath, context);
+		} else {
+			applyAndWriteTemplateFile(targetPath, templatePath, context);
+		}
+	}
+}

package/lib/fs/editFile.js

@@ -0,0 +1,6 @@
+import fs from 'node:fs';
+
+export function editFile(file, callback) {
+	const content = fs.readFileSync(file, 'utf-8');
+	fs.writeFileSync(file, callback(content), 'utf-8');
+}

package/lib/fs/emptyDir.js

@@ -0,0 +1,14 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+export function emptyDir(dir) {
+	if (!fs.existsSync(dir)) {
+		return;
+	}
+	for (const file of fs.readdirSync(dir)) {
+		if (file === '.git') {
+			continue;
+		}
+		fs.rmSync(path.resolve(dir, file), { recursive: true, force: true });
+	}
+}

package/lib/fs/formatTargetDir.js

@@ -0,0 +1,3 @@
+export function formatTargetDir(targetDir) {
+	return targetDir.trim().replace(/\/+$/g, '');
+}

package/lib/fs/isEmpty.js

@@ -0,0 +1,6 @@
+import fs from 'node:fs';
+
+export function isEmpty(path) {
+	const files = fs.readdirSync(path);
+	return files.length === 0 || (files.length === 1 && files[0] === '.git');
+}

package/lib/install.js

@@ -0,0 +1,17 @@
+import * as prompts from '@clack/prompts';
+import { getInstallCommand } from './pkg/getInstallCommand.js';
+import { run } from './run.js';
+
+export function install(root, agent) {
+	if (process.env._HARPER_TEST_CLI) {
+		prompts.log.step(
+			`Installing dependencies with ${agent}... (skipped in test)`,
+		);
+		return;
+	}
+	prompts.log.step(`Installing dependencies with ${agent}...`);
+	run(getInstallCommand(agent), {
+		stdio: 'inherit',
+		cwd: root,
+	});
+}

package/lib/pkg/getFullCustomCommand.js

@@ -0,0 +1,47 @@
+export function getFullCustomCommand(customCommand, pkgInfo) {
+	const pkgManager = pkgInfo ? pkgInfo.name : 'npm';
+	const isYarn1 = pkgManager === 'yarn' && pkgInfo?.version.startsWith('1.');
+
+	return (
+		customCommand
+			.replace(/^npm create (?:-- )?/, () => {
+				// `bun create` uses it's own set of templates,
+				// the closest alternative is using `bun x` directly on the package
+				if (pkgManager === 'bun') {
+					return 'bun x create-';
+				}
+				// Deno uses `run -A npm:create-` instead of `create` or `init` to also provide needed perms
+				if (pkgManager === 'deno') {
+					return 'deno run -A npm:create-';
+				}
+				// pnpm doesn't support the -- syntax
+				if (pkgManager === 'pnpm') {
+					return 'pnpm create ';
+				}
+				// For other package managers, preserve the original format
+				return customCommand.startsWith('npm create -- ')
+					? `${pkgManager} create -- `
+					: `${pkgManager} create `;
+			})
+			// Only Yarn 1.x doesn't support `@version` in the `create` command
+			.replace('@latest', () => (isYarn1 ? '' : '@latest'))
+			.replace(/^npm exec /, () => {
+				// Prefer `pnpm dlx`, `yarn dlx`, or `bun x`
+				if (pkgManager === 'pnpm') {
+					return 'pnpm dlx ';
+				}
+				if (pkgManager === 'yarn' && !isYarn1) {
+					return 'yarn dlx ';
+				}
+				if (pkgManager === 'bun') {
+					return 'bun x ';
+				}
+				if (pkgManager === 'deno') {
+					return 'deno run -A npm:';
+				}
+				// Use `npm exec` in all other cases,
+				// including Yarn 1.x and other custom npm clients.
+				return 'npm exec ';
+			})
+	);
+}

package/lib/pkg/getInstallCommand.js

@@ -0,0 +1,6 @@
+export function getInstallCommand(agent) {
+	if (agent === 'yarn') {
+		return [agent];
+	}
+	return [agent, 'install'];
+}

package/lib/pkg/getRunCommand.js

@@ -0,0 +1,12 @@
+export function getRunCommand(agent, script) {
+	switch (agent) {
+		case 'yarn':
+		case 'pnpm':
+		case 'bun':
+			return [agent, script];
+		case 'deno':
+			return [agent, 'task', script];
+		default:
+			return [agent, 'run', script];
+	}
+}

package/lib/pkg/isValidPackageName.js

@@ -0,0 +1,5 @@
+export function isValidPackageName(projectName) {
+	return /^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(
+		projectName,
+	);
+}

package/lib/pkg/pkgFromUserAgent.js

@@ -0,0 +1,9 @@
+export function pkgFromUserAgent(userAgent) {
+	if (!userAgent) { return undefined; }
+	const pkgSpec = userAgent.split(' ')[0];
+	const pkgSpecArr = pkgSpec.split('/');
+	return {
+		name: pkgSpecArr[0],
+		version: pkgSpecArr[1],
+	};
+}

package/lib/pkg/toValidPackageName.js

@@ -0,0 +1,8 @@
+export function toValidPackageName(projectName) {
+	return projectName
+		.trim()
+		.toLowerCase()
+		.replace(/\s+/g, '-')
+		.replace(/^[._]/, '')
+		.replace(/[^a-z\d\-~]+/g, '-');
+}

package/lib/run.js

@@ -0,0 +1,14 @@
+import spawn from 'cross-spawn';
+
+export function run([command, ...args], options) {
+	const { status, error } = spawn.sync(command, args, options);
+	if (status != null && status > 0) {
+		process.exit(status);
+	}
+
+	if (error) {
+		console.error(`\n${command} ${args.join(' ')} error!`);
+		console.error(error);
+		process.exit(1);
+	}
+}

package/lib/start.js

@@ -0,0 +1,15 @@
+import * as prompts from '@clack/prompts';
+import { getRunCommand } from './pkg/getRunCommand.js';
+import { run } from './run.js';
+
+export function start(root, agent) {
+	if (process.env._HARPER_TEST_CLI) {
+		prompts.log.step('Starting dev server... (skipped in test)');
+		return;
+	}
+	prompts.log.step('Starting dev server...');
+	run(getRunCommand(agent, 'dev'), {
+		stdio: 'inherit',
+		cwd: root,
+	});
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-harper",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"type": "module",
 	"author": {
 		"name": "HarperDB",
@@ -12,7 +12,15 @@
 	},
 	"files": [
 		"index.js",
-		"template-*"
+		"lib/",
+		"template-barebones/",
+		"template-react/",
+		"template-react-ts/",
+		"template-shared/",
+		"template-studio/",
+		"template-studio-ts/",
+		"template-vanilla/",
+		"template-vanilla-ts/"
 	],
 	"scripts": {
 		"lint": "oxlint .",

package/template-barebones/README.md

@@ -0,0 +1,7 @@
+# <<projectName>>
+
+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.
+
+The `main` branch is the starting point for the guide.
+
+The `completed` branch is the completed code example if you need to check your work.

package/template-barebones/config.yaml

@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=./node_modules/harperdb/config-app.schema.json
+
+# This is the configuration file for the application.
+# It specifies built-in Harper components that will load the specified feature and files.
+# For more information, see https://docs.harperdb.io/docs/reference/components/built-in-extensions
+
+# Follow along with https://github.com/HarperFast/create-your-first-application to learn more!

package/template-barebones/package.json

@@ -0,0 +1,14 @@
+{
+	"name": "<<packageName>>",
+	"version": "1.0.0",
+	"description": "Your new Harper app",
+	"type": "module",
+	"scripts": {
+		"start": "harperdb run .",
+		"dev": "harperdb dev .",
+		"deploy": "npx -y dotenv-cli -- harperdb deploy . restart=rolling replicated=true"
+	},
+	"devDependencies": {
+		"harperdb": "^4.7.15"
+	}
+}

package/template-barebones/schema.graphql

@@ -0,0 +1 @@
+## Table Schemas

package/template-react/README.md

@@ -0,0 +1,45 @@
+# <<projectName>>
+
+## Installation
+
+To get started, make sure you have [installed Harper](https://docs.harperdb.io/docs/deployments/install-harper), which can be done quickly:
+
+```sh
+npm install -g harperdb
+```
+
+## Development
+
+Then you can start your app:
+
+```sh
+npm run dev
+```
+
+Navigate to [http://localhost:9926](http://localhost:9926) in a browser and view the functional web application.
+
+For more information about getting started with HarperDB and building applications, see our [getting started guide](https://docs.harperdb.io/docs).
+
+For more information on Harper Components, see the [Components documentation](https://docs.harperdb.io/docs/reference/components).
+
+Take a look at the [default configuration](./config.yaml), which specifies how files are handled in your application.
+
+The [schema.graphql](./schema.graphql) is the table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
+
+The [resources.js](resources.ts) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
+
+## Deployment
+
+When you are ready, head to [https://fabric.harper.fast/](https://fabric.harper.fast/), log in to your account, and create a cluster.
+
+Set up your .env file with your secure cluster credentials. Don't commit this file to source control!
+
+```sh
+npm run login
+```
+
+Then you can deploy your app to your cluster:
+
+```sh
+npm run deploy
+```

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

@@ -0,0 +1,40 @@
+name: Deploy to Harper Fabric
+on:
+  workflow_dispatch:
+#  push:
+#    branches:
+#      - main
+
+concurrency:
+  group: main
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - name: Set up Node.js
+        uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
+        with:
+          cache: 'npm'
+          node-version-file: '.nvmrc'
+      - name: Install dependencies
+        run: npm ci
+      - name: Run unit tests
+        run: npm run test
+      - name: Run lint
+        run: npm run lint
+      - name: Build
+        run: npm run build
+      - name: Deploy
+        run: |
+          mkdir deploy
+          mv web deploy/
+          cp -R deploy-template/* deploy/
+          cd deploy
+          CLI_TARGET_USERNAME=${{ secrets.CLI_TARGET_USERNAME }} CLI_TARGET_PASSWORD='${{ secrets.CLI_TARGET_PASSWORD }}' harperdb deploy_component project='${{ secrets.CLI_DEPLOY_TARGET_NAME }}' target='${{ secrets.CLI_DEPLOY_TARGET_URL }}' restart=false replicated=true

package/template-react/config.yaml

@@ -0,0 +1,23 @@
+# yaml-language-server: $schema=./node_modules/harperdb/config-app.schema.json
+
+# This is the configuration file for the application.
+# It specifies built-in Harper components that will load the specified feature and files.
+# For more information, see https://docs.harperdb.io/docs/reference/components/built-in-extensions
+
+# Load Environment Variables from the specified file
+# loadEnv:
+#   files: '.env'
+
+# This provides the HTTP REST interface for all exported resources
+rest: true
+
+# These reads GraphQL schemas to define the schema of database/tables/attributes.
+graphqlSchema:
+  files: 'schema.graphql'
+
+# Loads JavaScript modules such that their exports are exported as resources
+jsResource:
+  files: 'resources.js'
+
+'@harperfast/vite-plugin':
+  package: '@harperfast/vite-plugin'

package/template-react/deploy-template/config.yaml

@@ -0,0 +1,2 @@
+fastifyRoutes:
+  files: fastify/*.js

package/template-react/deploy-template/fastify/static.js

@@ -0,0 +1,14 @@
+import fastifyStatic from '@fastify/static';
+import { join } from 'path';
+
+export default async (fastify) => {
+	fastify.register(fastifyStatic, {
+		root: join(import.meta.dirname, '../web'),
+		maxAge: '30d',
+		immutable: true,
+	});
+
+	fastify.get('/', function(req, reply) {
+		reply.sendFile('index.html', { maxAge: '1m', immutable: false });
+	});
+};

package/template-react/deploy-template/package.json

@@ -0,0 +1,5 @@
+{
+	"dependencies": {
+		"@fastify/static": "^7.0.4"
+	}
+}

package/template-react/index.html

@@ -0,0 +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><<projectName>></title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>

package/template-react/package.json

@@ -0,0 +1,24 @@
+{
+	"name": "<<packageName>>",
+	"private": true,
+	"version": "0.0.0",
+	"type": "module",
+	"scripts": {
+		"dev": "harper run .",
+		"test": "echo 'No tests implemented yet'",
+		"lint": "echo 'No lint implemented yet'",
+		"build": "vite build",
+		"preview": "vite preview"
+	},
+	"devDependencies": {
+		"@harperfast/vite-plugin": "^0.0.1",
+		"@vitejs/plugin-react": "^5.1.2",
+		"harperdb": "^4.7.15",
+		"react": "^19.2.3",
+		"react-dom": "^19.2.3",
+		"vite": "npm:rolldown-vite@7.2.5"
+	},
+	"overrides": {
+		"vite": "npm:rolldown-vite@7.2.5"
+	}
+}

package/template-react/public/react.svg

@@ -0,0 +1,14 @@
+<svg
+  width="100%"
+  height="100%"
+  viewBox="-10.5 -9.45 21 18.9"
+  fill="none"
+  xmlns="http://www.w3.org/2000/svg"
+>
+  <circle cx="0" cy="0" r="2" fill="#58c4dc"></circle>
+  <g stroke="#58c4dc" stroke-width="1" fill="none">
+    <ellipse rx="10" ry="4.5"></ellipse>
+    <ellipse rx="10" ry="4.5" transform="rotate(60)"></ellipse>
+    <ellipse rx="10" ry="4.5" transform="rotate(120)"></ellipse>
+  </g>
+</svg>

package/template-react/public/typescript.svg

@@ -0,0 +1,16 @@
+<svg
+  xmlns="http://www.w3.org/2000/svg"
+  aria-hidden="true"
+  role="img"
+  class="iconify iconify--logos"
+  width="32"
+  height="32"
+  preserveAspectRatio="xMidYMid meet"
+  viewBox="0 0 256 256"
+>
+  <path fill="#007ACC" d="M0 128v128h256V0H0z"></path>
+  <path
+    fill="#FFF"
+    d="m56.612 128.85l-.081 10.483h33.32v94.68h23.568v-94.68h33.321v-10.28c0-5.69-.122-10.444-.284-10.566c-.122-.162-20.4-.244-44.983-.203l-44.74.122l-.121 10.443Zm149.955-10.742c6.501 1.625 11.459 4.51 16.01 9.224c2.357 2.52 5.851 7.111 6.136 8.208c.08.325-11.053 7.802-17.798 11.988c-.244.162-1.22-.894-2.317-2.52c-3.291-4.795-6.745-6.867-12.028-7.233c-7.76-.528-12.759 3.535-12.718 10.321c0 1.992.284 3.17 1.097 4.795c1.707 3.536 4.876 5.649 14.832 9.956c18.326 7.883 26.168 13.084 31.045 20.48c5.445 8.249 6.664 21.415 2.966 31.208c-4.063 10.646-14.14 17.879-28.323 20.276c-4.388.772-14.79.65-19.504-.203c-10.28-1.828-20.033-6.908-26.047-13.572c-2.357-2.6-6.949-9.387-6.664-9.874c.122-.163 1.178-.813 2.356-1.504c1.138-.65 5.446-3.129 9.509-5.485l7.355-4.267l1.544 2.276c2.154 3.29 6.867 7.801 9.712 9.305c8.167 4.307 19.383 3.698 24.909-1.26c2.357-2.153 3.332-4.388 3.332-7.68c0-2.966-.366-4.266-1.91-6.501c-1.99-2.845-6.054-5.242-17.595-10.24c-13.206-5.69-18.895-9.224-24.096-14.832c-3.007-3.25-5.852-8.452-7.03-12.8c-.975-3.617-1.22-12.678-.447-16.335c2.723-12.76 12.353-21.659 26.25-24.3c4.51-.853 14.994-.528 19.424.569Z"
+  ></path>
+</svg>