Refactor: rename ThisFields as ClassFields

Author: qnighy

src/analysis.ts

@@ -2,7 +2,7 @@ import type { NodePath } from "@babel/core";
 import type { Scope } from "@babel/traverse";
 import type { ClassDeclaration, ClassMethod, Identifier, JSXIdentifier, TSType, TSTypeParameterDeclaration } from "@babel/types";
 import { AnalysisError } from "./analysis/error.js";
-import { analyzeThisFields } from "./analysis/this_fields.js";
+import { analyzeClassFields } from "./analysis/this_fields.js";
 import { analyzeState, StateObjAnalysis } from "./analysis/state.js";
 import { getAndDelete } from "./utils.js";
 import { analyzeProps, PropsObjAnalysis } from "./analysis/prop.js";
@@ -49,7 +49,7 @@ export function analyzeClass(
   preanalysis: PreAnalysisResult
 ): AnalysisResult {
   const locals = new LocalManager(path);
-  const { thisFields: sites, staticFields } = analyzeThisFields(path);
+  const { instanceFields: sites, staticFields } = analyzeClassFields(path);
 
   const propsObjSites = getAndDelete(sites, "props") ?? [];
   const defaultPropsObjSites = getAndDelete(staticFields, "defaultProps") ?? [];

src/analysis/prop.ts

@@ -4,7 +4,7 @@ import type { Expression, MemberExpression, TSMethodSignature, TSPropertySignatu
 import { getOr, memberName } from "../utils.js";
 import { AnalysisError } from "./error.js";
 import type { LocalManager } from "./local.js";
-import { StaticFieldSite, ThisFieldSite } from "./this_fields.js";
+import { StaticFieldSite, InstanceFieldSite } from "./this_fields.js";
 import { trackMember } from "./track_member.js";
 import { PreAnalysisResult } from "./pre.js";
 
@@ -55,7 +55,7 @@ export type PropAlias = {
  * ```
  */
 export function analyzeProps(
-  propsObjSites: ThisFieldSite[],
+  propsObjSites: InstanceFieldSite[],
   defaultPropsObjSites: StaticFieldSite[],
   locals: LocalManager,
   preanalysis: PreAnalysisResult,

src/analysis/state.ts

@@ -4,7 +4,7 @@ import { getOr, memberName } from "../utils.js";
 import { AnalysisError } from "./error.js";
 import { PreAnalysisResult } from "./pre.js";
 import type { LocalManager } from "./local.js";
-import type { ThisFieldSite } from "./this_fields.js";
+import type { InstanceFieldSite } from "./this_fields.js";
 import { trackMember } from "./track_member.js";
 
 export type StateObjAnalysis = Map<string, StateAnalysis>;
@@ -44,8 +44,8 @@ export type StateTypeAnnotation = {
 };
 
 export function analyzeState(
-  stateObjSites: ThisFieldSite[],
-  setStateSites: ThisFieldSite[],
+  stateObjSites: InstanceFieldSite[],
+  setStateSites: InstanceFieldSite[],
   locals: LocalManager,
   preanalysis: PreAnalysisResult,
 ): StateObjAnalysis {

src/analysis/this_fields.ts

@@ -11,17 +11,17 @@ import { AnalysisError } from "./error.js";
 /**
  * Aggregated result of class field analysis.
  */
-export type ThisFields = {
+export type ClassFieldsAnalysis = {
   /** Access to instance fields (`this.foo`), indexed by their names. */
-  thisFields: Map<string, ThisFieldSite[]>;
+  instanceFields: Map<string, InstanceFieldSite[]>;
   /** Access to static fields (`C.foo`, where `C` is the class), indexed by their names. */
   staticFields: Map<string, StaticFieldSite[]>;
 };
 
 /**
  * A place where the instance field is declared or used.
  */
-export type ThisFieldSite = {
+export type InstanceFieldSite = {
   type: "class_field";
   /**
    * Declaration. One of:
@@ -121,9 +121,9 @@ export type StaticFieldSite = {
  * - Instance fields ... `this.foo`
  * - Static fields ... `C.foo`, where `C` is the class
  */
-export function analyzeThisFields(path: NodePath<ClassDeclaration>): ThisFields {
-  const thisFields = new Map<string, ThisFieldSite[]>();
-  const getThisField = (name: string) => getOr(thisFields, name, () => []);
+export function analyzeClassFields(path: NodePath<ClassDeclaration>): ClassFieldsAnalysis {
+  const instanceFields = new Map<string, InstanceFieldSite[]>();
+  const getInstanceField = (name: string) => getOr(instanceFields, name, () => []);
   const staticFields = new Map<string, StaticFieldSite[]>();
   const getStaticField = (name: string) => getOr(staticFields, name, () => []);
   let constructor: NodePath<ClassMethod> | undefined = undefined;
@@ -137,7 +137,7 @@ export function analyzeThisFields(path: NodePath<ClassDeclaration>): ThisFields
       if (name == null) {
         throw new AnalysisError(`Unnamed class element`);
       }
-      const field = isStatic ? getStaticField(name) : getThisField(name);
+      const field = isStatic ? getStaticField(name) : getInstanceField(name);
       if (isClassPropertyLike(itemPath)) {
         // Class field.
         // - May have an initializer: `foo = 42;` or not: `foo;`
@@ -273,7 +273,7 @@ export function analyzeThisFields(path: NodePath<ClassDeclaration>): ThisFields
       }
       // TODO: check for parameter/local variable reference
 
-      const field = getThisField(name)!;
+      const field = getInstanceField(name)!;
       field.push({
         type: "class_field",
         path: exprPath,
@@ -305,7 +305,7 @@ export function analyzeThisFields(path: NodePath<ClassDeclaration>): ThisFields
         throw new AnalysisError(`Unrecognized this-property reference`);
       }
 
-      const field = getThisField(name)!;
+      const field = getInstanceField(name)!;
 
       const thisMemberParentPath = thisMemberPath.parentPath;
       const hasWrite =
@@ -334,9 +334,9 @@ export function analyzeThisFields(path: NodePath<ClassDeclaration>): ThisFields
   }
 
   // Post validation
-  for (const [name, fieldSites] of thisFields) {
+  for (const [name, fieldSites] of instanceFields) {
     if (fieldSites.length === 0) {
-      thisFields.delete(name);
+      instanceFields.delete(name);
     }
     const numInits = fieldSites.reduce((n, site) => n + Number(!!site.init), 0);
     if (numInits > 1) {
@@ -349,7 +349,7 @@ export function analyzeThisFields(path: NodePath<ClassDeclaration>): ThisFields
   }
   for (const [name, fieldSites] of staticFields) {
     if (fieldSites.length === 0) {
-      thisFields.delete(name);
+      instanceFields.delete(name);
     }
     const numInits = fieldSites.reduce((n, site) => n + Number(!!site.init), 0);
     if (numInits > 1) {
@@ -361,7 +361,7 @@ export function analyzeThisFields(path: NodePath<ClassDeclaration>): ThisFields
     }
   }
 
-  return { thisFields, staticFields };
+  return { instanceFields, staticFields };
 }
 
 function traverseThis(path: NodePath, visit: (path: NodePath<ThisExpression>) => void) {

src/analysis/user_defined.ts

@@ -3,7 +3,7 @@ import { ArrowFunctionExpression, ClassMethod, ClassPrivateMethod, Expression, F
 import { isClassMethodLike, nonNullPath } from "../utils.js";
 import { AnalysisError } from "./error.js";
 import { analyzeLibRef, isReactRef } from "./lib.js";
-import type { ThisFieldSite } from "./this_fields.js";
+import type { InstanceFieldSite } from "./this_fields.js";
 
 const SPECIAL_MEMBER_NAMES = new Set<string>([
   // Special variables
@@ -49,21 +49,21 @@ export type UserDefinedRef = {
   type: "user_defined_ref";
   localName?: string | undefined;
   typeAnnotation?: NodePath<TSType> | undefined;
-  sites: ThisFieldSite[];
+  sites: InstanceFieldSite[];
 };
 export type UserDefinedDirectRef = {
   type: "user_defined_direct_ref";
   localName?: string | undefined;
   init: NodePath<Expression>;
   typeAnnotation?: NodePath<TSType> | undefined;
-  sites: ThisFieldSite[];
+  sites: InstanceFieldSite[];
 };
 export type UserDefinedFn = {
   type: "user_defined_function";
   localName?: string | undefined;
   init: FnInit;
   typeAnnotation?: NodePath<TSType> | undefined;
-  sites: ThisFieldSite[];
+  sites: InstanceFieldSite[];
 };
 
 export type FnInit = {
@@ -75,10 +75,10 @@ export type FnInit = {
 };
 
 export function analyzeUserDefined(
-  thisFields: Map<string, ThisFieldSite[]>
+  instanceFields: Map<string, InstanceFieldSite[]>
 ): UserDefinedAnalysis {
   const fields = new Map<string, UserDefined>();
-  for (const [name, fieldSites]  of thisFields) {
+  for (const [name, fieldSites]  of instanceFields) {
     if (SPECIAL_MEMBER_NAMES.has(name)) {
       throw new AnalysisError(`Cannot transform ${name}`);
     }