feat(client): Add ELECTRIC_FEATURES option to CLI for ease of use (#1304

)

As #768 adds the read-only
permissions as an experimental feature enabled via the
`ELECTRIC_FEATURES` environment variable, I found it useful to have it
in the CLI as well.

Will open respective docs PR as well if people agree with adding this
env var to the CLI.

.changeset/strange-keys-run.md

@@ -0,0 +1,5 @@
+---
+"electric-sql": patch
+---
+
+Add experimental feature flag `ELECTRIC_FEATURES` environment variable to CLI options

clients/typescript/src/cli/config-options.ts

@@ -329,4 +329,11 @@ export const configOptions: Record<string, any> = {
     doc: 'The name to use for the Docker container.',
     groups: ['electric'],
   },
+  ELECTRIC_FEATURES: {
+    valueType: String,
+    valueTypeName: 'features',
+    defaultVal: '',
+    doc: 'Flags to enable experimental features',
+    groups: ['electric'],
+  },
 } as const

clients/typescript/src/cli/docker-commands/docker/compose-with-postgres.yaml

@@ -60,5 +60,6 @@ services:
       AUTH_JWT_ISS: ${AUTH_JWT_ISS:-}
       AUTH_JWT_KEY: ${AUTH_JWT_KEY:-}
       AUTH_JWT_NAMESPACE: ${AUTH_JWT_NAMESPACE:-}
+      ELECTRIC_FEATURES: ${ELECTRIC_FEATURES:-}
     depends_on:
       - postgres

clients/typescript/src/cli/docker-commands/docker/compose.yaml

@@ -60,3 +60,4 @@ services:
       AUTH_JWT_ISS: ${AUTH_JWT_ISS:-}
       AUTH_JWT_KEY: ${AUTH_JWT_KEY:-}
       AUTH_JWT_NAMESPACE: ${AUTH_JWT_NAMESPACE:-}
+      ELECTRIC_FEATURES: ${ELECTRIC_FEATURES:-}

clients/typescript/test/cli/config-options.test.ts

@@ -34,6 +34,7 @@ const expectedEnvVars = [
   'POSTGRESQL_IMAGE',
   'ELECTRIC_IMAGE',
   'CONTAINER_NAME',
+  'ELECTRIC_FEATURES',
 ]
 
 test('assert that all expected env vars are options for CLI', (t) => {