From 5f01c58c07701a0a8507dff6c14c87193ef44c95 Mon Sep 17 00:00:00 2001 From: Dom <3301714+domjtalbot@users.noreply.github.com> Date: Sun, 2 Apr 2023 19:24:41 +0100 Subject: [PATCH] refactor(nx-mesh): use localhost as the default host --- .changeset/great-bulldogs-pretend.md | 5 ++ README.md | 80 +++++++++---------- .../nx-mesh/src/executors/dev/schema.json | 2 +- .../nx-mesh/src/executors/serve/schema.json | 2 +- .../nx-mesh/src/executors/start/schema.json | 2 +- 5 files changed, 48 insertions(+), 43 deletions(-) create mode 100644 .changeset/great-bulldogs-pretend.md diff --git a/.changeset/great-bulldogs-pretend.md b/.changeset/great-bulldogs-pretend.md new file mode 100644 index 00000000..15ffb582 --- /dev/null +++ b/.changeset/great-bulldogs-pretend.md @@ -0,0 +1,5 @@ +--- +'nx-mesh': patch +--- + +Use `localhost` as the default host diff --git a/README.md b/README.md index d19d05dc..ced933ab 100644 --- a/README.md +++ b/README.md @@ -418,19 +418,19 @@ This is the equivalent of using `graphql-mesh dev`.
`dev` executor options -| Name | Type | Required | Default | Description | -| ----------------- | -------------- | :------: | --------- | -------------------------------------------------------------------------------------------------- | -| `debug` | `boolean` | - | `false` | Display debugging info by applying the `DEBUG` env variable. | -| `dir` | `string` | ✅ | - | The path of the directory containing the GraphQL Mesh config. | -| `port` | `object` | - | - | Port selection settings | -| `port.auto` | `boolean` | - | `true` | Use the first available port | -| `port.number` | `number` | - | `4200` | Define the preferred port to use when `auto` is set to `false` | -| `port.range` | `object` | - | - | The range of ports to select from. | -| `port.range.from` | `number` | - | - | The first port of the range. Must be in the range `1024`...`65535` | -| `port.range.to` | `number` | - | - | The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`. | -| `port.fallback` | `auto`, `none` | - | `auto` | The fallback strategy to use when the preferred port is unavailable. | -| `port.host` | `string` | - | `0.0.0.0` | The host to listen on (only used for port number lookup). | -| `require` | `string[]` | - | `[]` | Loads specific require.extensions before running the codegen and reading the configuration. | +| Name | Type | Required | Default | Description | +| ----------------- | -------------- | :------: | ----------- | -------------------------------------------------------------------------------------------------- | +| `debug` | `boolean` | - | `false` | Display debugging info by applying the `DEBUG` env variable. | +| `dir` | `string` | ✅ | - | The path of the directory containing the GraphQL Mesh config. | +| `port` | `object` | - | - | Port selection settings | +| `port.auto` | `boolean` | - | `true` | Use the first available port | +| `port.number` | `number` | - | `4200` | Define the preferred port to use when `auto` is set to `false` | +| `port.range` | `object` | - | - | The range of ports to select from. | +| `port.range.from` | `number` | - | - | The first port of the range. Must be in the range `1024`...`65535` | +| `port.range.to` | `number` | - | - | The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`. | +| `port.fallback` | `auto`, `none` | - | `auto` | The fallback strategy to use when the preferred port is unavailable. | +| `port.host` | `string` | - | `localhost` | The host to listen on (only used for port number lookup). | +| `require` | `string[]` | - | `[]` | Loads specific require.extensions before running the codegen and reading the configuration. |
@@ -456,19 +456,19 @@ This is the equivalent of using `graphql-mesh start`.
`start` executor options -| Name | Type | Required | Default | Description | -| ----------------- | -------------- | :------: | --------- | -------------------------------------------------------------------------------------------------- | -| `debug` | `boolean` | - | `false` | Display debugging info by applying the `DEBUG` env variable. | -| `dir` | `string` | ✅ | - | The path of the directory containing the GraphQL Mesh config. | -| `port` | `object` | - | - | Port selection settings | -| `port.auto` | `boolean` | - | `true` | Use the first available port | -| `port.number` | `number` | - | `4200` | Define the preferred port to use when `auto` is set to `false` | -| `port.range` | `object` | - | - | The range of ports to select from. | -| `port.range.from` | `number` | - | - | The first port of the range. Must be in the range `1024`...`65535` | -| `port.range.to` | `number` | - | - | The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`. | -| `port.fallback` | `auto`, `none` | - | `auto` | The fallback strategy to use when the preferred port is unavailable. | -| `port.host` | `string` | - | `0.0.0.0` | The host to listen on (only used for port number lookup). | -| `require` | `string[]` | - | `[]` | Loads specific require.extensions before running the codegen and reading the configuration. | +| Name | Type | Required | Default | Description | +| ----------------- | -------------- | :------: | ----------- | -------------------------------------------------------------------------------------------------- | +| `debug` | `boolean` | - | `false` | Display debugging info by applying the `DEBUG` env variable. | +| `dir` | `string` | ✅ | - | The path of the directory containing the GraphQL Mesh config. | +| `port` | `object` | - | - | Port selection settings | +| `port.auto` | `boolean` | - | `true` | Use the first available port | +| `port.number` | `number` | - | `4200` | Define the preferred port to use when `auto` is set to `false` | +| `port.range` | `object` | - | - | The range of ports to select from. | +| `port.range.from` | `number` | - | - | The first port of the range. Must be in the range `1024`...`65535` | +| `port.range.to` | `number` | - | - | The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`. | +| `port.fallback` | `auto`, `none` | - | `auto` | The fallback strategy to use when the preferred port is unavailable. | +| `port.host` | `string` | - | `localhost` | The host to listen on (only used for port number lookup). | +| `require` | `string[]` | - | `[]` | Loads specific require.extensions before running the codegen and reading the configuration. |
@@ -500,20 +500,20 @@ This combines `dev` & `start` via a `dev` option toggle.
`serve` executor options -| Name | Type | Required | Default | Description | -| ----------------- | -------------- | :------: | --------- | -------------------------------------------------------------------------------------------------- | -| `debug` | `boolean` | - | `false` | Display debugging info by applying the `DEBUG` env variable. | -| `dev` | `string` | - | `false` | Run the server in dev or production mode. | -| `dir` | `string` | ✅ | - | The path of the directory containing the GraphQL Mesh config. | -| `port` | `object` | - | - | Port selection settings | -| `port.auto` | `boolean` | - | `true` | Use the first available port | -| `port.number` | `number` | - | `4200` | Define the preferred port to use when `auto` is set to `false` | -| `port.range` | `object` | - | - | The range of ports to select from. | -| `port.range.from` | `number` | - | - | The first port of the range. Must be in the range `1024`...`65535` | -| `port.range.to` | `number` | - | - | The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`. | -| `port.fallback` | `auto`, `none` | - | `auto` | The fallback strategy to use when the preferred port is unavailable. | -| `port.host` | `string` | - | `0.0.0.0` | The host to listen on (only used for port number lookup). | -| `require` | `string[]` | - | `[]` | Loads specific require.extensions before running the codegen and reading the configuration. | +| Name | Type | Required | Default | Description | +| ----------------- | -------------- | :------: | ----------- | -------------------------------------------------------------------------------------------------- | +| `debug` | `boolean` | - | `false` | Display debugging info by applying the `DEBUG` env variable. | +| `dev` | `string` | - | `false` | Run the server in dev or production mode. | +| `dir` | `string` | ✅ | - | The path of the directory containing the GraphQL Mesh config. | +| `port` | `object` | - | - | Port selection settings | +| `port.auto` | `boolean` | - | `true` | Use the first available port | +| `port.number` | `number` | - | `4200` | Define the preferred port to use when `auto` is set to `false` | +| `port.range` | `object` | - | - | The range of ports to select from. | +| `port.range.from` | `number` | - | - | The first port of the range. Must be in the range `1024`...`65535` | +| `port.range.to` | `number` | - | - | The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`. | +| `port.fallback` | `auto`, `none` | - | `auto` | The fallback strategy to use when the preferred port is unavailable. | +| `port.host` | `string` | - | `localhost` | The host to listen on (only used for port number lookup). | +| `require` | `string[]` | - | `[]` | Loads specific require.extensions before running the codegen and reading the configuration. |
diff --git a/packages/nx-mesh/src/executors/dev/schema.json b/packages/nx-mesh/src/executors/dev/schema.json index 95d548f7..8a3bd206 100644 --- a/packages/nx-mesh/src/executors/dev/schema.json +++ b/packages/nx-mesh/src/executors/dev/schema.json @@ -52,7 +52,7 @@ "host": { "type": "string", "description": "The host to listern on.", - "default": "0.0.0.0" + "default": "localhost" } } }, diff --git a/packages/nx-mesh/src/executors/serve/schema.json b/packages/nx-mesh/src/executors/serve/schema.json index 2a56f1a7..cc59adc8 100644 --- a/packages/nx-mesh/src/executors/serve/schema.json +++ b/packages/nx-mesh/src/executors/serve/schema.json @@ -57,7 +57,7 @@ "host": { "type": "string", "description": "The host to listern on.", - "default": "0.0.0.0" + "default": "localhost" } } }, diff --git a/packages/nx-mesh/src/executors/start/schema.json b/packages/nx-mesh/src/executors/start/schema.json index 3c9ee195..75096e3a 100644 --- a/packages/nx-mesh/src/executors/start/schema.json +++ b/packages/nx-mesh/src/executors/start/schema.json @@ -52,7 +52,7 @@ "host": { "type": "string", "description": "The host to listern on.", - "default": "0.0.0.0" + "default": "localhost" } } },