create-portfoliable 1.2.9 → 1.2.10

package/README.md

@@ -16,7 +16,7 @@ npx create-portfoliable my-site
 - installs the runtime dependencies needed for the generated project
 - configures the project structure and base files
 - provides a local dev, build, and preview workflow
-- publishes from the `@portfoliablejs` npm org and GitHub Packages
+- publishes the canonical package to npm.org and a scoped alias to GitHub Packages
 
 ## Documentation
 
@@ -25,10 +25,12 @@ npx create-portfoliable my-site
 
 ## Publishing
 
-This package is released through the repository workflow and publishes to the `@portfoliablejs` npm org. The release process checks the live npm registry before publishing so it cannot reuse a version that already exists.
+This package is released only through the repository workflow. The canonical npm.org identity is `create-portfoliable`, which preserves `npm create portfoliable@latest`. The same version and payload are also published to GitHub Packages as `@portfoliablejs/create-portfoliable`, because GitHub's npm registry requires scoped names.
+
+The registries are separate publish targets; publishing to one does not mirror to the other. The release workflow checks each registry before publishing and provides manual recovery modes for a version missing from GitHub Packages or a tagged release missing from npm.org.
 
 ## License
 
 MIT
 
-This package is published through the Portfoliable npm org and the GitHub Packages release workflow.
+Normal maintainers do not publish this package locally.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-portfoliable",
-  "version": "1.2.9",
+  "version": "1.2.10",
   "description": "Unified Portfoliable package with initializer and runtime CLI",
   "private": false,
   "type": "module",

package/scripts/prepare-github-package.mjs

@@ -0,0 +1,47 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { pathToFileURL } from 'node:url';
+
+export const NPM_PACKAGE_NAME = 'create-portfoliable';
+export const GITHUB_PACKAGE_NAME = '@portfoliablejs/create-portfoliable';
+export const GITHUB_PACKAGES_REGISTRY = 'https://npm.pkg.github.com';
+
+export function prepareGithubPackage(packageDirectory) {
+  const packageJsonPath = resolve(packageDirectory, 'package.json');
+  const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
+
+  if (packageJson.name !== NPM_PACKAGE_NAME) {
+    throw new Error(
+      `Expected staged package name ${NPM_PACKAGE_NAME} but found ${packageJson.name || '<missing>'}`
+    );
+  }
+
+  const githubPackageJson = {
+    ...packageJson,
+    name: GITHUB_PACKAGE_NAME,
+    publishConfig: {
+      ...packageJson.publishConfig,
+      registry: GITHUB_PACKAGES_REGISTRY,
+      access: 'public',
+    },
+  };
+
+  writeFileSync(packageJsonPath, `${JSON.stringify(githubPackageJson, null, 2)}\n`);
+  return githubPackageJson;
+}
+
+const isMainModule =
+  typeof process.argv[1] === 'string' &&
+  import.meta.url === pathToFileURL(process.argv[1]).href;
+
+if (isMainModule) {
+  const packageDirectory = process.argv[2];
+
+  if (!packageDirectory) {
+    console.error('Usage: node prepare-github-package.mjs <staged-package-directory>');
+    process.exit(1);
+  }
+
+  const packageJson = prepareGithubPackage(packageDirectory);
+  console.log(`Prepared ${packageJson.name}@${packageJson.version} for GitHub Packages.`);
+}

package/scripts/prepare-github-package.test.js

@@ -0,0 +1,85 @@
+import { mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { afterEach, describe, expect, it } from 'vitest';
+import {
+  GITHUB_PACKAGE_NAME,
+  GITHUB_PACKAGES_REGISTRY,
+  prepareGithubPackage,
+} from './prepare-github-package.mjs';
+
+const temporaryDirectories = [];
+
+function createPackageDirectory(packageJson) {
+  const packageDirectory = mkdtempSync(join(tmpdir(), 'portfoliable-github-package-'));
+  temporaryDirectories.push(packageDirectory);
+  writeFileSync(
+    join(packageDirectory, 'package.json'),
+    `${JSON.stringify(packageJson, null, 2)}\n`
+  );
+  return packageDirectory;
+}
+
+afterEach(() => {
+  for (const directory of temporaryDirectories.splice(0)) {
+    rmSync(directory, { recursive: true, force: true });
+  }
+});
+
+describe('GitHub Packages manifest preparation', () => {
+  it('rewrites only the staged package identity and registry', () => {
+    const sourcePackageJson = {
+      name: 'create-portfoliable',
+      version: '1.2.10',
+      bin: {
+        create: 'bin/create-portfoliable.mjs',
+        'create-portfoliable': 'bin/create-portfoliable.mjs',
+      },
+      files: ['bin', 'templates'],
+      repository: {
+        type: 'git',
+        url: 'git+https://github.com/portfoliablejs/portfoliable.git',
+        directory: 'create-portfoliable',
+      },
+      publishConfig: {
+        registry: 'https://registry.npmjs.org/',
+        access: 'public',
+        provenance: true,
+      },
+    };
+    const sourceDirectory = createPackageDirectory(sourcePackageJson);
+    const stagedDirectory = createPackageDirectory(sourcePackageJson);
+
+    const preparedPackageJson = prepareGithubPackage(stagedDirectory);
+    const persistedPackageJson = JSON.parse(
+      readFileSync(join(stagedDirectory, 'package.json'), 'utf8')
+    );
+    const unchangedSourcePackageJson = JSON.parse(
+      readFileSync(join(sourceDirectory, 'package.json'), 'utf8')
+    );
+
+    expect(preparedPackageJson).toEqual(persistedPackageJson);
+    expect(persistedPackageJson.name).toBe(GITHUB_PACKAGE_NAME);
+    expect(persistedPackageJson.version).toBe(sourcePackageJson.version);
+    expect(persistedPackageJson.bin).toEqual(sourcePackageJson.bin);
+    expect(persistedPackageJson.files).toEqual(sourcePackageJson.files);
+    expect(persistedPackageJson.repository).toEqual(sourcePackageJson.repository);
+    expect(persistedPackageJson.publishConfig).toEqual({
+      registry: GITHUB_PACKAGES_REGISTRY,
+      access: 'public',
+      provenance: true,
+    });
+    expect(unchangedSourcePackageJson).toEqual(sourcePackageJson);
+  });
+
+  it('rejects an unexpected source package identity', () => {
+    const stagedDirectory = createPackageDirectory({
+      name: '@portfoliablejs/create-portfoliable',
+      version: '1.2.10',
+    });
+
+    expect(() => prepareGithubPackage(stagedDirectory)).toThrow(
+      'Expected staged package name create-portfoliable'
+    );
+  });
+});