@heartheyouth/create-tool 0.0.0-stage → 0.1.0

package/index.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+// `pnpm create @heartheyouth/tool my-tool` (or npm/yarn/bun): copies template/ into a new folder and
+// installs the latest packages with the package manager it was started with
+import { cpSync, existsSync, readdirSync, readFileSync, renameSync, writeFileSync } from 'node:fs'
+import { basename, join, resolve } from 'node:path'
+import { spawnSync } from 'node:child_process'
+import { fileURLToPath } from 'node:url'
+
+const DEPS     = ['next@^15', 'react@^19', 'react-dom@^19', '@heartheyouth/brandbook-toolkit']
+const DEV_DEPS = ['sass']
+
+const dir = process.argv[2]
+if (!dir) {
+  console.error('Give the tool a folder name: pnpm create @heartheyouth/tool my-tool')
+  process.exit(1)
+}
+
+const target = resolve(dir)
+if (existsSync(target) && readdirSync(target).length > 0) {
+  console.error(`${dir} already exists and isn't empty.`)
+  process.exit(1)
+}
+
+const name = basename(target).toLowerCase().replace(/[^a-z0-9-]+/g, '-')
+
+// npm drops .gitignore from published packages, so the template has it without the dot
+cpSync(fileURLToPath(new URL('template', import.meta.url)), target, { recursive: true })
+renameSync(join(target, 'gitignore'), join(target, '.gitignore'))
+
+const pkgPath = join(target, 'package.json')
+writeFileSync(pkgPath, readFileSync(pkgPath, 'utf8').replace('"my-tool"', JSON.stringify(name)))
+
+const pm = (process.env.npm_config_user_agent ?? 'npm').split('/')[0]
+const add = pm === 'npm' ? 'install' : 'add'
+
+function run(args) {
+  console.log(`\n> ${pm} ${args.join(' ')}`)
+  const { status } = spawnSync(pm, args, { cwd: target, stdio: 'inherit', shell: process.platform === 'win32' })
+  if (status !== 0) process.exit(status ?? 1)
+}
+
+console.log(`Creating ${name} in ${target}`)
+run([add, ...DEPS])
+run([add, '-D', ...DEV_DEPS])
+
+console.log(`
+Done. Next:
+
+  cd ${dir}
+  cp .env.example .env.local   # add your dev token, see https://brandbook.heartheyouth.com/dev-token
+  ${pm} run dev
+`)

package/package.json

@@ -1,6 +1,25 @@
 {
   "name": "@heartheyouth/create-tool",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Create a Hear The Youth brand book tool from the starter: pnpm create @heartheyouth/tool my-tool",
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HearTheYouth/dev-hty-tool-components.git",
+    "directory": "packages/create-tool"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "bin": {
+    "create-tool": "index.js"
+  },
+  "files": [
+    "index.js",
+    "template"
+  ],
+  "engines": {
+    "node": ">=20"
+  }
+}

package/template/.env.example

@@ -0,0 +1,2 @@
+# Dev token for localhost: https://brandbook.heartheyouth.com/dev-token
+NEXT_PUBLIC_BB_DEV_TOKEN=

package/template/app/layout.jsx

@@ -0,0 +1,16 @@
+import '@heartheyouth/brandbook-toolkit/styles.css'
+import { BrandbookProvider, BrowserCheck } from '@heartheyouth/brandbook-toolkit'
+
+export const metadata = { title: 'My tool' }
+
+export default function RootLayout({ children }) {
+  return (
+    <html lang="en">
+      <body>
+        <BrandbookProvider devToken={process.env.NEXT_PUBLIC_BB_DEV_TOKEN}>
+          <BrowserCheck>{children}</BrowserCheck>
+        </BrandbookProvider>
+      </body>
+    </html>
+  )
+}

package/template/app/page.jsx

@@ -0,0 +1,5 @@
+import { CompositorApp } from '@heartheyouth/brandbook-toolkit'
+
+export default function Page() {
+  return <CompositorApp appName="My tool" appTagline="Video & image layers" />
+}

package/template/gitignore

@@ -0,0 +1,4 @@
+node_modules
+.next
+.env*
+!.env.example

package/template/middleware.js

@@ -0,0 +1,5 @@
+import { brandbookMiddleware } from '@heartheyouth/brandbook-toolkit/middleware'
+
+// Direct visits get a blocked page, and only the brand book may embed the tool. Does nothing on localhost
+export const middleware = brandbookMiddleware()
+export const config = { matcher: ['/((?!_next/|favicon.ico|.*\\..*).*)'] }

package/template/next.config.mjs

@@ -0,0 +1,5 @@
+import { withBrandbookToolkit } from '@heartheyouth/brandbook-toolkit/next'
+
+export default withBrandbookToolkit({
+  // your config
+})

package/template/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "my-tool",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  }
+}

package/template/pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+# Packages that may run install scripts (pnpm only)
+allowBuilds:
+  "@parcel/watcher": true
+  sharp: true

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.