@mboucher/ffe-setup 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Marcel Boucher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,119 @@
-# Temporary Holding Version
+# FFE Setup
 
-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.
+Explicit installer for the FFE CLI and portable template validation skill.
+Requires Node.js 22.13+, npm, and Azure CLI (`az`) on PATH for full setup.
+MCP installation/registration, Azure CLI installation, and permission grants
+remain separate.
+
+## Set Up FFE
+
+After the skill and setup packages are published to npm, run:
+
+```sh
+npx @mboucher/ffe-setup --client vscode
+```
+
+Setup checks Node.js, npm, and `az version` before installing anything. Missing
+or broken prerequisites stop setup with instructions. Install Azure CLI from
+https://aka.ms/installazurecli if needed. Availability checks do not log in,
+query resources, or verify Azure permissions.
+
+It then runs `npm install --global @mboucher/ffe-cli@latest`, verifies the installed
+global executable with `--version`, and copies the skill. Re-running full setup
+can update an existing global FFE CLI. Ensure npm's global executable directory
+(printed by setup) is on PATH. Installation uses the current npm prefix, does not
+request administrator privileges, and does not retry failed installations with
+elevated privileges. Fix prefix write access or registry connectivity before retrying.
+If a later step fails, already completed installations are retained.
+
+In an interactive terminal, setup asks `Run "ffe auth login" now? [y/N]`.
+Only an explicit yes starts the CLI's secure Adobe credential flow, with terminal
+input/output inherited directly. Setup does not collect or store credentials.
+Declining, passing `--no-login`, or running without a TTY prints `ffe auth login`
+for later instead. A failed or cancelled login exits unsuccessfully but leaves
+the installation in place. Azure storage authentication is separate: run
+`az login` before storage commands. No Azure login runs automatically.
+
+For automated installs, skip the login prompt explicitly:
+
+```sh
+npx @mboucher/ffe-setup --client vscode --no-login
+```
+
+To install only the portable skill without checking Azure CLI or installing FFE:
+
+```sh
+npx @mboucher/ffe-setup --client vscode --skill-only
+```
+
+The default is workspace scope in the current directory. Choose a different
+project or install for your user explicitly:
+
+```sh
+npx @mboucher/ffe-setup --client vscode --workspace /path/to/project
+npx @mboucher/ffe-setup --client vscode --scope user
+npx @mboucher/ffe-setup --client claude-code --workspace /path/to/project
+npx @mboucher/ffe-setup --client claude-code --scope user
+```
+
+| Client | Workspace Skill Directory | User Skill Directory |
+| --- | --- | --- |
+| `vscode` | `.github/skills/ffe-template-validation-skill` | `~/.copilot/skills/ffe-template-validation-skill` |
+| `claude-code` | `.claude/skills/ffe-template-validation-skill` | `~/.claude/skills/ffe-template-validation-skill` |
+
+For any other assistant, choose its documented skill search directory directly:
+
+```sh
+npx @mboucher/ffe-setup --skills-dir /path/to/skills
+```
+
+Do not combine `--skills-dir` with client or scope options. The skill is placed
+under a `ffe-template-validation-skill` subdirectory of the selected directory.
+Reload skill discovery in your assistant after installation. No skill is
+installed merely by adding this npm package as a dependency; installation is an
+explicit command, not a `postinstall` side effect.
+
+## Existing Installations
+
+The installer copies the skill entry point, references, README, and license.
+Identical skill installations are left unchanged. If any installed file differs, or
+the target is a file or symbolic link, installation stops without overwriting
+it. Back up or move an existing installation before intentionally replacing it.
+No force-overwrite or automatic uninstall behavior is provided.
+
+## Local Development
+
+Before publishing the skill, keep its checkout beside this repository:
+
+```sh
+npm run dev:link
+npm test
+node bin/run.js --help
+```
+
+`dev:link` links the sibling `ffe-template-validation-skill` package without
+changing dependency specifications. To try the installer locally, use
+`node bin/run.js --client vscode --workspace /path/to/project`.
+
+Tests install into temporary directories, not your personal skills directory.
+They cover metadata discovery, destination selection, complete copies,
+repeatability, conflict protection, and packed npm artifact installation. Full
+setup tests use injected commands or temporary fake executables; they never
+install global packages or start real authentication.
+
+## Release
+
+Publish `@mboucher/ffe-template-validation-skill` 0.1.0 first. Then, from this
+repository:
+
+```sh
+npm install
+npm test
+npm run deploy -- --dry-run
+npm run deploy
+```
+
+`npm install` resolves the published skill and generates the registry-backed
+lockfile; commit it before release. Use `npm ci` for subsequent clean installs.
+Publishing runs tests first. Authenticate to npm through its trusted local flow;
+never place tokens in scripts. No publication is performed by tests.

