@pixpilot/scaffoldfy-configs 0.38.1 → 0.39.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @pixpilot/scaffoldfy-configs
 
+## 0.39.0
+
+### Minor Changes
+
+- enhance package publishing options
+
 ## 0.38.1
 
 ### Patch Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pixpilot/scaffoldfy-configs",
   "type": "module",
-  "version": "0.38.1",
+  "version": "0.39.0",
   "author": "PixPilot <m.doaie@hotmail.com>",
   "license": "MIT",
   "repository": {
@@ -30,10 +30,10 @@
     "@types/node": "^22.18.11",
     "eslint": "^9.38.0",
     "@internal/eslint-config": "0.3.0",
-    "@internal/tsdown-config": "0.1.0",
     "@internal/prettier-config": "0.0.1",
+    "@internal/tsdown-config": "0.1.0",
     "@internal/vitest-config": "0.1.0",
-    "@pixpilot/scaffoldfy": "0.54.0"
+    "@pixpilot/scaffoldfy": "0.55.0"
   },
   "prettier": "@internal/prettier-config",
   "publishConfig": {

package/test/workspace-package-generator.test.ts

@@ -88,6 +88,41 @@ describe('workspace-package-generator – schema', () => {
     }
     expect(result.valid).toBe(true);
   });
+
+  it('should collect a registry choice for public packages', () => {
+    const configPath = path.join(CONFIG_DIR, 'scaffoldfy-base.json');
+    const config = JSON.parse(fs.readFileSync(configPath, 'utf8')) as {
+      prompts: Array<{
+        id: string;
+        choices?: Array<{ name: string; value: string }>;
+        enabled?: { type: string; value: string };
+      }>;
+    };
+    const registryPrompt = config.prompts.find(
+      (prompt) => prompt.id === 'publishRegistry',
+    );
+    const customRegistryPrompt = config.prompts.find(
+      (prompt) => prompt.id === 'customRegistryUrl',
+    );
+
+    expect(registryPrompt).toMatchObject({
+      enabled: {
+        type: 'condition',
+        value: 'isPublishablePackage === true && isPublicPackage === true',
+      },
+    });
+    expect(registryPrompt?.choices).toEqual([
+      { name: 'GitHub Packages', value: 'github' },
+      { name: 'npm', value: 'npm' },
+      { name: 'Custom registry URL', value: 'custom' },
+    ]);
+    expect(customRegistryPrompt).toMatchObject({
+      enabled: {
+        type: 'condition',
+        value: "publishRegistry === 'custom'",
+      },
+    });
+  });
 });
 
 /* -------------------------------------------------------------------------- */
