refactor: raname RegexComponentResult (#44)

Author: mdjastrzebski

src/components/anchors.ts

@@ -1,7 +1,7 @@
 import type { EncodeOutput } from '../encoder/types';
-import type { RegexEncodable } from '../types';
+import type { RegexComponentResult } from '../types';
 
-export interface Anchor extends RegexEncodable {
+export interface Anchor extends RegexComponentResult {
   type: 'anchor';
   symbol: string;
 }

src/components/capture.ts

@@ -1,9 +1,9 @@
 import { encodeSequence } from '../encoder/encoder';
 import type { EncodeOutput } from '../encoder/types';
 import { asNodeArray } from '../utils/nodes';
-import type { RegexElement, RegexEncodable, RegexSequence } from '../types';
+import type { RegexComponentResult, RegexElement, RegexSequence } from '../types';
 
-export interface Capture extends RegexEncodable {
+export interface Capture extends RegexComponentResult {
   type: 'capture';
   children: RegexElement[];
 }

src/components/choice-of.ts

@@ -1,9 +1,9 @@
 import { encodeSequence } from '../encoder/encoder';
 import type { EncodeOutput } from '../encoder/types';
 import { asNodeArray } from '../utils/nodes';
-import type { RegexElement, RegexEncodable, RegexSequence } from '../types';
+import type { RegexComponentResult, RegexElement, RegexSequence } from '../types';
 
-export interface ChoiceOf extends RegexEncodable {
+export interface ChoiceOf extends RegexComponentResult {
   type: 'choiceOf';
   alternatives: RegexElement[][];
 }

src/components/quantifiers.ts

@@ -1,19 +1,19 @@
 import { encodeAtom } from '../encoder/encoder';
 import type { EncodeOutput } from '../encoder/types';
 import { asNodeArray } from '../utils/nodes';
-import type { RegexElement, RegexEncodable, RegexSequence } from '../types';
+import type { RegexComponentResult, RegexElement, RegexSequence } from '../types';
 
-export interface OneOrMore extends RegexEncodable {
+export interface OneOrMore extends RegexComponentResult {
   type: 'oneOrMore';
   children: RegexElement[];
 }
 
-export interface Optionally extends RegexEncodable {
+export interface Optionally extends RegexComponentResult {
   type: 'optionally';
   children: RegexElement[];
 }
 
-export interface ZeroOrMore extends RegexEncodable {
+export interface ZeroOrMore extends RegexComponentResult {
   type: 'zeroOrMore';
   children: RegexElement[];
 }

src/components/repeat.ts

@@ -1,9 +1,9 @@
 import { encodeAtom } from '../encoder/encoder';
 import type { EncodeOutput } from '../encoder/types';
 import { asNodeArray } from '../utils/nodes';
-import type { RegexElement, RegexEncodable, RegexSequence } from '../types';
+import type { RegexComponentResult, RegexElement, RegexSequence } from '../types';
 
-export interface Repeat extends RegexEncodable {
+export interface Repeat extends RegexComponentResult {
   type: 'repeat';
   options: RepeatOptions;
   children: RegexElement[];

src/types.ts

@@ -1,19 +1,23 @@
 import type { EncodeOutput } from './encoder/types';
 
 /**
- * Sequence of `RegexElements` that can be encoded into a regular expression.
+ * Sequence of regex elements that can be encoded into a regular expression.
+ *
+ * Typically passed as an array of elements but can be a single element to
+ * improve readability.
  */
 export type RegexSequence = RegexElement[] | RegexElement;
 
 /**
- * Represents a result of calling a regex component (`RegexEncodable`) or a string to be matched literally.
+ * Represents a result of calling a regex component or a string to be matched
+ * literally.
  */
-export type RegexElement = RegexEncodable | string;
+export type RegexElement = RegexComponentResult | string;
 
 /**
  * Represents result of calling a regex componen.
  */
-export interface RegexEncodable {
+export interface RegexComponentResult {
   type: string;
   encode(): EncodeOutput;
 }

test-utils/utils.ts

@@ -1,11 +1,11 @@
 import { buildRegex } from '../src/builders';
-import type { RegexElement, RegexEncodable } from '../src/types';
+import type { RegexComponentResult, RegexElement } from '../src/types';
 
 export function isRegexElement(node: unknown): node is RegexElement {
-  return typeof node === 'string' || isRegexEncodable(node);
+  return typeof node === 'string' || isRegexComponentResult(node);
 }
 
-export function isRegexEncodable(element: unknown): element is RegexEncodable {
+export function isRegexComponentResult(element: unknown): element is RegexComponentResult {
   return (
     typeof element === 'object' &&
     element !== null &&