tsconfigs

par redis

Localiser et modifier la configuration TypeScript dans RedisInsight. Utiliser lors de l'ajout d'alias de chemin, de l'introduction d'une nouvelle zone TS, du débogage de chemin webpack/ts-node/ESLint…

npx skills add https://github.com/redis/redisinsight --skill tsconfigs

TypeScript Configuration

RedisInsight has no root tsconfig.json. Config is split per area, each owning its own paths, includes, and consumers. ESLint uses parserOptions.project: true to auto-discover the nearest tsconfig for each linted file.

Layout

FileOwnsConsumers
redisinsight/ui/tsconfig.jsonUI source, uiSrc/*, apiClient pathsVite (UI build), ESLint UI override, npm run type-check:ui
redisinsight/api/tsconfig.jsonAPI source, src/*, tests/* pathsNestJS build, ESLint API override
redisinsight/api/tsconfig.check.jsonSame as base + strict: true (with strictPropertyInitialization and useUnknownInCatchVariables off) and noEmit: truenpm run type-check:api only — kept separate so strict mode doesn't break nest build. See the type-check-baselines skill.
redisinsight/desktop/tsconfig.jsonDesktop source. Paths desktopSrc/*, apiSrc/*, uiSrc/*, apiClient, apiClient/* for TypeScript / IDE intellisenseESLint for desktop files, TS language server
configs/tsconfig.jsonCompiler options (module: CommonJS, esModuleInterop) used by ts-node to load the .ts webpack configsts-node via TS_NODE_PROJECT set in build:main / build:main:stage / build:stage
.storybook/tsconfig.jsonStorybook framework files, extends UI tsconfigStorybook + ESLint
stories/tsconfig.jsonStory files. Extends UI tsconfig; rewires uiSrc/* to resolve from redisinsight/uiStorybook + ESLint
tests/e2e-playwright/tsconfig.jsonPlaywright E2E suiteE2E runner (sub-project with own package.json, eslint-ignored at root)

Webpack path resolution (configs/webpack.config.base.ts)

Webpack uses explicit resolve.alias entries (not tsconfig-paths-webpack-plugin):

alias: {
  desktopSrc: webpackPaths.desktopSrcPath,
  apiSrc: resolve(webpackPaths.apiPath, 'src'),
  uiSrc: webpackPaths.uiSrcPath,
  apiClient: resolve(webpackPaths.riPath, 'api-client'),
  // ...
}

If you add a new path alias used by desktop code, add it in both places: redisinsight/desktop/tsconfig.json (for TypeScript / ESLint / IDE) and configs/webpack.config.base.ts resolve.alias (for the electron bundle).

ts-node and webpack TS configs

The webpack configs in configs/ are .ts files with type annotations. When webpack --config ./configs/*.ts runs, ts-node compiles them. Three package.json scripts set TS_NODE_PROJECT=./configs/tsconfig.json so ts-node uses the right compiler options:

  • build:main
  • build:main:stage
  • build:stage

configs/tsconfig.json deliberately does not set allowJs. Any .js file inside scripts/ or configs/ must be CommonJS (require / module.exports) — Node 22's module syntax detection will treat ESM-syntax .js files as ESM and break references to __dirname. Two scripts converted for this reason: scripts/prebuild.js, scripts/DeleteSourceMaps.js.

ESLint

.eslintrc.js:

  • Root parserOptions.project: true — auto-discovers the nearest tsconfig per file.
  • API override: parserOptions.project: redisinsight/api/tsconfig.json (explicit).
  • UI override: parserOptions.project: redisinsight/ui/tsconfig.json (explicit).
  • Files in .storybook/, .github/, etc. are not linted by eslint . because ESLint skips dot-prefixed paths during directory expansion.

If you add a top-level TS folder that ESLint will reach, drop a tsconfig in it or parserOptions.project: true will fail to find one.

Common tasks

Adding a path alias used by desktop / electron

  1. Add the alias to redisinsight/desktop/tsconfig.json compilerOptions.paths.
  2. If the alias is also used by UI code, add it to redisinsight/ui/tsconfig.json.
  3. If the alias is also used by API code, add it to redisinsight/api/tsconfig.json.
  4. For aliases used by the electron bundle (anything imported from redisinsight/desktop/**), also mirror the alias into configs/webpack.config.base.ts resolve.alias. Vite resolves UI aliases from redisinsight/ui/tsconfig.json automatically.

Adding a new top-level TS folder

Create a tsconfig.json in it. Bare minimum:

{
  "extends": "../redisinsight/ui/tsconfig.json",
  "include": ["**/*"]
}

Without it, ESLint's parserOptions.project: true will error on those files.

Adding a new .ts webpack config under configs/

No action needed — configs/tsconfig.json includes **/*.

Adding a Node script that needs to run without ts-node

Place under scripts/ as CommonJS (require/module.exports). Do not use ESM syntax — configs/tsconfig.json no longer has allowJs and Node 22 will load ESM-syntax .js files as ESM (no __dirname).

Plus de skills de redis

docs-sync
redis
Analyser l'implémentation et la configuration de la branche master pour trouver la documentation manquante, incorrecte ou obsolète dans docs/, README.md et les READMEs par package. Utiliser…
redis-query-engine
redis
Conseils sur le moteur de requêtes Redis (RQE) couvrant la conception de schémas FT.CREATE, la sélection des types de champs (TEXT, TAG, NUMERIC, GEO, GEOSHAPE, VECTOR), la syntaxe des requêtes DIALECT 2,…
redis-search
redis
Conseils sur Redis Search couvrant la conception de schémas FT.CREATE, la sélection des types de champs (TEXT, TAG, NUMERIC, GEO, GEOSHAPE, VECTOR, chemin JSON), la syntaxe des requêtes DIALECT 2,…
redis-security
redis
Conseils de sécurité Redis couvrant l'authentification (requirepass et utilisateurs ACL), TLS, contrôle d'accès basé sur les ACL avec privilèges minimaux, restriction de l'exposition réseau via…
redis-semantic-cache
redis
Guide Redis LangCache pour la mise en cache sémantique des réponses LLM sur Redis Cloud — appel de search/set via le SDK ou l'API REST, réglage du seuil de similarité,…
redis-vector-search
redis
Conseils sur la recherche vectorielle Redis couvrant le choix entre les algorithmes HNSW et FLAT, la configuration de l'index vectoriel (dimensions, métrique de distance, type de données), la recherche hybride filtrée…
bump-test-image
redis
Augmenter la version de l'image de test Docker Redis par défaut (redislabs/client-libs-test) dans le DEFAULT_DOCKER_CONFIG partagé et la matrice CI, puis force-push le…
i18n
redis
Conventions d'internationalisation pour l'interface RedisInsight (i18next). À utiliser lors de l'ajout ou de la modification de chaînes visibles par l'utilisateur sous redisinsight/ui/**, de la modification du…