refactor: rename reference to ref

Author: mdjastrzebski

src/__tests__/example-html-tags.ts

@@ -6,15 +6,15 @@ import {
   charRange,
   digit,
   oneOrMore,
-  reference,
+  ref,
   zeroOrMore,
 } from '..';
 
 test('example: html tag matching', () => {
   const tagName = oneOrMore(charClass(charRange('a', 'z'), digit));
   const tagContent = zeroOrMore(any, { greedy: false });
 
-  const tagRef = reference('tag');
+  const tagRef = ref('tag');
   const tagMatcher = buildRegExp(
     [
       '<',

src/constructs/__tests__/capture.test.tsx

@@ -6,7 +6,7 @@ import {
   digit,
   inverted,
   oneOrMore,
-  reference,
+  ref,
   word,
   wordBoundary,
 } from '../..';
@@ -50,21 +50,21 @@ test('named `capture` matching', () => {
 });
 
 // Should have `ref0` as name.
-const firstRef = reference();
+const firstRef = ref();
 
 test('`reference` pattern', () => {
   expect([firstRef]).toEqualRegex(/\k<ref0>/);
-  expect([reference('xyz')]).toEqualRegex(/\k<xyz>/);
+  expect([ref('xyz')]).toEqualRegex(/\k<xyz>/);
   expect([capture(any, { name: firstRef }), ' ', firstRef]).toEqualRegex('(?<ref0>.) \\k<ref0>');
 
-  const otherRef = reference('r123');
+  const otherRef = ref('r123');
   expect(['xx', capture(any, { name: otherRef }), ' ', otherRef, 'xx']).toEqualRegex(
     'xx(?<r123>.) \\k<r123>xx',
   );
 });
 
 test('`reference` matching basic case', () => {
-  const someRef = reference();
+  const someRef = ref();
   expect([capture(word, { name: someRef }), someRef]).toMatchString('aa');
   expect([capture(digit, { name: someRef }), someRef]).toMatchString('11');
 
@@ -75,7 +75,7 @@ test('`reference` matching basic case', () => {
 });
 
 test('`reference` matching HTML attributes', () => {
-  const quoteRef = reference('quote');
+  const quoteRef = ref('quote');
   const quote = anyOf('"\'');
   const htmlAttributeRegex = buildRegExp([
     wordBoundary,

src/constructs/capture.ts

@@ -11,7 +11,7 @@ export interface Capture extends RegexConstruct {
 
 export type CaptureOptions = {
   /**
-   * Name to be given to the capturing group can either by a string or {@link reference} instance.
+   * Name to be given to the capturing group can either by a string or {@link ref} instance.
    */
   name: string | Reference;
 };
@@ -24,7 +24,7 @@ export interface Reference extends RegexConstruct {
 /**
  * Creates a capturing group which allows the matched pattern to be available:
  * - in the match results (`String.match`, `String.matchAll`, or `RegExp.exec`)
- * - in the regex itself, through {@link reference}
+ * - in the regex itself, through {@link ref}
  */
 export function capture(sequence: RegexSequence, options?: CaptureOptions): Capture {
   return {
@@ -44,7 +44,7 @@ let counter = 0;
  *
  * @param name - Name to be given to the capturing group which receives this reference. If not provided, a unique name will be generated.
  */
-export function reference(name?: string): Reference {
+export function ref(name?: string): Reference {
   return {
     type: 'reference',
     name: name ?? `ref${counter++}`,

src/index.ts

@@ -15,7 +15,7 @@ export {
   startOfString,
   wordBoundary,
 } from './constructs/anchors';
-export { capture, reference } from './constructs/capture';
+export { capture, ref } from './constructs/capture';
 export {
   any,
   anyOf,

website/docs/api/captures.md

@@ -35,10 +35,10 @@ TS Regex Builder does not have a construct for non-capturing groups. Such groups
 
 :::
 
-### `reference()`
+### `ref()`
 
 ```ts
-function reference(
+function ref(
   name?: string;
 ): Reference;
 ```
@@ -53,13 +53,13 @@ Usage with `capture()`:
 
 ```ts
 // Define reference with name "some".
-const someRef = reference('some');
+const someRef = ref('some');
 
 const regex = buildRegExp([
   // Create a named capture using name from `someRef`.
-  capture(..., { name: someRef}),
+  capture(..., { name: someRef }),
   // ... some other elements ...
-  // Match the same text as captured in capture using `someRef`.
+  // Match the same text as captured in a `capture` using `someRef`.
   someRef,
   ])
 ```