refactor: rename notWordBoundery

Author: mdjastrzebski

src/__tests__/example-find-suffixes.ts

@@ -1,10 +1,10 @@
-import { buildRegExp, choiceOf, notWordBoundary, wordBoundary } from '..';
+import { buildRegExp, choiceOf, nonWordBoundary, wordBoundary } from '..';
 
 test('example: find words with suffix', () => {
   const suffixesToFind = ['acy', 'ism'];
 
   const regex = buildRegExp([
-    notWordBoundary, // match suffixes only
+    nonWordBoundary, // match suffixes only
     choiceOf(...suffixesToFind),
     wordBoundary,
   ]);

src/constructs/__tests__/anchors.test.tsx

@@ -3,7 +3,7 @@ import {
   digit,
   endOfString,
   nonWhitespace,
-  notWordBoundary,
+  nonWordBoundary,
   oneOrMore,
   startOfString,
   wordBoundary,
@@ -43,20 +43,20 @@ test('`wordBoundary` matching', () => {
   ).toMatchGroups('a ba ab aa', ['a', 'ba', 'aa']);
 });
 
-test('`notWordBoundary` pattern', () => {
-  expect(notWordBoundary).toEqualRegex(/\B/);
-  expect([notWordBoundary, 'a', 'b']).toEqualRegex(/\Bab/);
-  expect(['a', notWordBoundary, 'b']).toEqualRegex(/a\Bb/);
-  expect(['a', 'b', notWordBoundary]).toEqualRegex(/ab\B/);
+test('`nonWordBoundary` pattern', () => {
+  expect(nonWordBoundary).toEqualRegex(/\B/);
+  expect([nonWordBoundary, 'a', 'b']).toEqualRegex(/\Bab/);
+  expect(['a', nonWordBoundary, 'b']).toEqualRegex(/a\Bb/);
+  expect(['a', 'b', nonWordBoundary]).toEqualRegex(/ab\B/);
 });
 
-test('`notWordBoundary` matching', () => {
-  expect(buildRegExp([notWordBoundary, 'abc', digit], { global: true })).toMatchGroups(
+test('`nonWordBoundary` matching', () => {
+  expect(buildRegExp([nonWordBoundary, 'abc', digit], { global: true })).toMatchGroups(
     'abc1 xabc2 xxabc3',
     ['abc2', 'abc3'],
   );
 
-  expect(buildRegExp([digit, 'abc', notWordBoundary], { global: true })).toMatchGroups(
+  expect(buildRegExp([digit, 'abc', nonWordBoundary], { global: true })).toMatchGroups(
     '1abc 2abcx 3abcxx',
     ['2abc', '3abc'],
   );

src/constructs/anchors.ts

@@ -24,12 +24,17 @@ export const wordBoundary: Anchor = {
   encode: encodeAnchor,
 };
 
-export const notWordBoundary: Anchor = {
+export const nonWordBoundary: Anchor = {
   type: 'anchor',
   symbol: '\\B',
   encode: encodeAnchor,
 };
 
+/**
+ * @deprecated Renamed to `nonWordBoundary`.
+ */
+export const notWordBoundary = nonWordBoundary;
+
 function encodeAnchor(this: Anchor): EncodeResult {
   return {
     precedence: 'sequence',

src/index.ts

@@ -2,7 +2,13 @@ export type * from './types';
 
 export { buildPattern, buildRegExp } from './builders';
 
-export { endOfString, notWordBoundary, startOfString, wordBoundary } from './constructs/anchors';
+export {
+  endOfString,
+  nonWordBoundary,
+  notWordBoundary,
+  startOfString,
+  wordBoundary,
+} from './constructs/anchors';
 export { capture } from './constructs/capture';
 export {
   any,

website/docs/Examples.md

@@ -280,7 +280,7 @@ Ignoring cases where given word is part of a bigger word.
 const suffixesToFind = ['acy', 'ism'];
 
 const regex = buildRegExp([
-  notWordBoundary, // match suffixes only
+  nonWordBoundary, // match suffixes only
   choiceOf(...suffixesToFind),
   wordBoundary,
 ]);