@foxglove/eslint-plugin/rules/prefer-hash-private.js

Foxglove ESLint rules and configuration

/**
 * @param {import("eslint").Rule.Node} node
 */
function getEnclosingClass(node) {
  for (let current = node; current; current = current.parent) {
    if (current.type === "ClassDeclaration") {
      return current;
    } else if (current.type === "FunctionDeclaration") {
      return undefined;
    } else if (
      current.type === "FunctionExpression" &&
      current.parent?.parent?.type !== "ClassBody"
    ) {
      return undefined;
    }
  }
  return undefined;
}

/** @type {import("eslint").Rule.RuleModule} */
module.exports = {
  meta: {
    type: "problem",
    fixable: "code",
    hasSuggestions: true,
    messages: {
      preferHash:
        "Prefer `{{newName}}` language feature over `private {{oldName}}` accessibility modifier",
      rename: "Rename to {{newName}}",
    },
  },
  create: (context) => {
    /**
     * @typedef ClassInfo
     * @property {Set<import("estree").Identifier & import("eslint").Rule.NodeParentExtension>} privates
     * @property {Map<string, import("estree").Identifier[]>} memberReferences
     */
    /**
     * @type {Map<import("estree").ClassDeclaration, ClassInfo>}
     */
    const infoByClass = new Map();
    return {
      // Track any references to properties inside the class body, e.g. `this.foo`.
      [`MemberExpression:has(ThisExpression.object) > Identifier.property`]: (
        /** @type {import("estree").Identifier & { parent: import("estree").MemberExpression & import("eslint").Rule.Node }} */ node
      ) => {
        if (node.parent.object.type !== "ThisExpression") {
          // Avoid treating `this.foo.bar` as a reference to `private bar`.
          // We'd prefer the selector to use `:has(> ThisExpression.object)`, but ESQuery doesn't support that syntax.
          return;
        }
        const cls = getEnclosingClass(node);
        if (!cls) {
          return;
        }
        let info = infoByClass.get(cls);
        if (!info) {
          info = { privates: new Set(), memberReferences: new Map() };
          infoByClass.set(cls, info);
        }
        let refs = info.memberReferences.get(node.name);
        if (!refs) {
          refs = [];
          info.memberReferences.set(node.name, refs);
        }
        refs.push(node);
      },

      // Track any private properties or methods on the class, e.g. `private foo`.
      [`:matches(PropertyDefinition, MethodDefinition[kind!="constructor"])[accessibility="private"] > Identifier.key`]:
        (
          /** @type {import("estree").Identifier & import("eslint").Rule.NodeParentExtension} */
          node
        ) => {
          const cls = getEnclosingClass(node);
          if (!cls) {
            throw new Error("Expected class around private definition");
          }

          let info = infoByClass.get(cls);
          if (!info) {
            info = { privates: new Set(), memberReferences: new Map() };
            infoByClass.set(cls, info);
          }
          info.privates.add(node);
        },

      // Once we have processed all properties and references in the whole class, emit any errors
      [`ClassDeclaration:exit`]: (node) => {
        const info = infoByClass.get(node);
        if (!info) {
          return;
        }

        for (const privateIdentifier of info.privates) {
          const refs = info.memberReferences.get(privateIdentifier.name) ?? [];

          const newName = "#" + privateIdentifier.name.replace(/^_/, "");
          context.report({
            node: privateIdentifier,
            messageId: "preferHash",
            data: { oldName: privateIdentifier.name, newName },
            suggest: [
              {
                messageId: "rename",
                data: { newName },
                *fix(fixer) {
                  const privateToken = context.sourceCode
                    .getTokens(privateIdentifier.parent)
                    .find(
                      (token) =>
                        token.type === "Keyword" && token.value === "private"
                    );
                  if (privateToken) {
                    yield fixer.removeRange([
                      privateToken.range[0],
                      privateToken.range[1] + 1,
                    ]);
                  }
                  yield fixer.replaceText(privateIdentifier, newName);
                  for (const ref of refs) {
                    yield fixer.replaceText(ref, newName);
                  }
                },
              },
            ],
          });
        }
      },
    };
  },
};