Minor refactoring

Author: fisker

src/ast-transform/transform-object-expression.ts

@@ -1,7 +1,8 @@
 import type * as angular from '@angular/compiler';
 import type * as babel from '@babel/types';
 
-import type { NGNode, RawNGSpan } from '../types.ts';
+import { type RawLocationInformation } from '../source.ts';
+import type { NGNode, Range } from '../types.ts';
 import { type Transformer } from './transform.ts';
 
 export const visitLiteralMap = (
@@ -11,18 +12,15 @@ export const visitLiteralMap = (
   const { keys, values } = node;
   const createChild = <T extends NGNode>(
     properties: Partial<T> & { type: T['type'] },
-    location: angular.AST | RawNGSpan | [number, number] = node,
+    location: RawLocationInformation = node,
   ) =>
     transformer.create(properties, location, [node, ...transformer.ancestors]);
 
   return {
     type: 'ObjectExpression',
     properties: keys.map((keyNode, index) => {
       const valueNode = values[index];
-      const range: [number, number] = [
-        keyNode.sourceSpan.start,
-        valueNode.sourceSpan.end,
-      ];
+      const range: Range = [keyNode.sourceSpan.start, valueNode.sourceSpan.end];
 
       if (keyNode.kind === 'spread') {
         return createChild<babel.SpreadElement>(

src/ast-transform/transform.ts

@@ -5,8 +5,8 @@ import {
   ParenthesizedExpression,
 } from '@angular/compiler';
 
-import { Source } from '../source.ts';
-import type { NGEmptyExpression, NGNode, RawNGSpan } from '../types.ts';
+import { type RawLocationInformation, Source } from '../source.ts';
+import type { NGEmptyExpression, NGNode } from '../types.ts';
 import { transformVisitor } from './visitor.ts';
 
 class NodeTransformer extends Source {
@@ -29,7 +29,7 @@ class NodeTransformer extends Source {
 
   create<T extends NGNode>(
     properties: Partial<T> & { type: T['type'] },
-    location: AST | RawNGSpan | [number, number],
+    location: RawLocationInformation,
     ancestors: AST[],
   ) {
     const node = super.createNode(properties, location);
@@ -46,7 +46,7 @@ class NodeTransformer extends Source {
 
   createNode<T extends NGNode>(
     properties: Partial<T> & { type: T['type'] },
-    location: AST | RawNGSpan | [number, number] = this.node,
+    location: RawLocationInformation = this.node,
     ancestorsToCreate: AST[] = this.ancestors,
   ) {
     return this.create(properties, location, ancestorsToCreate);

src/source.ts

@@ -1,9 +1,11 @@
-import * as angular from '@angular/compiler';
+import { type AST } from '@angular/compiler';
 import type * as babel from '@babel/types';
 
-import type { LocationInformation, NGNode, RawNGSpan } from './types.ts';
+import type { LocationInformation, NGNode, Range, StartEnd } from './types.ts';
 import { getCharacterIndex, sourceSpanToLocationInformation } from './utils.ts';
 
+export type RawLocationInformation = AST | StartEnd | Range;
+
 export class Source {
   text;
 
@@ -15,38 +17,51 @@ export class Source {
     return getCharacterIndex(this.text, pattern, index);
   }
 
-  transformSpan(span: RawNGSpan): LocationInformation {
+  transformSpan(span: StartEnd): LocationInformation {
     return sourceSpanToLocationInformation(span);
   }
 
   createNode<T extends NGNode>(
     properties: Partial<T> & { type: T['type'] },
-    location: angular.AST | RawNGSpan | [number, number],
+    location?: RawLocationInformation,
   ) {
-    let start: number;
-    let end: number;
-    let range: [number, number];
-    if (Array.isArray(location)) {
-      range = location;
-      [start, end] = location;
-    } else {
-      ({ start, end } =
-        location instanceof angular.AST ? location.sourceSpan : location);
+    let start: number | undefined | null = properties.start;
+    let end: number | undefined | null = properties.end;
+    let range: Range | undefined = properties.range;
+
+    if (location) {
+      if (Array.isArray(location)) {
+        [start, end] = location;
+        range = location;
+      } else {
+        ({ start, end } = (location as AST).sourceSpan ?? location);
+        range = [start, end];
+      }
+    }
+
+    if (range) {
+      [start, end] = range;
+    } else if (typeof start === 'number' && typeof end === 'number') {
       range = [start, end];
     }
 
+    /* c8 ignore next 3 @preserve */
+    if (!(typeof start === 'number' && typeof end === 'number' && range)) {
+      throw new Error('Missing location information');
+    }
+
     const node = {
+      ...properties,
       start,
       end,
       range,
-      ...properties,
     } as T & LocationInformation;
 
     switch (node.type) {
       case 'NumericLiteral':
       case 'StringLiteral':
       case 'RegExpLiteral': {
-        const raw = this.text.slice(node.start, node.end);
+        const raw = this.text.slice(start, end);
         const { value } = node as unknown as
           | babel.NumericLiteral
           | babel.StringLiteral;

src/transform-template-binding.ts

@@ -5,7 +5,7 @@ import {
 } from '@angular/compiler';
 
 import { transformAstNode } from './ast-transform/index.ts';
-import { Source } from './source.ts';
+import { type RawLocationInformation, Source } from './source.ts';
 import type {
   NGMicrosyntax,
   NGMicrosyntaxAs,
@@ -15,7 +15,7 @@ import type {
   NGMicrosyntaxLet,
   NGMicrosyntaxNode,
   NGNode,
-  RawNGSpan,
+  StartEnd,
 } from './types.ts';
 import { lowercaseFirst } from './utils.ts';
 
@@ -56,7 +56,7 @@ class TemplateBindingTransformer extends Source {
 
   #create<T extends NGNode>(
     properties: Partial<T> & { type: T['type'] },
-    location: angular.AST | RawNGSpan | [number, number],
+    location: RawLocationInformation,
   ) {
     return super.createNode<T>(properties, location);
   }
@@ -73,7 +73,7 @@ class TemplateBindingTransformer extends Source {
    * - "a"  (start=0 end=1) -> (start=0 end=3)
    * - '\'' (start=0 end=1) -> (start=0 end=4)
    */
-  #fixSpan(span: RawNGSpan) {
+  #fixSpan(span: StartEnd) {
     const text = this.#text;
     if (text[span.start] !== '"' && text[span.start] !== "'") {
       return;

src/types.ts

@@ -1,15 +1,16 @@
 import type * as babel from '@babel/types';
 
-export interface LocationInformation {
-  start: number;
-  end: number;
-  range: [number, number];
+export type Range = [number, number];
+export type StartEnd = { start: number; end: number };
+
+export type LocationInformation = StartEnd & {
+  range: Range;
   extra?: any;
-}
+};
 
-export interface NGBaseNode extends LocationInformation {
+export type NGBaseNode = LocationInformation & {
   type: string;
-}
+};
 
 export type NGOwnNode =
   | NGMicrosyntaxNode
@@ -37,11 +38,6 @@ export interface NGChainedExpression extends NGBaseNode {
   expressions: NGNode[];
 }
 
-export interface RawNGSpan {
-  start: number;
-  end: number;
-}
-
 /**
  *     Microsyntax ::
  *       ( ( Exp | Let ) ( Sep? ( Let | As | KeyExp ) )* Sep? Key? )?

src/utils.ts

@@ -1,4 +1,4 @@
-import type { LocationInformation, RawNGSpan } from './types.ts';
+import type { LocationInformation, StartEnd } from './types.ts';
 
 function getCharacterSearchTestFunction(pattern: RegExp | string) {
   if (typeof pattern === 'string') {
@@ -36,7 +36,7 @@ export function lowercaseFirst(str: string) {
 }
 
 export function sourceSpanToLocationInformation(
-  span: RawNGSpan,
+  span: StartEnd,
 ): LocationInformation {
   const { start, end } = span;
   return {