From 22422359fd9728e1fb02f954337e3db8458394da Mon Sep 17 00:00:00 2001 From: Joe Date: Fri, 2 Aug 2024 15:48:40 -0700 Subject: [PATCH] chore(release): 0.4.0 --- CHANGELOG.md | 15 ++++++ docs/reference/README.md | 54 +++++++++---------- docs/reference/classes/DataSet.md | 10 ++-- docs/reference/classes/ParserError.md | 8 +-- docs/reference/classes/PhraseBuilder.md | 8 +-- docs/reference/classes/RegExpMatcher.md | 6 +-- docs/reference/classes/TextCensor.md | 4 +- docs/reference/enums/SyntaxKind.md | 8 +-- docs/reference/interfaces/BlacklistedTerm.md | 4 +- .../interfaces/BoundaryAssertionNode.md | 2 +- .../CollapseDuplicatesTransformerOptions.md | 4 +- docs/reference/interfaces/LiteralNode.md | 4 +- docs/reference/interfaces/MatchPayload.md | 8 +-- docs/reference/interfaces/Matcher.md | 4 +- docs/reference/interfaces/OptionalNode.md | 4 +- docs/reference/interfaces/ParsedPattern.md | 6 +-- docs/reference/interfaces/PhraseContainer.md | 6 +-- ...sedCollapseDuplicatesTransformerOptions.md | 4 +- .../interfaces/RegExpMatcherOptions.md | 8 +-- docs/reference/interfaces/WildcardNode.md | 2 +- package.json | 2 +- 21 files changed, 93 insertions(+), 78 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1dc5b70..cd36942 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,21 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [0.4.0](https://github.com/jo3-l/obscenity/compare/v0.3.1...v0.4.0) (2024-08-02) + + +### ⚠ BREAKING CHANGES + +* **regexp-matcher:** Passing an empty whitelisted term to the RegExpMatcher will result in a runtime error. + +This was unsupported previously and likely did not work correctly. Make it a real error. + +### Bug Fixes + +* **regexp-matcher:** advance index correctly in whitelist matcher ([ebf95ad](https://github.com/jo3-l/obscenity/commit/ebf95add62be8297f693ca6d8aafefc10afc1a8b)), closes [#49](https://github.com/jo3-l/obscenity/issues/49) +* **regexp-matcher:** correctly remap to original indices in all cases ([3a49579](https://github.com/jo3-l/obscenity/commit/3a49579f3c242d3e159e88707df090e3f6dc0121)), closes [#71](https://github.com/jo3-l/obscenity/issues/71) +* **regexp-matcher:** reject empty whitelist terms ([9a46113](https://github.com/jo3-l/obscenity/commit/9a461130b98920e22d5acf92650146ae48d2226b)) + ### [0.3.1](https://github.com/jo3-l/obscenity/compare/v0.3.0...v0.3.1) (2024-07-17) ## [0.3.0](https://github.com/jo3-l/obscenity/compare/v0.2.2...v0.3.0) (2024-07-17) diff --git a/docs/reference/README.md b/docs/reference/README.md index 9df4a8c..c428ac9 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -77,7 +77,7 @@ Context passed to [[TextCensorStrategy | text censoring strategies]]. #### Defined in -[src/censor/TextCensor.ts:104](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/TextCensor.ts#L104) +[src/censor/TextCensor.ts:104](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/TextCensor.ts#L104) ___ @@ -91,7 +91,7 @@ should be a set of characters that map to the transformed character. #### Defined in -[src/transformer/remap-characters/index.ts:60](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/remap-characters/index.ts#L60) +[src/transformer/remap-characters/index.ts:60](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/remap-characters/index.ts#L60) ___ @@ -103,7 +103,7 @@ All the profane words that are included in the [[englishDataset | english datase #### Defined in -[src/preset/english.ts:418](https://github.com/jo3-l/obscenity/blob/37976b6/src/preset/english.ts#L418) +[src/preset/english.ts:418](https://github.com/jo3-l/obscenity/blob/f14df6c/src/preset/english.ts#L418) ___ @@ -121,7 +121,7 @@ Extends the default match payload by adding phrase metadata. #### Defined in -[src/dataset/DataSet.ts:190](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L190) +[src/dataset/DataSet.ts:190](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L190) ___ @@ -133,7 +133,7 @@ All the possible kinds of nodes. #### Defined in -[src/pattern/Nodes.ts:24](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L24) +[src/pattern/Nodes.ts:24](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L24) ___ @@ -160,7 +160,7 @@ replacement string. #### Defined in -[src/censor/TextCensor.ts:99](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/TextCensor.ts#L99) +[src/censor/TextCensor.ts:99](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/TextCensor.ts#L99) ## Variables @@ -221,7 +221,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #### Defined in -[src/preset/english.ts:103](https://github.com/jo3-l/obscenity/blob/37976b6/src/preset/english.ts#L103) +[src/preset/english.ts:103](https://github.com/jo3-l/obscenity/blob/f14df6c/src/preset/english.ts#L103) ___ @@ -234,7 +234,7 @@ A set of transformers to be used when matching blacklisted patterns with the #### Defined in -[src/preset/english.ts:13](https://github.com/jo3-l/obscenity/blob/37976b6/src/preset/english.ts#L13) +[src/preset/english.ts:13](https://github.com/jo3-l/obscenity/blob/f14df6c/src/preset/english.ts#L13) ___ @@ -247,7 +247,7 @@ dataset]] and the [[RegExpMatcher]]. #### Defined in -[src/preset/english.ts:48](https://github.com/jo3-l/obscenity/blob/37976b6/src/preset/english.ts#L48) +[src/preset/english.ts:48](https://github.com/jo3-l/obscenity/blob/f14df6c/src/preset/english.ts#L48) ___ @@ -260,7 +260,7 @@ A set of transformers to be used when matching whitelisted terms with the #### Defined in -[src/preset/english.ts:36](https://github.com/jo3-l/obscenity/blob/37976b6/src/preset/english.ts#L36) +[src/preset/english.ts:36](https://github.com/jo3-l/obscenity/blob/f14df6c/src/preset/english.ts#L36) ## Functions @@ -299,7 +299,7 @@ to the [[RegExpMatcher]]. #### Defined in -[src/matcher/BlacklistedTerm.ts:37](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/BlacklistedTerm.ts#L37) +[src/matcher/BlacklistedTerm.ts:37](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/BlacklistedTerm.ts#L37) ___ @@ -326,7 +326,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:71](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/BuiltinStrategies.ts#L71) +[src/censor/BuiltinStrategies.ts:71](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/BuiltinStrategies.ts#L71) ___ @@ -389,7 +389,7 @@ A container holding the transformer, which can then be passed to the #### Defined in -[src/transformer/collapse-duplicates/index.ts:46](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/collapse-duplicates/index.ts#L46) +[src/transformer/collapse-duplicates/index.ts:46](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/collapse-duplicates/index.ts#L46) ___ @@ -430,7 +430,7 @@ than the first. #### Defined in -[src/matcher/MatchPayload.ts:57](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/MatchPayload.ts#L57) +[src/matcher/MatchPayload.ts:57](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/MatchPayload.ts#L57) ___ @@ -464,7 +464,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:134](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/BuiltinStrategies.ts#L134) +[src/censor/BuiltinStrategies.ts:134](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/BuiltinStrategies.ts#L134) ___ @@ -508,7 +508,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:115](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/BuiltinStrategies.ts#L115) +[src/censor/BuiltinStrategies.ts:115](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/BuiltinStrategies.ts#L115) ___ @@ -537,7 +537,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:89](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/BuiltinStrategies.ts#L89) +[src/censor/BuiltinStrategies.ts:89](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/BuiltinStrategies.ts#L89) ___ @@ -571,7 +571,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:51](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/BuiltinStrategies.ts#L51) +[src/censor/BuiltinStrategies.ts:51](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/BuiltinStrategies.ts#L51) ___ @@ -616,7 +616,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:28](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/BuiltinStrategies.ts#L28) +[src/censor/BuiltinStrategies.ts:28](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/BuiltinStrategies.ts#L28) ___ @@ -651,7 +651,7 @@ The parsed pattern, which can then be used with the #### Defined in -[src/pattern/Pattern.ts:130](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Pattern.ts#L130) +[src/pattern/Pattern.ts:130](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Pattern.ts#L130) ___ @@ -784,7 +784,7 @@ The parsed pattern, which can then be used with the #### Defined in -[src/pattern/Pattern.ts:106](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Pattern.ts#L106) +[src/pattern/Pattern.ts:106](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Pattern.ts#L106) ___ @@ -818,7 +818,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:155](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/BuiltinStrategies.ts#L155) +[src/censor/BuiltinStrategies.ts:155](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/BuiltinStrategies.ts#L155) ___ @@ -878,7 +878,7 @@ A container holding the transformer, which can then be passed to the #### Defined in -[src/transformer/remap-characters/index.ts:38](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/remap-characters/index.ts#L38) +[src/transformer/remap-characters/index.ts:38](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/remap-characters/index.ts#L38) ___ @@ -911,7 +911,7 @@ A container holding the transformer, which can then be passed to the #### Defined in -[src/transformer/resolve-confusables/index.ts:22](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/resolve-confusables/index.ts#L22) +[src/transformer/resolve-confusables/index.ts:22](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/resolve-confusables/index.ts#L22) ___ @@ -945,7 +945,7 @@ A container holding the transformer, which can then be passed to the #### Defined in -[src/transformer/resolve-leetspeak/index.ts:23](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/resolve-leetspeak/index.ts#L23) +[src/transformer/resolve-leetspeak/index.ts:23](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/resolve-leetspeak/index.ts#L23) ___ @@ -987,7 +987,7 @@ A container holding the transformer, which can then be passed to the #### Defined in -[src/transformer/skip-non-alphabetic/index.ts:31](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/skip-non-alphabetic/index.ts#L31) +[src/transformer/skip-non-alphabetic/index.ts:31](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/skip-non-alphabetic/index.ts#L31) ___ @@ -1014,4 +1014,4 @@ A container holding the transformer, which can then be passed to the #### Defined in -[src/transformer/to-ascii-lowercase/index.ts:18](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/to-ascii-lowercase/index.ts#L18) +[src/transformer/to-ascii-lowercase/index.ts:18](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/to-ascii-lowercase/index.ts#L18) diff --git a/docs/reference/classes/DataSet.md b/docs/reference/classes/DataSet.md index 0222217..9f3777b 100644 --- a/docs/reference/classes/DataSet.md +++ b/docs/reference/classes/DataSet.md @@ -63,7 +63,7 @@ const customDataset = new DataSet().addAll(englishDataset); #### Defined in -[src/dataset/DataSet.ts:29](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L29) +[src/dataset/DataSet.ts:29](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L29) ___ @@ -96,7 +96,7 @@ const data = new DataSet<{ originalWord: string }>() #### Defined in -[src/dataset/DataSet.ts:75](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L75) +[src/dataset/DataSet.ts:75](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L75) ___ @@ -122,7 +122,7 @@ const matcher = new RegExpMatcher({ #### Defined in -[src/dataset/DataSet.ts:118](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L118) +[src/dataset/DataSet.ts:118](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L118) ___ @@ -154,7 +154,7 @@ const phraseMetadata = matchesWithPhraseMetadata[0].phraseMetadata; #### Defined in -[src/dataset/DataSet.ts:94](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L94) +[src/dataset/DataSet.ts:94](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L94) ___ @@ -184,4 +184,4 @@ const customDataset = new DataSet<{ originalWord: string }>() #### Defined in -[src/dataset/DataSet.ts:46](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L46) +[src/dataset/DataSet.ts:46](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L46) diff --git a/docs/reference/classes/ParserError.md b/docs/reference/classes/ParserError.md index 862f01e..0d7826e 100644 --- a/docs/reference/classes/ParserError.md +++ b/docs/reference/classes/ParserError.md @@ -44,7 +44,7 @@ Error.constructor #### Defined in -[src/pattern/ParserError.ts:18](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/ParserError.ts#L18) +[src/pattern/ParserError.ts:18](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/ParserError.ts#L18) ## Properties @@ -57,7 +57,7 @@ Note that surrogate pairs are counted as 1 column wide, not 2. #### Defined in -[src/pattern/ParserError.ts:16](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/ParserError.ts#L16) +[src/pattern/ParserError.ts:16](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/ParserError.ts#L16) ___ @@ -69,7 +69,7 @@ The line on which the error occurred (one-based). #### Defined in -[src/pattern/ParserError.ts:10](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/ParserError.ts#L10) +[src/pattern/ParserError.ts:10](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/ParserError.ts#L10) ___ @@ -97,7 +97,7 @@ Error.name #### Defined in -[src/pattern/ParserError.ts:5](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/ParserError.ts#L5) +[src/pattern/ParserError.ts:5](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/ParserError.ts#L5) ___ diff --git a/docs/reference/classes/PhraseBuilder.md b/docs/reference/classes/PhraseBuilder.md index de5e23b..7f001ba 100644 --- a/docs/reference/classes/PhraseBuilder.md +++ b/docs/reference/classes/PhraseBuilder.md @@ -55,7 +55,7 @@ Associates a pattern with this phrase. #### Defined in -[src/dataset/DataSet.ts:149](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L149) +[src/dataset/DataSet.ts:149](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L149) ___ @@ -77,7 +77,7 @@ Associates a whitelisted pattern with this phrase. #### Defined in -[src/dataset/DataSet.ts:159](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L159) +[src/dataset/DataSet.ts:159](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L159) ___ @@ -94,7 +94,7 @@ Builds the phrase, returning a [[PhraseContainer]] for use with the #### Defined in -[src/dataset/DataSet.ts:178](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L178) +[src/dataset/DataSet.ts:178](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L178) ___ @@ -116,4 +116,4 @@ Associates some metadata with this phrase. #### Defined in -[src/dataset/DataSet.ts:169](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L169) +[src/dataset/DataSet.ts:169](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L169) diff --git a/docs/reference/classes/RegExpMatcher.md b/docs/reference/classes/RegExpMatcher.md index b0ace6f..421192a 100644 --- a/docs/reference/classes/RegExpMatcher.md +++ b/docs/reference/classes/RegExpMatcher.md @@ -86,7 +86,7 @@ console.log(matcher.getAllMatches('fu.....uuuuCK the pen is mightier than the sw #### Defined in -[src/matcher/regexp/RegExpMatcher.ts:74](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/regexp/RegExpMatcher.ts#L74) +[src/matcher/regexp/RegExpMatcher.ts:74](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/regexp/RegExpMatcher.ts#L74) ## Methods @@ -121,7 +121,7 @@ otherwise, their order is unspecified. #### Defined in -[src/matcher/regexp/RegExpMatcher.ts:86](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/regexp/RegExpMatcher.ts#L86) +[src/matcher/regexp/RegExpMatcher.ts:87](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/regexp/RegExpMatcher.ts#L87) ___ @@ -150,4 +150,4 @@ checking the result, though it depends on the implementation. #### Defined in -[src/matcher/regexp/RegExpMatcher.ts:116](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/regexp/RegExpMatcher.ts#L116) +[src/matcher/regexp/RegExpMatcher.ts:120](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/regexp/RegExpMatcher.ts#L120) diff --git a/docs/reference/classes/TextCensor.md b/docs/reference/classes/TextCensor.md index 3aa96ed..287c144 100644 --- a/docs/reference/classes/TextCensor.md +++ b/docs/reference/classes/TextCensor.md @@ -58,7 +58,7 @@ The censored text. #### Defined in -[src/censor/TextCensor.ts:66](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/TextCensor.ts#L66) +[src/censor/TextCensor.ts:66](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/TextCensor.ts#L66) ___ @@ -104,4 +104,4 @@ utility functions: #### Defined in -[src/censor/TextCensor.ts:41](https://github.com/jo3-l/obscenity/blob/37976b6/src/censor/TextCensor.ts#L41) +[src/censor/TextCensor.ts:41](https://github.com/jo3-l/obscenity/blob/f14df6c/src/censor/TextCensor.ts#L41) diff --git a/docs/reference/enums/SyntaxKind.md b/docs/reference/enums/SyntaxKind.md index fa5c7f0..1fa4d17 100644 --- a/docs/reference/enums/SyntaxKind.md +++ b/docs/reference/enums/SyntaxKind.md @@ -21,7 +21,7 @@ An enumeration of the kinds of nodes there are. #### Defined in -[src/pattern/Nodes.ts:33](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L33) +[src/pattern/Nodes.ts:33](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L33) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[src/pattern/Nodes.ts:32](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L32) +[src/pattern/Nodes.ts:32](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L32) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/pattern/Nodes.ts:30](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L30) +[src/pattern/Nodes.ts:30](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L30) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[src/pattern/Nodes.ts:31](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L31) +[src/pattern/Nodes.ts:31](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L31) diff --git a/docs/reference/interfaces/BlacklistedTerm.md b/docs/reference/interfaces/BlacklistedTerm.md index e9f8e23..c8c7f8d 100644 --- a/docs/reference/interfaces/BlacklistedTerm.md +++ b/docs/reference/interfaces/BlacklistedTerm.md @@ -21,7 +21,7 @@ The identifier of the pattern; should be unique across all patterns. #### Defined in -[src/matcher/BlacklistedTerm.ts:10](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/BlacklistedTerm.ts#L10) +[src/matcher/BlacklistedTerm.ts:10](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/BlacklistedTerm.ts#L10) ___ @@ -33,4 +33,4 @@ The parsed pattern. #### Defined in -[src/matcher/BlacklistedTerm.ts:15](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/BlacklistedTerm.ts#L15) +[src/matcher/BlacklistedTerm.ts:15](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/BlacklistedTerm.ts#L15) diff --git a/docs/reference/interfaces/BoundaryAssertionNode.md b/docs/reference/interfaces/BoundaryAssertionNode.md index 14aaacf..c6b5620 100644 --- a/docs/reference/interfaces/BoundaryAssertionNode.md +++ b/docs/reference/interfaces/BoundaryAssertionNode.md @@ -18,4 +18,4 @@ A boundary assertion node. #### Defined in -[src/pattern/Nodes.ts:72](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L72) +[src/pattern/Nodes.ts:72](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L72) diff --git a/docs/reference/interfaces/CollapseDuplicatesTransformerOptions.md b/docs/reference/interfaces/CollapseDuplicatesTransformerOptions.md index f207134..251c3a1 100644 --- a/docs/reference/interfaces/CollapseDuplicatesTransformerOptions.md +++ b/docs/reference/interfaces/CollapseDuplicatesTransformerOptions.md @@ -37,7 +37,7 @@ new Map() #### Defined in -[src/transformer/collapse-duplicates/index.ts:91](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/collapse-duplicates/index.ts#L91) +[src/transformer/collapse-duplicates/index.ts:91](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/collapse-duplicates/index.ts#L91) ___ @@ -59,4 +59,4 @@ would be transformed to `aa`. #### Defined in -[src/transformer/collapse-duplicates/index.ts:102](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/collapse-duplicates/index.ts#L102) +[src/transformer/collapse-duplicates/index.ts:102](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/collapse-duplicates/index.ts#L102) diff --git a/docs/reference/interfaces/LiteralNode.md b/docs/reference/interfaces/LiteralNode.md index 6ae6074..667a99e 100644 --- a/docs/reference/interfaces/LiteralNode.md +++ b/docs/reference/interfaces/LiteralNode.md @@ -21,7 +21,7 @@ The code points that this literal matches. #### Defined in -[src/pattern/Nodes.ts:63](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L63) +[src/pattern/Nodes.ts:63](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L63) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[src/pattern/Nodes.ts:65](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L65) +[src/pattern/Nodes.ts:65](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L65) diff --git a/docs/reference/interfaces/MatchPayload.md b/docs/reference/interfaces/MatchPayload.md index 4cd479a..6ee7e07 100644 --- a/docs/reference/interfaces/MatchPayload.md +++ b/docs/reference/interfaces/MatchPayload.md @@ -29,7 +29,7 @@ then this points to the index of the low surrogate. #### Defined in -[src/matcher/MatchPayload.ts:16](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/MatchPayload.ts#L16) +[src/matcher/MatchPayload.ts:16](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/MatchPayload.ts#L16) ___ @@ -41,7 +41,7 @@ Total number of of code points that matched. #### Defined in -[src/matcher/MatchPayload.ts:21](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/MatchPayload.ts#L21) +[src/matcher/MatchPayload.ts:21](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/MatchPayload.ts#L21) ___ @@ -53,7 +53,7 @@ Start index of the match, inclusive. #### Defined in -[src/matcher/MatchPayload.ts:26](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/MatchPayload.ts#L26) +[src/matcher/MatchPayload.ts:26](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/MatchPayload.ts#L26) ___ @@ -65,4 +65,4 @@ ID of the blacklisted term that matched. #### Defined in -[src/matcher/MatchPayload.ts:31](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/MatchPayload.ts#L31) +[src/matcher/MatchPayload.ts:31](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/MatchPayload.ts#L31) diff --git a/docs/reference/interfaces/Matcher.md b/docs/reference/interfaces/Matcher.md index c84e2e7..57dea47 100644 --- a/docs/reference/interfaces/Matcher.md +++ b/docs/reference/interfaces/Matcher.md @@ -48,7 +48,7 @@ otherwise, their order is unspecified. #### Defined in -[src/matcher/Matcher.ts:25](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/Matcher.ts#L25) +[src/matcher/Matcher.ts:25](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/Matcher.ts#L25) ___ @@ -73,4 +73,4 @@ checking the result, though it depends on the implementation. #### Defined in -[src/matcher/Matcher.ts:35](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/Matcher.ts#L35) +[src/matcher/Matcher.ts:35](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/Matcher.ts#L35) diff --git a/docs/reference/interfaces/OptionalNode.md b/docs/reference/interfaces/OptionalNode.md index 0ce4f6a..1ed4219 100644 --- a/docs/reference/interfaces/OptionalNode.md +++ b/docs/reference/interfaces/OptionalNode.md @@ -22,7 +22,7 @@ would be a literal node with the value `abc`. #### Defined in -[src/pattern/Nodes.ts:44](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L44) +[src/pattern/Nodes.ts:44](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L44) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[src/pattern/Nodes.ts:46](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L46) +[src/pattern/Nodes.ts:46](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L46) diff --git a/docs/reference/interfaces/ParsedPattern.md b/docs/reference/interfaces/ParsedPattern.md index 1cf3aef..17a2668 100644 --- a/docs/reference/interfaces/ParsedPattern.md +++ b/docs/reference/interfaces/ParsedPattern.md @@ -22,7 +22,7 @@ A list of nodes which make up the pattern. #### Defined in -[src/pattern/Nodes.ts:8](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L8) +[src/pattern/Nodes.ts:8](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L8) ___ @@ -34,7 +34,7 @@ Whether the pattern requires a word boundary at the end. #### Defined in -[src/pattern/Nodes.ts:13](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L13) +[src/pattern/Nodes.ts:13](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L13) ___ @@ -46,4 +46,4 @@ Whether the pattern requires a word boundary at the start. #### Defined in -[src/pattern/Nodes.ts:18](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L18) +[src/pattern/Nodes.ts:18](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L18) diff --git a/docs/reference/interfaces/PhraseContainer.md b/docs/reference/interfaces/PhraseContainer.md index b095fde..57eb037 100644 --- a/docs/reference/interfaces/PhraseContainer.md +++ b/docs/reference/interfaces/PhraseContainer.md @@ -28,7 +28,7 @@ Metadata associated with this phrase. #### Defined in -[src/dataset/DataSet.ts:204](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L204) +[src/dataset/DataSet.ts:204](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L204) ___ @@ -40,7 +40,7 @@ Patterns associated with this phrase. #### Defined in -[src/dataset/DataSet.ts:209](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L209) +[src/dataset/DataSet.ts:209](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L209) ___ @@ -52,4 +52,4 @@ Whitelisted terms associated with this phrase. #### Defined in -[src/dataset/DataSet.ts:214](https://github.com/jo3-l/obscenity/blob/37976b6/src/dataset/DataSet.ts#L214) +[src/dataset/DataSet.ts:214](https://github.com/jo3-l/obscenity/blob/f14df6c/src/dataset/DataSet.ts#L214) diff --git a/docs/reference/interfaces/ProcessedCollapseDuplicatesTransformerOptions.md b/docs/reference/interfaces/ProcessedCollapseDuplicatesTransformerOptions.md index a90649b..39e3be0 100644 --- a/docs/reference/interfaces/ProcessedCollapseDuplicatesTransformerOptions.md +++ b/docs/reference/interfaces/ProcessedCollapseDuplicatesTransformerOptions.md @@ -17,7 +17,7 @@ #### Defined in -[src/transformer/collapse-duplicates/index.ts:68](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/collapse-duplicates/index.ts#L68) +[src/transformer/collapse-duplicates/index.ts:68](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/collapse-duplicates/index.ts#L68) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[src/transformer/collapse-duplicates/index.ts:69](https://github.com/jo3-l/obscenity/blob/37976b6/src/transformer/collapse-duplicates/index.ts#L69) +[src/transformer/collapse-duplicates/index.ts:69](https://github.com/jo3-l/obscenity/blob/f14df6c/src/transformer/collapse-duplicates/index.ts#L69) diff --git a/docs/reference/interfaces/RegExpMatcherOptions.md b/docs/reference/interfaces/RegExpMatcherOptions.md index 5ed0eb4..90a4265 100644 --- a/docs/reference/interfaces/RegExpMatcherOptions.md +++ b/docs/reference/interfaces/RegExpMatcherOptions.md @@ -33,7 +33,7 @@ Transformers will be applied in the order they appear. #### Defined in -[src/matcher/regexp/RegExpMatcher.ts:220](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/regexp/RegExpMatcher.ts#L220) +[src/matcher/regexp/RegExpMatcher.ts:229](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/regexp/RegExpMatcher.ts#L229) ___ @@ -45,7 +45,7 @@ A list of blacklisted terms. #### Defined in -[src/matcher/regexp/RegExpMatcher.ts:225](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/regexp/RegExpMatcher.ts#L225) +[src/matcher/regexp/RegExpMatcher.ts:234](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/regexp/RegExpMatcher.ts#L234) ___ @@ -67,7 +67,7 @@ Transformers will be applied in the order they appear. #### Defined in -[src/matcher/regexp/RegExpMatcher.ts:236](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/regexp/RegExpMatcher.ts#L236) +[src/matcher/regexp/RegExpMatcher.ts:245](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/regexp/RegExpMatcher.ts#L245) ___ @@ -91,4 +91,4 @@ than the sword.` #### Defined in -[src/matcher/regexp/RegExpMatcher.ts:249](https://github.com/jo3-l/obscenity/blob/37976b6/src/matcher/regexp/RegExpMatcher.ts#L249) +[src/matcher/regexp/RegExpMatcher.ts:258](https://github.com/jo3-l/obscenity/blob/f14df6c/src/matcher/regexp/RegExpMatcher.ts#L258) diff --git a/docs/reference/interfaces/WildcardNode.md b/docs/reference/interfaces/WildcardNode.md index 358a630..df6d7e0 100644 --- a/docs/reference/interfaces/WildcardNode.md +++ b/docs/reference/interfaces/WildcardNode.md @@ -18,4 +18,4 @@ A wildcard node. #### Defined in -[src/pattern/Nodes.ts:53](https://github.com/jo3-l/obscenity/blob/37976b6/src/pattern/Nodes.ts#L53) +[src/pattern/Nodes.ts:53](https://github.com/jo3-l/obscenity/blob/f14df6c/src/pattern/Nodes.ts#L53) diff --git a/package.json b/package.json index b2f9608..3a7c98a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "obscenity", - "version": "0.3.1", + "version": "0.4.0", "description": "Robust, extensible profanity filter.", "files": [ "/dist",