@@ -180,7 +215,7 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
   it('should render a valid JSON for an internal package', () => {
     const ctx = {
       packageBaseName: 'my-package',
-      isNpmPackage: false,
+      isPublishablePackage: false,
       workspace: 'packages',
       repoDirectory: 'packages/my-package',
       relativeRootPath: '../../',
@@ -191,6 +226,7 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
       isBundlerTsdown: false,
       hasTsdownConfig: false,
       tsdownConfigPackage: '@pixpilot/tsdown-config',
+      publishRegistryUrl: 'https://registry.npmjs.org',
     };
 
     const rendered = renderHbs(tplPath, ctx);
@@ -214,7 +250,7 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
   it('should render valid JSON for a public npm package (tsdown)', () => {
     const ctx = {
       packageBaseName: 'my-package',
-      isNpmPackage: true,
+      isPublishablePackage: true,
       isPublicPackage: true,
       bundler: 'tsdown',
       isBundlerTsc: false,
@@ -227,6 +263,7 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
       author: 'Test Author',
       repoUrl: 'https://github.com/test/monorepo.git',
       packageOrgName: 'myorg',
+      publishRegistryUrl: 'https://registry.npmjs.org',
     };
 
     const rendered = renderHbs(tplPath, ctx);
@@ -236,6 +273,7 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
     expect(pkg.private).toBeUndefined();
     expect(pkg.sideEffects).toBe(false);
     expect(pkg.publishConfig?.access).toBe('public');
+    expect(pkg.publishConfig?.registry).toBe('https://registry.npmjs.org');
     expect(pkg.files).toContain('dist');
     expect(pkg.scripts?.build).toBe('tsdown');
     expect(pkg.devDependencies?.['@pixpilot/tsdown-config']).toBeDefined();
@@ -246,7 +284,7 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
   it('should render valid JSON for a private npm package (tsc)', () => {
     const ctx = {
       packageBaseName: 'my-package',
-      isNpmPackage: true,
+      isPublishablePackage: true,
       isPublicPackage: false,
       bundler: 'tsc',
       isBundlerTsc: true,
@@ -259,6 +297,7 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
       author: 'Test Author',
       repoUrl: 'https://github.com/test/monorepo.git',
       orgName: '',
+      publishRegistryUrl: 'https://registry.npmjs.org',
     };
 
     const rendered = renderHbs(tplPath, ctx);
@@ -266,16 +305,52 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
 
     expect(pkg.name).toBe('my-package');
     expect(pkg.publishConfig?.access).toBe('restricted');
+    expect(pkg.publishConfig?.registry).toBe('https://registry.npmjs.org');
     expect(pkg.scripts?.build).toContain('tsc');
     expect(pkg.scripts?.['build:watch']).toContain('tsc');
     expect(pkg.devDependencies?.tsdown).toBeUndefined();
   });
 
+  /** Private package for the Pixpilot organization */
+  it('should publish a Pixpilot private package through GitHub Packages', () => {
+    const ctx = {
+      packageBaseName: 'foo',
+      isPublishablePackage: true,
+      isPublicPackage: false,
+      isPixpilotPrivatePackage: true,
+      publishRegistryUrl: 'https://npm.pkg.github.com',
+      bundler: 'tsc',
+      isBundlerTsc: true,
+      isBundlerTsdown: false,
+      hasTsdownConfig: false,
+      tsdownConfigPackage: '@pixpilot/tsdown-config',
+      workspace: 'packages',
+      repoDirectory: 'packages/foo',
+      relativeRootPath: '../../',
+      author: 'Test Author',
+      repoUrl: 'https://github.com/pixpilot-private/your-repo.git',
+    };
+
+    const rendered = renderHbs(tplPath, ctx);
+    const pkg = JSON.parse(rendered);
+
+    expect(pkg.name).toBe('@pixpilot-private/foo');
+    expect(pkg.publishConfig).toMatchObject({
+      access: 'restricted',
+      registry: 'https://npm.pkg.github.com',
+    });
+    expect(pkg.repository).toEqual({
+      type: 'git',
+      url: 'https://github.com/pixpilot-private/your-repo.git',
+      directory: 'packages/foo',
+    });
+  });
+
   /** npm package with internal tsdown config */
   it('should use @internal/tsdown-config when hasTsdownConfig is true', () => {
     const ctx = {
       packageBaseName: 'my-package',
-      isNpmPackage: true,
+      isPublishablePackage: true,
       isPublicPackage: true,
       bundler: 'tsdown',
       isBundlerTsc: false,
@@ -327,7 +402,7 @@ describe('workspace-package-generator – tsdown.config.ts.hbs rendering', () =>
   it("should add platform: 'neutral' for an npm package", () => {
     const ctx = {
       tsdownConfigPackage: '@pixpilot/tsdown-config',
-      isNpmPackage: true,
+      isPublishablePackage: true,
     };
     const rendered = renderHbs(tplPath, ctx);
 
@@ -337,7 +412,7 @@ describe('workspace-package-generator – tsdown.config.ts.hbs rendering', () =>
   it("should not add platform: 'neutral' when not an npm package", () => {
     const ctx = {
       tsdownConfigPackage: '@pixpilot/tsdown-config',
-      isNpmPackage: false,
+      isPublishablePackage: false,
     };
     const rendered = renderHbs(tplPath, ctx);
 

package/workspace-package-generator/scaffoldfy-base.json

@@ -107,9 +107,9 @@
       "required": false
     },
     {
-      "id": "isNpmPackage",
+      "id": "isPublishablePackage",
       "type": "confirm",
-      "message": "Is this an npm package?",
+      "message": "Should this package be published?",
       "default": false
     },
     {
@@ -119,7 +119,32 @@
       "default": false,
       "enabled": {
         "type": "condition",
-        "value": "isNpmPackage === true"
+        "value": "isPublishablePackage === true"
+      }
+    },
+    {
+      "id": "publishRegistry",
+      "type": "select",
+      "message": "Select a registry for this public package",
+      "choices": [
+        { "name": "GitHub Packages", "value": "github" },
+        { "name": "npm", "value": "npm" },
+        { "name": "Custom registry URL", "value": "custom" }
+      ],
+      "default": "npm",
+      "enabled": {
+        "type": "condition",
+        "value": "isPublishablePackage === true && isPublicPackage === true"
+      }
+    },
+    {
+      "id": "customRegistryUrl",
+      "type": "input",
+      "message": "Enter the custom registry URL",
+      "required": true,
+      "enabled": {
+        "type": "condition",
+        "value": "publishRegistry === 'custom'"
       }
     },
     {
@@ -133,7 +158,7 @@
       "default": "tsc",
       "enabled": {
         "type": "condition",
-        "value": "isNpmPackage === true"
+        "value": "isPublishablePackage === true"
       }
     },
     {

package/workspace-package-generator/scaffoldfy-project-info.json

@@ -7,5 +7,5 @@
     "../project-info/repo-info.json",
     "../project-info/org-name-info.json"
   ],
-  "enabled": { "type": "condition", "value": "isNpmPackage == true" }
+  "enabled": { "type": "condition", "value": "isPublishablePackage == true" }
 }

package/workspace-package-generator/scaffoldfy.json

@@ -30,6 +30,32 @@
         "value": "{{orgName}}"
       },
       "transformers": ["kebabcase"]
+    },
+    {
+      "id": "isPixpilotPrivatePackage",
+      "value": {
+        "type": "conditional",
+        "condition": "isPublishablePackage === true && isPublicPackage === false && (repoOwner === 'pixpilot' || orgName === 'PixPilot' || orgName === 'pixpilot')",
+        "ifTrue": true,
+        "ifFalse": false
+      }
+    },
+    {
+      "id": "publishRegistryUrl",
+      "value": {
+        "type": "conditional",
+        "condition": "publishRegistry === 'github' || isPixpilotPrivatePackage === true",
+        "ifTrue": "https://npm.pkg.github.com",
+        "ifFalse": {
+          "type": "conditional",
+          "condition": "publishRegistry === 'custom'",
+          "ifTrue": {
+            "type": "interpolate",
+            "value": "{{customRegistryUrl}}"
+          },
+          "ifFalse": "https://registry.npmjs.org"
+        }
+      }
     }
   ],
 
@@ -89,7 +115,7 @@
       "type": "create",
       "enabled": {
         "type": "condition",
-        "value": "bundler === 'tsc' && isNpmPackage === true"
+        "value": "bundler === 'tsc' && isPublishablePackage === true"
       },
       "config": {
         "file": "{{workspace}}/{{packageBaseName}}/tsconfig.build.json",
@@ -103,7 +129,7 @@
       "type": "create",
       "enabled": {
         "type": "condition",
-        "value": "bundler === 'tsdown' && isNpmPackage === true"
+        "value": "bundler === 'tsdown' && isPublishablePackage === true"
       },
       "config": {
         "file": "{{workspace}}/{{packageBaseName}}/tsdown.config.ts",

package/workspace-package-generator/templates/package.json.hbs

@@ -1,8 +1,8 @@
 {
-  "name": "{{#if isNpmPackage}}{{#if packageOrgName}}@{{packageOrgName}}/{{packageBaseName}}{{else}}{{packageBaseName}}{{/if}}{{else}}@internal/{{packageBaseName}}{{/if}}",
+  "name": "{{#if isPublishablePackage}}{{#if isPublicPackage}}{{#if packageOrgName}}@{{packageOrgName}}/{{packageBaseName}}{{else}}{{packageBaseName}}{{/if}}{{else}}{{#if isPixpilotPrivatePackage}}@pixpilot-private/{{packageBaseName}}{{else}}{{#if packageOrgName}}@{{packageOrgName}}/{{packageBaseName}}{{else}}{{packageBaseName}}{{/if}}{{/if}}{{/if}}{{else}}@internal/{{packageBaseName}}{{/if}}",
   "type": "module",
   "version": "0.0.0",
-  {{#unless isNpmPackage}}
+  {{#unless isPublishablePackage}}
   "private": true,
   {{/unless}}
   "packageManager": "pnpm@10.17.0",
@@ -19,7 +19,7 @@
     "url": "{{repoUrl}}",
     "directory": "{{repoDirectory}}"
   },
-  {{#if isNpmPackage}}
+  {{#if isPublishablePackage}}
   "sideEffects": false,
   {{/if}}
   "bugs": {
@@ -34,12 +34,13 @@
     "react-dom": "^18 || ^19"
   },
   {{/if}}
-  {{#if isNpmPackage}}
+  {{#if isPublishablePackage}}
   "files": [
     "dist"
   ],
   "publishConfig": {
     "access": "{{#if isPublicPackage}}public{{else}}restricted{{/if}}",
+    "registry": "{{publishRegistryUrl}}",
     "exports": {
       ".": {
         "types": "./dist/index.d.ts",
@@ -53,12 +54,12 @@
   },
   {{/if}}
   "scripts": {
-    {{#if isNpmPackage}}
+    {{#if isPublishablePackage}}
     "prepublishOnly": "pnpm run clean && pnpm run build",
     {{/if}}
     "clean": "git clean -xdf .cache .turbo dist",
     "clean:all": "pnpm clean && git clean -xdf node_modules",
-    {{#if isNpmPackage}}
+    {{#if isPublishablePackage}}
     {{#if isBundlerTsc}}
     "build": "pnpm run clean && tsc -p tsconfig.build.json",
     "build:watch": "pnpm run clean && tsc -p tsconfig.build.json --watch",
@@ -81,7 +82,7 @@
     "@internal/eslint-config": "workspace:*",
     "@internal/prettier-config": "workspace:*",
     "@internal/tsconfig": "workspace:*",
-    {{#if isNpmPackage}}
+    {{#if isPublishablePackage}}
     {{#if isBundlerTsdown}}
     {{#if hasTsdownConfig}}
     "{{tsdownConfigPackage}}": "workspace:*",
@@ -89,7 +90,7 @@
     {{/if}}
     {{/if}}
     "@internal/vitest-config": "workspace:*",
-    {{#if isNpmPackage}}
+    {{#if isPublishablePackage}}
     {{#if isBundlerTsdown}}
     {{#unless hasTsdownConfig}}
     "{{tsdownConfigPackage}}": "^1.0.0",
@@ -98,7 +99,7 @@
     {{/if}}
     "@types/node": "catalog:dev",
     {{#if isReactPackage}}
-    {{#if isNpmPackage}}
+    {{#if isPublishablePackage}}
     "@types/react": "^19.0.0",
     "@types/react-dom": "^19.0.0",
     {{else}}
@@ -110,7 +111,7 @@
     "@vitest/ui": "catalog:dev",
     "eslint": "catalog:dev",
     {{#if isReactPackage}}
-    {{#if isNpmPackage}}
+    {{#if isPublishablePackage}}
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
     {{else}}
@@ -118,7 +119,7 @@
     "react-dom": "catalog:",
     {{/if}}
     {{/if}}
-    {{#if isNpmPackage}}
+    {{#if isPublishablePackage}}
     {{#if isBundlerTsdown}}
     "tsdown": "catalog:dev",
     {{/if}}

package/workspace-package-generator/templates/tsdown.config.ts.hbs

@@ -13,7 +13,7 @@ export default defineConfig({
   dts: true,
   minify: false,
   clean: true,
-  {{#if isNpmPackage}}
+  {{#if isPublishablePackage}}
   // Keep `process.env.NODE_ENV` intact in the output so each consumer's bundler
   // (Next.js, Vite, etc.) can dead-code-eliminate dev-only guards in production.
   // A `browser` platform would inline it at build time, making dev-only code run