package/bin/run.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+import {parseArgs} from 'node:util'
+import {skillsDirectory} from '../src/install-skill.js'
+import {setup} from '../src/setup.js'
+
+try {
+  const {values} = parseArgs({options: {
+    client: {type: 'string'},
+    scope: {type: 'string'},
+    workspace: {type: 'string'},
+    'skills-dir': {type: 'string'},
+    'skill-only': {type: 'boolean'},
+    'no-login': {type: 'boolean'},
+    help: {type: 'boolean', short: 'h'},
+  }, allowPositionals: false})
+  if (values.help) {
+    console.log('Usage: ffe-setup --client vscode|claude-code [--scope workspace|user] [--workspace PATH]\n       ffe-setup --skills-dir PATH\n\nChecks Node.js 22.13+, npm, and Azure CLI, installs FFE CLI globally and the\nvalidation skill, then offers to run "ffe auth login" in interactive terminals.\nWorkspace scope is the default. Does not install Azure CLI or register MCP.\n\nOptions:\n  --skill-only  Install only the skill; skip external tools and authentication.\n  --no-login    Install normally without prompting for Adobe login.')
+  } else {
+    const directory = skillsDirectory({
+      client: values.client, scope: values.scope, workspace: values.workspace, skillsDir: values['skills-dir'],
+    })
+    await setup({directory, skillOnly: values['skill-only'], noLogin: values['no-login']})
+  }
+} catch (error) {
+  console.error(error instanceof Error ? error.message : 'FFE setup failed.')
+  process.exitCode = 1
+}

package/package.json

@@ -1,6 +1,27 @@
 {
-  "name": "@mboucher/ffe-setup",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+    "name": "@mboucher/ffe-setup",
+    "version": "0.1.0",
+    "description": "Dependency validation, FFE CLI installation, and portable skill setup",
+    "license": "MIT",
+    "type": "module",
+    "bin": {
+        "ffe-setup": "bin/run.js"
+    },
+    "files": [
+        "bin",
+        "src"
+    ],
+    "engines": {
+        "node": ">=22.13.0"
+    },
+    "scripts": {
+        "test": "node --test test/*.test.js",
+        "deploy": "npm publish --access public",
+        "dev:link": "npm install --no-save --package-lock=false ../ffe-template-validation-skill",
+        "prepublishOnly": "npm test"
+    },
+    "dependencies": {
+        "@mboucher/ffe-template-validation-skill": "^0.1.0",
+        "cross-spawn": "^7.0.6"
+    }
 }

package/src/install-skill.js

