Allow overriding node version in package.json

common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-engine-is-present.md

@@ -2,7 +2,7 @@
 
 Requires support for all Node LTS version.
 
-Currently, this requires `engine` in `package.json` to be set to `">=8.0.0"`.
+Currently, this requires `engines` in `package.json` to contain an entry for `node` set to `">=8.0.0"` unless a `nodeVersionOverride` value is present.
 
 This rule is fixable using the `--fix` option.
 
@@ -12,23 +12,33 @@ This rule is fixable using the `--fix` option.
 
 ```json
 {
-  "engine": ">=8.0.0"
+  "engines": {
+    "node": ">=8.0.0"
+  }
 }
 ```
 
 ### Bad
 
-````json
+```json
 {
-    "engine": ">=6.0.0"
+  "engine": {
+    "node": ">=8.0.0"
+  }
 }
-```'
+```
 
 ```json
 {
-    "engine": ">=10.0.0"
+  "engine": ">=6.0.0"
 }
-````
+```
+
+```json
+{
+  "engine": ">=10.0.0"
+}
+```
 
 ```json
 {}
@@ -38,6 +48,24 @@ This rule is fixable using the `--fix` option.
 
 Only if the rule breaks.
 
+## Options
+
+This rule as an object option:
+
+- `"nodeVersionOverride"`: allow providing a custom supported node version if an external dependency enforces it
+
+### nodeVersionOverride
+
+Example of **correct** code for this rule with the `{ "nodeVersionOverride": ">=10.0.0" }` option:
+
+```json
+{
+  "engines": {
+    "node": ">=10.0.0"
+  }
+}
+```
+
 ## [Source](https://azure.github.io/azure-sdk/typescript_implementation.html#ts-package-json-engine-is-present)
 
 Also encompasses [ts-node-support](https://azure.github.io/azure-sdk/typescript_design.html#ts-node-support), as the rules are similar enough to not exist separately for linting purposes.

common/tools/eslint-plugin-azure-sdk/package.json

@@ -72,12 +72,14 @@
     "@types/estree": "^0.0.45",
     "eslint-config-prettier": "^7.0.0",
     "glob": "^7.1.2",
+    "json-schema": "^0.3.0",
     "typescript": "4.1.2",
     "tslib": "^2.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.1.6",
     "@types/glob": "^7.1.1",
+    "@types/json-schema": "^7.0.6",
     "@types/mocha": "^7.0.2",
     "@types/node": "^8.0.0",
     "@typescript-eslint/eslint-plugin": "^4.9.0",

common/tools/eslint-plugin-azure-sdk/src/rules/ts-package-json-engine-is-present.ts

@@ -9,6 +9,12 @@
 import { Rule } from "eslint";
 import { getRuleMetaData, getVerifiers, stripPath } from "../utils";
 
+/**
+ * definition of LTS Node versions
+ * * needs updating as definitions change
+ */
+const LTS = ">=8.0.0";
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -17,19 +23,27 @@ export = {
   meta: getRuleMetaData(
     "ts-package-json-engine-is-present",
     "force Node support for all LTS versions",
-    "code"
+    "code",
+    [
+      {
+        type: "object",
+        properties: {
+          nodeVersionOverride: {
+            type: "string",
+            default: LTS,
+            description: "Allows specifying a different node version than the current default"
+          }
+        }
+      }
+    ]
   ),
   create: (context: Rule.RuleContext): Rule.RuleListener => {
-    /**
-     * definition of LTS Node versions
-     * * needs updating as definitions change
-     */
-    const LTS = ">=8.0.0";
+    const options = context.options[0] || {};
 
     const verifiers = getVerifiers(context, {
       outer: "engines",
       inner: "node",
-      expected: LTS
+      expected: options.nodeVersionOverride || LTS
     });
     return stripPath(context.getFilename()) === "package.json"
       ? ({

common/tools/eslint-plugin-azure-sdk/src/utils/metadata.ts

@@ -7,11 +7,13 @@
  */
 
 import { Rule } from "eslint";
+import { JSONSchema4 } from "json-schema";
 
 export const getRuleMetaData = (
   ruleName: string,
   ruleDescription: string,
-  fix?: "code" | "whitespace"
+  fix?: "code" | "whitespace",
+  schema?: JSONSchema4 | JSONSchema4[]
 ): Rule.RuleMetaData => {
   const required = {
     type: "suggestion",
@@ -21,7 +23,7 @@ export const getRuleMetaData = (
       recommended: true,
       url: `https://github.com/Azure/azure-sdk-for-js/tree/master/common/tools/eslint-plugin-azure-sdk/docs/rules/${ruleName}.md`
     },
-    schema: []
+    schema: schema || []
   };
   return (fix !== undefined ? { ...required, fixable: fix } : required) as Rule.RuleMetaData;
 };

common/tools/eslint-plugin-azure-sdk/tests/rules/ts-package-json-engine-is-present.ts

@@ -269,6 +269,16 @@ ruleTester.run("ts-package-json-engine-is-present", rule, {
       // incorrect format but in a file we don't care about
       code: '{"engines": { "node": ">=6.0.0" }}',
       filename: "not_package.json"
+    },
+    {
+      // different than the default but with an override
+      code: '{"engines": { "node": ">=8.5.0" }}',
+      filename: "package.json",
+      options: [
+        {
+          nodeVersionOverride: ">=8.5.0"
+        }
+      ]
     }
   ],
   invalid: [
@@ -322,6 +332,22 @@ ruleTester.run("ts-package-json-engine-is-present", rule, {
         }
       ],
       output: examplePackageGood
+    },
+    {
+      // override was provided but the version does not match
+      code: '{"engines": { "node": ">=8.0.0" }}',
+      filename: "package.json",
+      errors: [
+        {
+          message: "engines.node is set to >=8.0.0 when it should be set to >=6.5.0"
+        }
+      ],
+      options: [
+        {
+          nodeVersionOverride: ">=6.5.0"
+        }
+      ],
+      output: '{"engines": { "node": ">=6.5.0" }}'
     }
   ]
 });

sdk/monitor/opentelemetry-exporter-azure-monitor/.eslintrc.json

@@ -12,6 +12,12 @@
   ],
   "rules": {
     "no-underscore-dangle": ["error", { "allowAfterThis": true }],
-    "node/no-unsupported-features/es-syntax": ["error", { "ignores": ["modules"] }]
+    "node/no-unsupported-features/es-syntax": ["error", { "ignores": ["modules"] }],
+    // OpenTelemetry requires a minimum node version of 8.5.0
+    // https://github.com/open-telemetry/opentelemetry-js#node-support
+    "@azure/azure-sdk/ts-package-json-engine-is-present": [
+      "error",
+      { "nodeVersionOverride": ">=8.5.0" }
+    ]
   }
 }

sdk/monitor/opentelemetry-exporter-azure-monitor/README.md

@@ -14,7 +14,7 @@ This exporter package assumes your application is [already instrumented](https:/
 
 You must have an [Azure subscription](https://azure.microsoft.com/free/) and a
 [Application Insights workspace](https://docs.microsoft.com/azure/azure-monitor/app/app-insights-overview/) to use this package.
-If you are using this package in a Node.js application, then use Node.js 8.x or higher.
+If you are using this package in a Node.js application, then use Node.js 8.5.0 or higher.
 
 ### Distributed Tracing
 

sdk/monitor/opentelemetry-exporter-azure-monitor/package.json

@@ -35,7 +35,7 @@
     "docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --mode file --out ./dist/docs ./src"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=8.5.0"
   },
   "files": [
     "dist-esm/src/",