@pixpilot/scaffoldfy-configs 0.22.0 → 0.24.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @pixpilot/scaffoldfy-configs
 
+## 0.24.0
+
+### Minor Changes
+
+- add sideEffects and platform configuration for npm packages
+- add support for configuration files hosted on URLs
+
+## 0.23.0
+
+### Minor Changes
+
+- enhance test scripts and add coverage dependencies
+
 ## 0.22.0
 
 ### Minor Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pixpilot/scaffoldfy-configs",
   "type": "module",
-  "version": "0.22.0",
+  "version": "0.24.0",
   "author": "PixPilot <m.doaie@hotmail.com>",
   "license": "MIT",
   "repository": {
@@ -24,10 +24,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/vitest-config": "0.1.0",
-    "@pixpilot/scaffoldfy": "0.48.0"
+    "@internal/tsdown-config": "0.1.0",
+    "@pixpilot/scaffoldfy": "0.49.0",
+    "@internal/prettier-config": "0.0.1"
   },
   "prettier": "@internal/prettier-config",
   "publishConfig": {

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

@@ -198,8 +198,16 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
 
     expect(pkg.name).toBe('@internal/my-package');
     expect(pkg.private).toBe(true);
+    expect(pkg.sideEffects).toBeUndefined();
     expect(pkg.publishConfig).toBeUndefined();
     expect(pkg.files).toBeUndefined();
+    expect(pkg.scripts?.['test:ui']).toBe('vitest --ui --watch');
+    expect(pkg.scripts?.['test:ui:coverage']).toBe(
+      'vitest --ui --coverage --watch --hookTimeout=30000 --coverage.thresholds.lines=0 --coverage.thresholds.functions=0 --coverage.thresholds.branches=0 --coverage.thresholds.statements=0',
+    );
+    expect(pkg.devDependencies?.['@vitest/coverage-v8']).toBe('catalog:dev');
+    expect(pkg.devDependencies?.['@vitest/ui']).toBe('catalog:dev');
+    expect(pkg.devDependencies?.vitest).toBe('catalog:dev');
   });
 
   /** Public npm package with tsdown bundler */
@@ -226,6 +234,7 @@ describe('workspace-package-generator – package.json.hbs rendering', () => {
 
     expect(pkg.name).toBe('@myorg/my-package');
     expect(pkg.private).toBeUndefined();
+    expect(pkg.sideEffects).toBe(false);
     expect(pkg.publishConfig?.access).toBe('public');
     expect(pkg.files).toContain('dist');
     expect(pkg.scripts?.build).toBe('tsdown');
@@ -314,6 +323,26 @@ describe('workspace-package-generator – tsdown.config.ts.hbs rendering', () =>
     expect(rendered).toContain('MAX_BUNDLE_SIZE_KB = 50');
     expect(rendered).toContain('bundleSize: MAX_BUNDLE_SIZE_KB * KB');
   });
+
+  it("should add platform: 'neutral' for an npm package", () => {
+    const ctx = {
+      tsdownConfigPackage: '@pixpilot/tsdown-config',
+      isNpmPackage: true,
+    };
+    const rendered = renderHbs(tplPath, ctx);
+
+    expect(rendered).toContain("platform: 'neutral'");
+  });
+
+  it("should not add platform: 'neutral' when not an npm package", () => {
+    const ctx = {
+      tsdownConfigPackage: '@pixpilot/tsdown-config',
+      isNpmPackage: false,
+    };
+    const rendered = renderHbs(tplPath, ctx);
+
+    expect(rendered).not.toContain('platform');
+  });
 });
 
 describe('workspace-package-generator – src/index.ts.hbs rendering', () => {

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

@@ -1,6 +1,9 @@
 {
   "name": "{{#if isNpmPackage}}{{#if packageOrgName}}@{{packageOrgName}}/{{packageBaseName}}{{else}}{{packageBaseName}}{{/if}}{{else}}@internal/{{packageBaseName}}{{/if}}",
   "type": "module",
+  {{#if isNpmPackage}}
+  "sideEffects": false,
+  {{/if}}
   "version": "0.0.0",
   {{#unless isNpmPackage}}
   "private": true,
@@ -67,7 +70,8 @@
     {{/if}}
     "test": "vitest --run --passWithNoTests",
     "test:watch": "vitest --watch",
-    "test:ui": "vitest --ui",
+    "test:ui": "vitest --ui --watch",
+    "test:ui:coverage": "vitest --ui --coverage --watch --hookTimeout=30000 --coverage.thresholds.lines=0 --coverage.thresholds.functions=0 --coverage.thresholds.branches=0 --coverage.thresholds.statements=0",
     "test:coverage": "vitest --coverage",
     "typecheck": "tsc --noEmit",
     "lint": "eslint",
@@ -77,7 +81,21 @@
     "@internal/eslint-config": "workspace:*",
     "@internal/prettier-config": "workspace:*",
     "@internal/tsconfig": "workspace:*",
+    {{#if isNpmPackage}}
+    {{#if isBundlerTsdown}}
+    {{#if hasTsdownConfig}}
+    "{{tsdownConfigPackage}}": "workspace:*",
+    {{/if}}
+    {{/if}}
+    {{/if}}
     "@internal/vitest-config": "workspace:*",
+    {{#if isNpmPackage}}
+    {{#if isBundlerTsdown}}
+    {{#unless hasTsdownConfig}}
+    "{{tsdownConfigPackage}}": "^1.0.0",
+    {{/unless}}
+    {{/if}}
+    {{/if}}
     "@types/node": "catalog:dev",
     {{#if isReactPackage}}
     {{#if isNpmPackage}}
@@ -88,6 +106,8 @@
     "@types/react-dom": "catalog:",
     {{/if}}
     {{/if}}
+    "@vitest/coverage-v8": "catalog:dev",
+    "@vitest/ui": "catalog:dev",
     "eslint": "catalog:dev",
     {{#if isReactPackage}}
     {{#if isNpmPackage}}
@@ -100,15 +120,11 @@
     {{/if}}
     {{#if isNpmPackage}}
     {{#if isBundlerTsdown}}
-    "{{tsdownConfigPackage}}": "{{#if hasTsdownConfig}}workspace:*{{else}}^1.0.0{{/if}}",
-    {{/if}}
-    {{/if}}
-    {{#if isNpmPackage}}
-    {{#if isBundlerTsdown}}
     "tsdown": "catalog:dev",
     {{/if}}
     {{/if}}
-    "typescript": "catalog:dev"
+    "typescript": "catalog:dev",
+    "vitest": "catalog:dev"
   },
   "prettier": "@internal/prettier-config"
 }

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

@@ -13,4 +13,11 @@ export default defineConfig({
   dts: true,
   minify: false,
   clean: true,
+  {{#if isNpmPackage}}
+  // 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
+  // unconditionally in shipped bundles.
+  platform: 'neutral',
+  {{/if}}
 });