@@ -0,0 +1,86 @@
+import {lstat, mkdir, readFile, readdir, rm, writeFile} from 'node:fs/promises'
+import {homedir} from 'node:os'
+import {dirname, join, relative, resolve} from 'node:path'
+import {fileURLToPath} from 'node:url'
+
+export const SKILL_NAME = 'ffe-template-validation-skill'
+
+export function skillsDirectory({client, scope, workspace, skillsDir, home = homedir()}) {
+  if (skillsDir !== undefined) {
+    if (!skillsDir.trim() || client !== undefined || scope !== undefined || workspace !== undefined) {
+      throw new Error('Use --skills-dir PATH alone, without --client, --scope, or --workspace.')
+    }
+    return resolve(skillsDir)
+  }
+  if (!['vscode', 'claude-code'].includes(client)) {
+    throw new Error('Select --client vscode or --client claude-code, or supply --skills-dir PATH.')
+  }
+  scope ??= 'workspace'
+  if (!['workspace', 'user'].includes(scope)) throw new Error('--scope must be workspace or user.')
+  if (scope === 'user' && workspace !== undefined) throw new Error('--workspace cannot be combined with --scope user.')
+  if (workspace !== undefined && !workspace.trim()) throw new Error('--workspace must be a nonempty path.')
+  const root = scope === 'user' ? home : resolve(workspace ?? process.cwd())
+  const directory = client === 'claude-code' ? '.claude' : scope === 'user' ? '.copilot' : '.github'
+  return join(root, directory, 'skills')
+}
+
+async function addTree(directory, root, files) {
+  for (const entry of await readdir(directory, {withFileTypes: true})) {
+    const path = join(directory, entry.name)
+    if (entry.isSymbolicLink()) throw new Error(`Refusing a symbolic link inside the skill: ${entry.name}`)
+    if (entry.isDirectory()) await addTree(path, root, files)
+    else if (entry.isFile()) files.set(relative(root, path), await readFile(path))
+    else throw new Error(`Unsupported skill entry: ${entry.name}`)
+  }
+}
+
+async function bundle(source) {
+  const files = new Map()
+  for (const name of ['SKILL.md', 'README.md', 'LICENSE', 'references']) {
+    const path = join(source, name)
+    const entry = await lstat(path)
+    if (entry.isSymbolicLink()) throw new Error(`Refusing a symbolic link inside the skill: ${name}`)
+    if (name === 'references' && entry.isDirectory()) await addTree(path, source, files)
+    else if (name !== 'references' && entry.isFile()) files.set(name, await readFile(path))
+    else throw new Error(`Invalid skill package entry: ${name}`)
+  }
+  for (const name of ['references/checklist.md', 'references/ffe-cli.md']) {
+    if (!files.has(name)) throw new Error(`The skill package is missing ${name}.`)
+  }
+  return files
+}
+
+export async function installSkill({directory, source}) {
+  source ??= dirname(fileURLToPath(import.meta.resolve('@mboucher/ffe-template-validation-skill/package.json')))
+  const files = await bundle(source)
+  const target = join(resolve(directory), SKILL_NAME)
+  let existing
+  try {
+    existing = await lstat(target)
+  } catch (error) {
+    if (error.code !== 'ENOENT') throw error
+  }
+  if (existing) {
+    if (!existing.isDirectory() || existing.isSymbolicLink()) throw new Error(`Refusing to replace ${target}.`)
+    const installed = new Map()
+    await addTree(target, target, installed)
+    if (files.size === installed.size && [...files].every(([name, data]) => installed.get(name)?.equals(data))) {
+      return {target, status: 'unchanged'}
+    }
+    throw new Error(`Existing skill differs at ${target}. Back it up or move it before installing; no files were changed.`)
+  }
+
+  await mkdir(dirname(target), {recursive: true})
+  await mkdir(target)
+  try {
+    for (const [name, data] of files) {
+      const path = join(target, name)
+      await mkdir(dirname(path), {recursive: true})
+      await writeFile(path, data, {flag: 'wx'})
+    }
+  } catch (error) {
+    await rm(target, {recursive: true, force: true})
+    throw error
+  }
+  return {target, status: 'installed'}
+}

package/src/setup.js

