Add eslint plugin and rule to check for use of deprecated APIs (#1890)

Author: timotheeguerin

common/changes/@typespec/compiler/eslint-deprecated-rule_2023-05-03-16-47.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@typespec/compiler",
+      "comment": "Cleanup deprecated use",
+      "type": "none"
+    }
+  ],
+  "packageName": "@typespec/compiler"
+}

common/changes/@typespec/eslint-config-typespec/eslint-deprecated-rule_2023-05-03-16-47.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@typespec/eslint-config-typespec",
+      "comment": "Add `deprecated/deprecated` rule",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@typespec/eslint-config-typespec"
+}

common/changes/@typespec/http/eslint-deprecated-rule_2023-05-03-16-47.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@typespec/http",
+      "comment": "Cleanup deprecated use",
+      "type": "none"
+    }
+  ],
+  "packageName": "@typespec/http"
+}

common/changes/@typespec/rest/eslint-deprecated-rule_2023-05-03-16-47.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@typespec/rest",
+      "comment": "Cleanup deprecated use",
+      "type": "none"
+    }
+  ],
+  "packageName": "@typespec/rest"
+}

common/config/rush/pnpm-lock.yaml

@@ -1,4 +1,5 @@
 import { printId } from "../../formatter/print/printer.js";
+import { isTemplateInstance } from "../type-utils.js";
 import {
   Enum,
   Interface,
@@ -39,7 +40,7 @@ export function getTypeName(type: Type, options?: TypeNameOptions): string {
     case "Union":
       return type.name
         ? getIdentifierName(type.name, options)
-        : type.options.map((x) => getTypeName(x, options)).join(" | ");
+        : [...type.variants.values()].map((x) => getTypeName(x.type, options)).join(" | ");
     case "UnionVariant":
       return getTypeName(type.type, options);
     case "Tuple":
@@ -119,9 +120,9 @@ function getModelName(model: Model, options: TypeNameOptions | undefined) {
     return nsPrefix + "(anonymous model)";
   }
   const modelName = nsPrefix + getIdentifierName(model.name, options);
-  if (model.templateArguments && model.templateArguments.length > 0) {
+  if (isTemplateInstance(model)) {
     // template instantiation
-    const args = model.templateArguments.map((x) => getTypeName(x, options));
+    const args = model.templateMapper.args.map((x) => getTypeName(x, options));
     return `${modelName}<${args.join(", ")}>`;
   } else if ((model.node as ModelStatementNode)?.templateParameters?.length > 0) {
     // template
@@ -159,8 +160,10 @@ function getModelPropertyName(prop: ModelProperty, options: TypeNameOptions | un
 
 function getInterfaceName(iface: Interface, options: TypeNameOptions | undefined) {
   let interfaceName = getIdentifierName(iface.name, options);
-  if (iface.templateArguments && iface.templateArguments.length > 0) {
-    interfaceName += `<${iface.templateArguments.map((x) => getTypeName(x, options)).join(", ")}>`;
+  if (isTemplateInstance(iface)) {
+    interfaceName += `<${iface.templateMapper.args
+      .map((x) => getTypeName(x, options))
+      .join(", ")}>`;
   }
   return `${getNamespacePrefix(iface.namespace, options)}${interfaceName}`;
 }

packages/compiler/core/helpers/type-name-utils.ts

@@ -8,9 +8,11 @@ export * from "./emitter-utils.js";
 export * from "./formatter.js";
 export * from "./helpers/index.js";
 export {
+  // eslint-disable-next-line deprecation/deprecation
   createCadlLibrary,
   createTypeSpecLibrary,
   paramMessage,
+  // eslint-disable-next-line deprecation/deprecation
   setCadlNamespace,
   setTypeSpecNamespace,
 } from "./library.js";

packages/compiler/core/index.ts

@@ -436,7 +436,7 @@ export function getPathFromPathComponents(pathComponents: readonly string[]) {
 export function removeTrailingDirectorySeparator(path: string): string;
 export function removeTrailingDirectorySeparator(path: string) {
   if (hasTrailingDirectorySeparator(path)) {
-    return path.substr(0, path.length - 1);
+    return path.substring(0, path.length - 1);
   }
 
   return path;

packages/compiler/core/path-utils.ts

@@ -335,10 +335,13 @@ export async function compile(
   if (resolvedMain) {
     let emit = options.emit;
     let emitterOptions = options.options;
+    /* eslint-disable deprecation/deprecation */
     if (options.emitters) {
       emit ??= Object.keys(options.emitters);
       emitterOptions ??= options.emitters;
     }
+    /* eslint-enable deprecation/deprecation */
+
     await loadEmitters(resolvedMain, emit ?? [], emitterOptions ?? {});
   }
 
@@ -1199,6 +1202,7 @@ export function createStateAccessors(
  * Resolve compiler options from input options.
  */
 function resolveOptions(options: CompilerOptions): CompilerOptions {
+  // eslint-disable-next-line deprecation/deprecation
   const outputDir = options.outputDir ?? options.outputPath;
   return {
     ...options,

packages/compiler/core/program.ts

@@ -272,6 +272,7 @@ export function createProjector(
 
     if (model.templateMapper) {
       projectedModel.templateMapper = projectTemplateMapper(model.templateMapper);
+      // eslint-disable-next-line deprecation/deprecation
       projectedModel.templateArguments = mutate(projectedModel.templateMapper.args);
     }
 
@@ -336,6 +337,7 @@ export function createProjector(
 
     if (scalar.templateMapper) {
       projectedScalar.templateMapper = projectTemplateMapper(scalar.templateMapper);
+      // eslint-disable-next-line deprecation/deprecation
       projectedScalar.templateArguments = mutate(projectedScalar.templateMapper.args);
     }
 
@@ -406,6 +408,7 @@ export function createProjector(
 
     if (op.templateMapper) {
       projectedOp.templateMapper = projectTemplateMapper(op.templateMapper);
+      // eslint-disable-next-line deprecation/deprecation
       projectedOp.templateArguments = mutate(projectedOp.templateMapper.args);
     }
 
@@ -436,6 +439,7 @@ export function createProjector(
 
     if (iface.templateMapper) {
       projectedIface.templateMapper = projectTemplateMapper(iface.templateMapper);
+      // eslint-disable-next-line deprecation/deprecation
       projectedIface.templateArguments = mutate(projectedIface.templateMapper.args);
     }
 
@@ -468,6 +472,7 @@ export function createProjector(
 
     if (union.templateMapper) {
       projectedUnion.templateMapper = projectTemplateMapper(union.templateMapper);
+      // eslint-disable-next-line deprecation/deprecation
       projectedUnion.templateArguments = mutate(projectedUnion.templateMapper.args);
     }