chore: add upgrade prompt at load of jsii and jsii-rosetta 1.x (#4071)

This is to strongly incitate customers upgrade their dependencies, while trying to avoid alarming (there is 18 months left before the End-of-Support is scheduled, which is PLENTY of time). --- By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license]. [Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
aws · Apr 26, 2023 · 2cb15f8 · 2cb15f8
1 parent ac72ee4
commit 2cb15f8
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 0 deletions.
diff --git a/packages/jsii-rosetta/lib/index.ts b/packages/jsii-rosetta/lib/index.ts
@@ -11,3 +11,5 @@ export * from './rosetta-translator';
 export * from './snippet';
 export * from './markdown';
 export * from './strict';
+
+import './upgrade-prompt';
diff --git a/packages/jsii-rosetta/lib/upgrade-prompt.ts b/packages/jsii-rosetta/lib/upgrade-prompt.ts
@@ -0,0 +1,21 @@
+// Note: intentionally using the same environment variable as the compiler here instead of customizing...
+if (process.env.JSII_SUPPRESS_UPGRADE_PROMPT == null) {
+  console.error(
+    [
+      '#######################################################################################################',
+      '### You are currently using jsii-rosetta@1.x. We recommend upgrading to jsii-rosetta@5.0.x or       ###',
+      '### later. This will allow you to use modern TypeScript syntax, and improves compatibility with     ###',
+      '### many common dependencies. For example, recent versions of @types/node.                          ###',
+      '###                                                                                                 ###',
+      '### 5.0.x and subsequent releases of jsii-rosetta use the same major.minor version as the           ###',
+      '### TypeScript compiler they are built on. We recommend declaring a minor-pinned (also known as     ###',
+      '### "tilde") dependency on jsii-rosetta (e.g: `"jsii-rosetta": "5.0.x"` or                          ###',
+      '### `"jsii-rosetta": "~5.0.7"`).                                                                    ###',
+      '###                                                                                                 ###',
+      '### For more information, see: https://aws.github.io/jsii/compiler-and-rosetta-maintenance/         ###',
+      '###                                                                                                 ###',
+      '### This warning can be suppressed by setting the JSII_SUPPRESS_UPGRADE_PROMPT environment variable ###',
+      '#######################################################################################################',
+    ].join('\n'),
+  );
+}
diff --git a/packages/jsii/lib/index.ts b/packages/jsii/lib/index.ts
@@ -1,3 +1,5 @@
+import './upgrade-prompt';
+
 export * from './jsii-diagnostic';
 export * from './symbol-id';
 export * from './helpers';
diff --git a/packages/jsii/lib/upgrade-prompt.ts b/packages/jsii/lib/upgrade-prompt.ts
@@ -0,0 +1,19 @@
+if (process.env.JSII_SUPPRESS_UPGRADE_PROMPT == null) {
+  console.error(
+    [
+      '#######################################################################################################',
+      '### You are currently using jsii@1.x. We recommend upgrading to jsii@5.0.x or later. This will      ###',
+      '### allow you to use modern TypeScript syntax, and improves compatibility with many common          ###',
+      '### dependencies. For example, recent versions of @types/node.                                      ###',
+      '###                                                                                                 ###',
+      '### 5.0.x and subsequent releases of jsii use the same major.minor version as the TypeScript        ###',
+      '### compiler they are built on. We recommend declaring a minor-pinned (also known as "tilde")       ###',
+      '### dependency on jsii (e.g: `"jsii": "5.0.x"` or `"jsii": "~5.0.7"`).                              ###',
+      '###                                                                                                 ###',
+      '### For more information, see: https://aws.github.io/jsii/compiler-and-rosetta-maintenance/         ###',
+      '###                                                                                                 ###',
+      '### This warning can be suppressed by setting the JSII_SUPPRESS_UPGRADE_PROMPT environment variable ###',
+      '#######################################################################################################',
+    ].join('\n'),
+  );
+}