@@ -0,0 +1,89 @@
+import spawn from 'cross-spawn'
+import {join, dirname} from 'node:path'
+import {createInterface} from 'node:readline/promises'
+import {installSkill} from './install-skill.js'
+
+export function runCommand(command, args, {inherit = false, timeout = 30_000} = {}) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(command, args, {
+      stdio: inherit ? 'inherit' : ['ignore', 'pipe', 'pipe'],
+      ...(timeout ? {signal: AbortSignal.timeout(timeout)} : {}),
+    })
+    let stdout = ''
+    child.stdout?.on('data', (data) => { stdout += data })
+    child.stderr?.resume()
+    child.on('error', reject)
+    child.on('close', (code, signal) => {
+      if (code === 0) resolve(stdout.trim())
+      else reject(new Error(`${command} ${args.join(' ')} failed (${signal ?? `exit ${code}`}).`))
+    })
+  })
+}
+
+export async function confirmLogin() {
+  const prompt = createInterface({input: process.stdin, output: process.stdout})
+  try {
+    const answer = await prompt.question('Run "ffe auth login" now? [y/N] ')
+    return /^(y|yes)$/i.test(answer.trim())
+  } finally {
+    prompt.close()
+  }
+}
+
+export async function setup({directory, skillOnly = false, noLogin = false}, {
+  run = runCommand, install = installSkill, confirm = confirmLogin,
+  interactive = Boolean(process.stdin.isTTY && process.stdout.isTTY),
+  nodeVersion = process.versions.node, platform = process.platform, log = console.log,
+} = {}) {
+  const [major, minor] = nodeVersion.split('.').map(Number)
+  if (!(major > 22 || (major === 22 && minor >= 13))) {
+    throw new Error(`Node.js 22.13+ is required; found ${nodeVersion}. Upgrade Node.js and rerun setup.`)
+  }
+  let executable
+  if (!skillOnly) {
+    log(`Node.js ${nodeVersion}: OK`)
+    try {
+      const version = await run('npm', ['--version'])
+      log(`npm ${version}: OK`)
+    } catch (error) {
+      throw new Error('npm is unavailable. Install npm with Node.js and ensure it is on PATH, then rerun setup.', {cause: error})
+    }
+    try {
+      const version = JSON.parse(await run('az', ['version', '--output', 'json']))['azure-cli']
+      if (typeof version !== 'string' || !version) throw new Error('Invalid Azure CLI version response.')
+      log(`Azure CLI ${version}: OK`)
+    } catch (error) {
+      throw new Error('Azure CLI is unavailable or failed validation. Install or repair it from https://aka.ms/installazurecli and ensure "az" is on PATH, then rerun setup. Use --skill-only for offline skill installation.', {cause: error})
+    }
+    log('Installing FFE CLI globally: npm install --global @mboucher/ffe-cli@latest')
+    try {
+      await run('npm', ['install', '--global', '@mboucher/ffe-cli@latest'], {inherit: true, timeout: 0})
+    } catch (error) {
+      throw new Error('FFE CLI installation failed. Check npm output, registry access, and write access to your npm global prefix. Setup does not elevate privileges. Fix the issue and rerun setup.', {cause: error})
+    }
+    try {
+      const prefix = await run('npm', ['prefix', '--global'])
+      if (!prefix) throw new Error('npm returned an empty global prefix.')
+      executable = platform === 'win32' ? join(prefix, 'ffe.cmd') : join(prefix, 'bin', 'ffe')
+      log(`FFE CLI: ${await run(executable, ['--version'])}`)
+    } catch (error) {
+      throw new Error('FFE CLI was installed but verification failed. Check "ffe --version" and your Node.js installation before rerunning setup.', {cause: error})
+    }
+    log(`Ensure the global executable directory is on PATH: ${dirname(executable)}`)
+  }
+  const result = await install({directory})
+  log(`${result.status === 'installed' ? 'Installed' : 'Already installed'}: ${result.target}`)
+  log('Reload skill discovery in your assistant. MCP registration is separate.')
+  if (skillOnly) return result
+  log('Azure storage authentication is separate: run "az login" before storage commands.')
+  if (noLogin || !interactive || !await confirm()) {
+    log('To authenticate with Adobe later, run: ffe auth login')
+    return result
+  }
+  try {
+    await run(executable, ['auth', 'login'], {inherit: true, timeout: 0})
+  } catch (error) {
+    throw new Error('Installation completed, but Adobe login failed or was cancelled. Retry in an interactive terminal with "ffe auth login".', {cause: error})
+  }
+  return result
+}