facebook/relay

Custom `artifactDirectory` has to exist and is not automatically created (like `__generate__`)

Open

#3.782 geöffnet am 31. Jan. 2022

Auf GitHub ansehen
 (10 Kommentare) (6 Reaktionen) (0 zugewiesene Personen)Rust (18.930 Stars) (1.874 Forks)batch import
help wantedrust

Beschreibung

When specifying a custom artifactDirectory in the relay compiler config, ​the compiler requires this directory to exist. Otherwise you get:

[ERROR] Config `/home/.../frontend/relay.config.js` is invalid:
​- The `artifactDirectory` does not exist at `/home/.../frontend/src/query-types`.

This is particularly annoying when using git, as you cannot check empty folders into git. The typical ".gitkeep file in folder" trick does not work well, because the relay-compiler deletes all files from the artifact directory on each compile, always leading to a dirty working directory.

I think the best is to use the same behavior as for the default __generated__ folder: create it, if it doesn't exist.

This problem only occurred after upgrading to v13 (i.e. the compiler written in Rust).

Contributor Guide

Tech Stack
rusttypescriptgraphql
Domain
developer experiencetooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Relay compiler configurationRust basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
Locate the Rust compiler's configuration validation logic, likely in the 'config.rs' or 'compiler.rs' file. Identify where the default ' generated ' directory is automatically created and implement similar logic for custom 'artifactDirectory'. The change should create the directory if it does not exist before compilation. Refer to existing behavior as a model.