algolia / firestore-algolia-search

Apache License 2.0
112 stars 35 forks source link

CLI Config: LOCATION as default value for some fields, LOCATION as env variable name in resulting env file #222

Open benomatis opened 2 months ago

benomatis commented 2 months ago

Note that I only tried this locally.

When using firebase ext:configure firestore-algolia-search in the CLI, several fields show the LOCATION field as their default values, and if you accept it (don't enter anything), it will create a line with the LOCATION name as an env variable name in the resulting env file equalling true.

europe-central2=true

This is how the config flow looks like:

Database ID: Enter database that contains the collections that you want to monitor?
? Enter a value for Database ID: europe-central2

...

Alternative Object Id (Optional): Specify an alternative Firestore document property to use for the Algolia record Id.  Use (path) if the document path is desired as the Algolia ObjectID.  The default is the Firestore document Id. If you set this property, make sure to clear out the Algolia Index since the ObjectID will be different resulting in duplicate records.
? Enter a value for Alternative Object Id: europe-central2

Transform Function Name (Experimental) (Optional): Specify a Firebase Cloud Function for any data transformation before saving into Algolia. Refer to Call functions for your app (https://firebase.google.com/docs/functions/callable).
? Enter a value for Transform Function Name (Experimental): europe-central2

While this is not the end of the world, it can be quite confusing for the first time user.