@pushwoosh/frontend-builder-engine 3.1.1 → 3.1.3

package/README.md

@@ -12,8 +12,33 @@ The CLI is invoked via `pushwoosh-engine` (installed as a dependency in consumin
 pushwoosh-engine app:command:dev      # Start webpack dev server (HTTPS)
 pushwoosh-engine app:command:build    # Production build
 pushwoosh-engine app:command:analyze  # Bundle analysis
+pushwoosh-engine app:command:check-dead-code  # Unused files, exports and dependencies (knip)
 ```
 
+`app:command:check-dead-code` runs knip with the shipped `lib/knip.application.json`: entries are
+`src/index.{ts,tsx}` plus every `src/parcels/**/index.{ts,tsx}`, so a file the entry graph never
+reaches is reported as unused. Exports used only inside their own file and everything under a
+`generated/` directory are not reported; the binaries and unlisted rules are off, since consuming
+projects get eslint/tsc/webpack from this package rather than declaring them; config hints are
+suppressed, since the config lives here and a consuming project cannot act on them. A project opts
+in by adding the script and folding it into `check`:
+
+```json
+"check": "npm run check:lint && npm run check:types && npm run check:dead-code",
+"check:dead-code": "echo \"Run check:dead-code\" && `pushwoosh-engine app:command:check-dead-code`"
+```
+
+`examples/application` ships with exactly that wiring, so a project copied from the template gets the
+gate on its `pre-commit` hook from the first commit.
+
+CI is a separate step: the shared `frontend/microfrontend-release.yml` pipeline runs `check:lint` and
+`check:types` as their own jobs and never calls `npm run check`, so the script alone gates the
+pre-commit hook only. Blocking a merge needs a `check:dead-code` job next to those two.
+
+A project whose parcel entry sits outside the globs above (a file no other entry re-exports) needs
+its own `knip.json` in the project root and a plain `knip` call — the shared config is passed with
+`--config` and cannot be extended per project.
+
 ### Library commands (reusable packages)
 
 ```bash

package/lib/knip.application.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://unpkg.com/knip@6/schema.json",
+  "entry": [
+    "src/index.{ts,tsx}",
+    "src/parcels/**/index.{ts,tsx}"
+  ],
+  "project": [
+    "src/**/*.{ts,tsx}"
+  ],
+  "ignore": [
+    "**/generated/**"
+  ],
+  "ignoreExportsUsedInFile": true,
+  "includeEntryExports": false,
+  "rules": {
+    "binaries": "off",
+    "unlisted": "off"
+  }
+}

package/lib/pushwoosh-engine.js

@@ -1,4 +1,5 @@
 const childProcess = require('child_process');
+const { existsSync, readFileSync } = require('fs');
 const fs = require('fs').promises;
 const { program, Command } = require('commander');
 const path = require('path');
@@ -8,6 +9,28 @@ const { buildStyledComponents } = require('./build-babel');
 const { loadTsConfig } = require('./lib-build-tsconfig');
 const { loadPushwooshConfig, listFilesInDirectoryRecursively } = require('./helpers');
 
+// Printed commands are resolved from the engine's own dependencies, so a project gets no
+// webpack/knip of its own in node_modules/.bin (pnpm does not hoist them).
+const packageDir = (name) => {
+  let dir = path.dirname(require.resolve(name));
+  for (;;) {
+    const manifest = path.join(dir, 'package.json');
+    if (existsSync(manifest) && JSON.parse(readFileSync(manifest, 'utf8')).name === name) {
+      return dir;
+    }
+    dir = path.dirname(dir);
+  }
+};
+
+const bin = (name, command = name) => {
+  const dir = packageDir(name);
+  const manifest = JSON.parse(readFileSync(path.join(dir, 'package.json'), 'utf8'));
+  const entry = typeof manifest.bin === 'string' ? manifest.bin : manifest.bin[command];
+  return `node ${path.join(dir, entry)}`;
+};
+
+const engineFile = (file) => path.join(__dirname, file);
+
 program
   .version('1.0.0')
   .description('Build lib')
@@ -55,9 +78,9 @@ program
       .description('Playground command')
       .action(async () => {
         const cmd = [
-          './node_modules/.bin/webpack-dev-server',
+          bin('webpack-dev-server'),
           '--config',
-          './node_modules/@pushwoosh/frontend-builder-engine/lib/webpack.playground.config.js',
+          engineFile('webpack.playground.config.js'),
           '--stats-error-details',
         ];
         console.log(cmd.join(' '));
@@ -87,10 +110,10 @@ program
       .description('App dev command')
       .action(async () => {
         const cmd = [
-          './node_modules/.bin/webpack',
+          bin('webpack-cli'),
           'serve',
           '--config',
-          './node_modules/@pushwoosh/frontend-builder-engine/lib/webpack.application.config.js',
+          engineFile('webpack.application.config.js'),
         ];
         console.log(cmd.join(' '));
       }),
@@ -102,9 +125,9 @@ program
       .description('App build command')
       .action(async () => {
         const cmd = [
-          './node_modules/.bin/webpack',
+          bin('webpack-cli'),
           '--config',
-          './node_modules/@pushwoosh/frontend-builder-engine/lib/webpack.application.config.js',
+          engineFile('webpack.application.config.js'),
           '--stats-error-details',
           '--mode=production'
         ];
@@ -112,15 +135,30 @@ program
       }),
   );
 
+program
+  .addCommand(
+    new Command('app:command:check-dead-code')
+      .description('App dead code check command')
+      .action(async () => {
+        const cmd = [
+          bin('knip'),
+          '--config',
+          engineFile('knip.application.json'),
+          '--no-config-hints',
+        ];
+        console.log(cmd.join(' '));
+      }),
+  );
+
 program
   .addCommand(
     new Command('app:command:analyze')
       .description('App analyze command')
       .action(async () => {
         const cmd = [
-          './node_modules/.bin/webpack',
+          bin('webpack-cli'),
           '--config',
-          './node_modules/@pushwoosh/frontend-builder-engine/lib/webpack.application.config.js',
+          engineFile('webpack.application.config.js'),
           '--mode=production',
           '--env',
           'analyze',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/frontend-builder-engine",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "description": "Pushwoosh frontend builder engine",
   "main": "./lib/pushwoosh-frontend-builder-engine.js",
   "publishConfig": {
@@ -44,6 +44,7 @@
     "eslint-plugin-react-hooks": "^7.0.1",
     "fork-ts-checker-webpack-plugin": "^9.0.2",
     "html-webpack-plugin": "^5.6.0",
+    "knip": "^6.35.1",
     "style-loader": "^4.0.0",
     "systemjs-webpack-interop": "^2.3.7",
     "ts-loader": "^9.5.1",