ToolJet/.github/instructions/data-migrations.instructions.md
Nakul Nagargade 433e1bd4c4
Enhance TypeScript support in frontend configuration (#15576)
* test: verify pre-commit hook

* fix: clean up code formatting and improve readability across multiple components

* chore: update subproject commit reference in frontend/ee

* chore: update eslint to version 9.26.0 and remove unused dependencies from package.json

fix: update submodule reference in server/ee

* chore: refactor ESLint configuration and add quiet linting script; update components to disable specific ESLint rules

* chore: add GitHub Copilot review instructions for App Builder team

Covers backward compatibility rules, styling conventions, state management,
resolution system, widget definitions, and common review flags.

* chore: add review instructions for App Builder, Data Migrations, Server Widget Config, Widget Components, and Widget Config

* Enhance TypeScript support in frontend configuration

- Added TypeScript parser and linting rules to ESLint configuration.
- Updated Babel configuration to include TypeScript preset.
- Modified package.json and package-lock.json to include TypeScript and related dependencies.
- Introduced tsconfig.json for TypeScript compiler options.
- Updated Webpack configuration to support .ts and .tsx file extensions.
- Adjusted linting and formatting scripts to include TypeScript files.

* chore: update TypeScript ESLint packages and subproject commits

---------

Co-authored-by: kavinvenkatachalam <kavin.saratha@gmail.com>
Co-authored-by: Johnson Cherian <johnsonc.dev@gmail.com>
2026-03-19 12:41:32 +05:30

31 lines
969 B
Markdown

---
applyTo: "server/data-migrations/**/*"
---
# Data Migration — Logging Guidelines
New migrations MUST include progress logging to help monitor deployments.
## Required Logging Pattern
1. **Baseline** — Before processing, query and log total records:
`[START] {Action} | Total: {Total}`
2. **Progress** — During execution, log using current/total format:
`[PROGRESS] {Current}/{Total} ({Percentage}%)`
3. **Confirmation** — Log final success:
`[SUCCESS] {Action} finished.`
## Reviewer Checklist
- [ ] Count query establishes a **total** before processing
- [ ] Log statements use the **`x/total`** ratio pattern
- [ ] Clear **success** log at the end
- [ ] No silent bulk updates without console feedback
## When Generating Migration Code
- Include a count query for the denominator before processing.
- Wrap iterative logic in a batch/loop that logs `current/total` progress.
- Avoid silent bulk updates that provide no console feedback.