@zeniai/client-epic-state 4.16.6 → 4.16.7-beta0NN

package/README.md

@@ -13,8 +13,86 @@ Common module for Web, Mobile & Server Side Rendering repos containing requi
   - If any tests fail, the build process will be terminated
   - Test files are automatically excluded from the final build output
 
+### Test & Typecheck Commands
+
+- **Run all tests and typecheck test files:**
+
+  ```sh
+  pnpm test
+  ```
+
+  This will typecheck all `.vitest.ts` files and their dependencies, then run the full test suite. The build will fail if there are any TypeScript errors in test files.
+
+- **Typecheck only test files:**
+
+  ```sh
+  pnpm test:typecheck
+  ```
+
+  This will only typecheck `.vitest.ts` files and their dependencies, and print the time taken.
+
+- **Typecheck and run a single test file:**
+  ```sh
+  pnpm run test:file <filename-or-unique-substring>
+  ```
+  Example:
+  ```sh
+  pnpm run test:file testTransactionsViewReducer
+  ```
+  This will search for a file in `src/` whose name contains the given string (case-insensitive), typecheck it, and run only its tests.
+  - If multiple files match, you'll see a list and must be more specific.
+  - If no files match, you'll get an error.
+
+#### Note on Typechecking
+
+Testing types with `tsc` and Vitest is an experimental feature. Breaking changes might not follow SemVer, so please pin Vitest's version when using it. See [Vitest docs](https://vitest.dev/guide/testing-types.html) for more info.
+
 ### Vitest
 
 - Fast framework for running unit, integration, and component tests in modern TypeScript/JavaScript projects.
 - Provides instant feedback with watch mode, built-in coverage, and Jest-compatible APIs.
 - Recommended for new tests and as a drop-in replacement for legacy Jest/Chai setups.
+
+---
+
+## Available NPM Scripts
+
+### Test & Typecheck
+
+- `pnpm test` — Typechecks all `.vitest.ts` files and runs the full test suite.
+- `pnpm test:typecheck` — Typechecks only `.vitest.ts` files and their dependencies, prints time taken.
+- `pnpm run test:file <file>` — Typechecks and runs tests for a single file.
+
+### Build & Clean
+
+- `pnpm build` — Runs ESLint, typechecks, tests, and then cleans up mocks/test helpers.
+- `pnpm only-build` — Runs ESLint and typechecks, then cleans up mocks/test helpers.
+- `pnpm clean` — Removes the `lib` directory.
+
+### Lint & Format
+
+- `pnpm lint` — Runs ESLint with auto-fix on all JS/TS files.
+- `pnpm format` — Formats all source files with Prettier.
+- `pnpm format-watch` — Formats only changed/added TS/TSX files with Prettier.
+
+### Code Quality & Analysis
+
+- `pnpm find-dead-code` — Finds unused code using ts-prune.
+- `pnpm find-unused-exports` — Finds unused exports using ts-unused-exports.
+- `pnpm circular-dependency` — Detects circular dependencies using madge.
+
+### Release & Versioning
+
+- `pnpm prepublishOnly` — Runs branch validation, updates Slack topic, checks version, cleans, and builds before publishing.
+- `pnpm version` — Stages all changes in `src` for versioning.
+- `pnpm postversion` — Pushes commits and tags after version bump.
+- `pnpm check-version` — Checks the current version using a custom script.
+- `pnpm check-dependencies` — Checks dependencies using a custom script.
+- `pnpm clean-resolutions` — Cleans up resolutions using a custom script.
+- `pnpm create-release-branch` — Runs the release branch creation script.
+- `pnpm bump-update-web-app-cockpit-beta` — Runs the cockpit beta update script.
+- `pnpm send-release-notes` — Sends release notes using a custom script.
+- `pnpm update-slack-group-topic` — Updates the Slack group topic using a custom script.
+- `pnpm build-beta-and-copy` — Runs the beta build and copy script.
+- `pnpm pr-approvals-update` — Updates PR approvals using a custom script.
+- `pnpm raise-pr-automation` — Runs the PR automation script.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "4.16.6",
+  "version": "4.16.7-beta0NN",
   "description": "Shared module between Web & Mobile containing required abstractions for state management, async network communication. ",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -84,13 +84,14 @@
   },
   "scripts": {
     "clean": "rimraf lib",
-    "test": "vitest run",
+    "test:typecheck": "echo 'Typechecking test files...' && time tsc -p tsconfig.typecheck.json",
+    "test": "pnpm test:typecheck && vitest run --typecheck",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx --fix",
     "find-dead-code": "ts-prune | grep -v '(used in module)'",
     "find-unused-exports": "ts-unused-exports ./tsconfig.json",
     "circular-dependency": "npx madge --circular --extensions ts ./src",
-    "build": "concurrently --kill-others-on-fail --handle-input \"eslint . --ext .js,.jsx,.ts,.tsx\" \"tsc\" \"vitest run\" && rimraf \"lib/**/__mocks__\" \"lib/**/__testHelpers__\"",
-    "only-build": "concurrently --kill-others-on-fail --handle-input \"eslint . --ext .js,.jsx,.ts,.tsx\" \"tsc\" && rimraf \"lib/**/__mocks__\" \"lib/**/__testHelpers__\"",
+    "build": "concurrently --kill-others-on-fail --handle-input \"echo 'Running ESLint...' && eslint . --ext .js,.jsx,.ts,.tsx\" \"echo 'TypeScript build in progress...' && time tsc\" \"echo 'Running tests and typecheck...' && pnpm test\" && rimraf \"lib/**/__mocks__\" \"lib/**/__testHelpers__\"",
+    "only-build": "concurrently --kill-others-on-fail --handle-input \"echo 'Running ESLint...' && eslint . --ext .js,.jsx,.ts,.tsx\" \"echo 'TypeScript build in progress...' && time tsc\" && rimraf \"lib/**/__mocks__\" \"lib/**/__testHelpers__\"",
     "format": "prettier --write --ignore-unknown \"src/**/*\"",
     "format-watch": "(git diff --name-only --diff-filter=ACM && git ls-files --others --exclude-standard) | grep -E '\\.(ts|tsx)$' | xargs prettier --write",
     "check-version": "node ./scripts/check_version.js",
@@ -104,6 +105,7 @@
     "update-slack-group-topic": "chmod +x ./scripts/update-slack-group-topic.sh && ./scripts/update-slack-group-topic.sh",
     "build-beta-and-copy": "chmod +x ./scripts/build_and_copy.sh && ./scripts/build_and_copy.sh",
     "pr-approvals-update": "chmod +x ./scripts/pr_approvals.sh && ./scripts/pr_approvals.sh",
-    "raise-pr-automation": "chmod +x ./scripts/raise_pr_automation.sh && ./scripts/raise_pr_automation.sh"
+    "raise-pr-automation": "chmod +x ./scripts/raise_pr_automation.sh && ./scripts/raise_pr_automation.sh",
+    "test:file": "scripts/test-file.sh"
   }
 }