diff --git a/CHANGELOG.md b/CHANGELOG.md index 0edf6f5..1153c5e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,32 @@ 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.2.0](https://github.com/jo3-l/obscenity/compare/v0.1.4...v0.2.0) (2024-01-05) + + +### ⚠ BREAKING CHANGES + +* **english-preset:** Using the default English preset, Obscenity will no longer strip non-alphabetic characters from the input text before matching. + +This addresses a class of egregious false negatives in previous versions (see #23), but introduces a regression where cases such as 'f u c k' (with the space) will no longer be detected by default. We expect to provide a more comprehensive fix in the next minor release. + +If desired, it remains possible to revert to the previous behavior by providing a custom set of transformers to the matcher. +* **matchers:** The NfaMatcher class has been removed. Use the RegExpMatcher instead. + +### Features + +* **english-preset:** blacklist 'shit' by default ([b0d90aa](https://github.com/jo3-l/obscenity/commit/b0d90aa4b7dd6d15a2105490f1d2b0c87e58bdcf)), closes [#47](https://github.com/jo3-l/obscenity/issues/47) + + +### Bug Fixes + +* **english-preset:** don't include skip-non-alphabetic transformer ([620c721](https://github.com/jo3-l/obscenity/commit/620c721662c3ddd8d8ca8838861b9c4ba3ea66e7)), closes [#23](https://github.com/jo3-l/obscenity/issues/23) [#46](https://github.com/jo3-l/obscenity/issues/46) +* **english-preset:** remove extraneous patterns for n-word ([e135be5](https://github.com/jo3-l/obscenity/commit/e135be58510149db9b678801a2e6e3468b3bd4bb)), closes [#48](https://github.com/jo3-l/obscenity/issues/48) +* **pkg:** ensure types resolve in ESM ([718da8a](https://github.com/jo3-l/obscenity/commit/718da8a7399c0dcf948fbe8041714ad6d61c9f73)), closes [#44](https://github.com/jo3-l/obscenity/issues/44) + + +* **matchers:** remove NfaMatcher ([b69c21d](https://github.com/jo3-l/obscenity/commit/b69c21d178ac5e3270fd35d2b876263045a67d81)) + ### [0.1.4](https://github.com/jo3-l/obscenity/compare/v0.1.1...v0.1.4) (2023-06-06) ### Bug Fixes diff --git a/docs/reference/README.md b/docs/reference/README.md index ab62b77..106c865 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -78,7 +78,7 @@ Context passed to [[TextCensorStrategy | text censoring strategies]]. #### Defined in -[src/censor/TextCensor.ts:104](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/TextCensor.ts#L104) +[src/censor/TextCensor.ts:104](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/TextCensor.ts#L104) ___ @@ -92,7 +92,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/0b48eca/src/transformer/remap-characters/index.ts#L60) +[src/transformer/remap-characters/index.ts:60](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/transformer/remap-characters/index.ts#L60) ___ @@ -104,7 +104,7 @@ All the profane words that are included in the [[englishDataset | english datase #### Defined in -[src/preset/english.ts:383](https://github.com/jo3-l/obscenity/blob/0b48eca/src/preset/english.ts#L383) +[src/preset/english.ts:383](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/preset/english.ts#L383) ___ @@ -122,7 +122,7 @@ Extends the default match payload by adding phrase metadata. #### Defined in -[src/dataset/DataSet.ts:190](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L190) +[src/dataset/DataSet.ts:190](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/dataset/DataSet.ts#L190) ___ @@ -134,7 +134,7 @@ All the possible kinds of nodes. #### Defined in -[src/pattern/Nodes.ts:24](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/Nodes.ts#L24) +[src/pattern/Nodes.ts:24](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L24) ___ @@ -161,7 +161,7 @@ replacement string. #### Defined in -[src/censor/TextCensor.ts:99](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/TextCensor.ts#L99) +[src/censor/TextCensor.ts:99](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/TextCensor.ts#L99) ## Variables @@ -222,7 +222,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/0b48eca/src/preset/english.ts#L103) +[src/preset/english.ts:103](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/preset/english.ts#L103) ___ @@ -235,7 +235,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/0b48eca/src/preset/english.ts#L13) +[src/preset/english.ts:13](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/preset/english.ts#L13) ___ @@ -248,7 +248,7 @@ dataset]] and the [[RegExpMatcher]]. #### Defined in -[src/preset/english.ts:48](https://github.com/jo3-l/obscenity/blob/0b48eca/src/preset/english.ts#L48) +[src/preset/english.ts:48](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/preset/english.ts#L48) ___ @@ -261,7 +261,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/0b48eca/src/preset/english.ts#L36) +[src/preset/english.ts:36](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/preset/english.ts#L36) ___ @@ -273,7 +273,7 @@ The current version of the library, formatted as `MAJOR.MINOR.PATCH`. #### Defined in -[src/index.ts:27](https://github.com/jo3-l/obscenity/blob/0b48eca/src/index.ts#L27) +[src/index.ts:27](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/index.ts#L27) ## Functions @@ -312,7 +312,7 @@ to the [[RegExpMatcher]]. #### Defined in -[src/matcher/BlacklistedTerm.ts:37](https://github.com/jo3-l/obscenity/blob/0b48eca/src/matcher/BlacklistedTerm.ts#L37) +[src/matcher/BlacklistedTerm.ts:37](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/BlacklistedTerm.ts#L37) ___ @@ -339,7 +339,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:71](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L71) +[src/censor/BuiltinStrategies.ts:71](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/BuiltinStrategies.ts#L71) ___ @@ -402,7 +402,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/0b48eca/src/transformer/collapse-duplicates/index.ts#L46) +[src/transformer/collapse-duplicates/index.ts:46](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/transformer/collapse-duplicates/index.ts#L46) ___ @@ -443,7 +443,7 @@ than the first. #### Defined in -[src/matcher/MatchPayload.ts:57](https://github.com/jo3-l/obscenity/blob/0b48eca/src/matcher/MatchPayload.ts#L57) +[src/matcher/MatchPayload.ts:57](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/MatchPayload.ts#L57) ___ @@ -477,7 +477,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:134](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L134) +[src/censor/BuiltinStrategies.ts:134](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/BuiltinStrategies.ts#L134) ___ @@ -521,7 +521,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:115](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L115) +[src/censor/BuiltinStrategies.ts:115](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/BuiltinStrategies.ts#L115) ___ @@ -550,7 +550,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:89](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L89) +[src/censor/BuiltinStrategies.ts:89](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/BuiltinStrategies.ts#L89) ___ @@ -584,7 +584,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:51](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L51) +[src/censor/BuiltinStrategies.ts:51](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/BuiltinStrategies.ts#L51) ___ @@ -629,7 +629,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:28](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L28) +[src/censor/BuiltinStrategies.ts:28](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/BuiltinStrategies.ts#L28) ___ @@ -664,7 +664,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/0b48eca/src/pattern/Pattern.ts#L130) +[src/pattern/Pattern.ts:130](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Pattern.ts#L130) ___ @@ -797,7 +797,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/0b48eca/src/pattern/Pattern.ts#L106) +[src/pattern/Pattern.ts:106](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Pattern.ts#L106) ___ @@ -831,7 +831,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]]. #### Defined in -[src/censor/BuiltinStrategies.ts:155](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L155) +[src/censor/BuiltinStrategies.ts:155](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/BuiltinStrategies.ts#L155) ___ @@ -891,7 +891,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/0b48eca/src/transformer/remap-characters/index.ts#L38) +[src/transformer/remap-characters/index.ts:38](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/transformer/remap-characters/index.ts#L38) ___ @@ -924,7 +924,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/0b48eca/src/transformer/resolve-confusables/index.ts#L22) +[src/transformer/resolve-confusables/index.ts:22](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/transformer/resolve-confusables/index.ts#L22) ___ @@ -958,7 +958,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/0b48eca/src/transformer/resolve-leetspeak/index.ts#L23) +[src/transformer/resolve-leetspeak/index.ts:23](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/transformer/resolve-leetspeak/index.ts#L23) ___ @@ -1000,7 +1000,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/0b48eca/src/transformer/skip-non-alphabetic/index.ts#L31) +[src/transformer/skip-non-alphabetic/index.ts:31](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/transformer/skip-non-alphabetic/index.ts#L31) ___ @@ -1027,4 +1027,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/0b48eca/src/transformer/to-ascii-lowercase/index.ts#L18) +[src/transformer/to-ascii-lowercase/index.ts:18](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/transformer/to-ascii-lowercase/index.ts#L18) diff --git a/docs/reference/classes/DataSet.md b/docs/reference/classes/DataSet.md index b4738a5..f4a31df 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/0b48eca/src/dataset/DataSet.ts#L29) +[src/dataset/DataSet.ts:29](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/dataset/DataSet.ts#L75) +[src/dataset/DataSet.ts:75](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/dataset/DataSet.ts#L118) +[src/dataset/DataSet.ts:118](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/dataset/DataSet.ts#L94) +[src/dataset/DataSet.ts:94](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/dataset/DataSet.ts#L46) +[src/dataset/DataSet.ts:46](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/dataset/DataSet.ts#L46) diff --git a/docs/reference/classes/ParserError.md b/docs/reference/classes/ParserError.md index fd39a87..90009ba 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/0b48eca/src/pattern/ParserError.ts#L18) +[src/pattern/ParserError.ts:18](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/pattern/ParserError.ts#L16) +[src/pattern/ParserError.ts:16](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/pattern/ParserError.ts#L10) +[src/pattern/ParserError.ts:10](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/pattern/ParserError.ts#L5) +[src/pattern/ParserError.ts:5](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/ParserError.ts#L5) ___ diff --git a/docs/reference/classes/PhraseBuilder.md b/docs/reference/classes/PhraseBuilder.md index cc03683..180696f 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/0b48eca/src/dataset/DataSet.ts#L149) +[src/dataset/DataSet.ts:149](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/dataset/DataSet.ts#L159) +[src/dataset/DataSet.ts:159](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/dataset/DataSet.ts#L178) +[src/dataset/DataSet.ts:178](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/dataset/DataSet.ts#L169) +[src/dataset/DataSet.ts:169](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/dataset/DataSet.ts#L169) diff --git a/docs/reference/classes/RegExpMatcher.md b/docs/reference/classes/RegExpMatcher.md index 80c598a..46dbad5 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/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L74) +[src/matcher/regexp/RegExpMatcher.ts:74](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L86) +[src/matcher/regexp/RegExpMatcher.ts:86](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/regexp/RegExpMatcher.ts#L86) ___ @@ -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/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L116) +[src/matcher/regexp/RegExpMatcher.ts:116](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/regexp/RegExpMatcher.ts#L116) diff --git a/docs/reference/classes/TextCensor.md b/docs/reference/classes/TextCensor.md index cffedd5..e6cb474 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/0b48eca/src/censor/TextCensor.ts#L66) +[src/censor/TextCensor.ts:66](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/censor/TextCensor.ts#L41) +[src/censor/TextCensor.ts:41](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/censor/TextCensor.ts#L41) diff --git a/docs/reference/enums/SyntaxKind.md b/docs/reference/enums/SyntaxKind.md index e706b23..dcff79c 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/0b48eca/src/pattern/Nodes.ts#L33) +[src/pattern/Nodes.ts:33](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L33) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[src/pattern/Nodes.ts:32](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/Nodes.ts#L32) +[src/pattern/Nodes.ts:32](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L32) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/pattern/Nodes.ts:30](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/Nodes.ts#L30) +[src/pattern/Nodes.ts:30](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L30) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[src/pattern/Nodes.ts:31](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/Nodes.ts#L31) +[src/pattern/Nodes.ts:31](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L31) diff --git a/docs/reference/interfaces/BlacklistedTerm.md b/docs/reference/interfaces/BlacklistedTerm.md index a57210a..2b62eda 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/0b48eca/src/matcher/BlacklistedTerm.ts#L10) +[src/matcher/BlacklistedTerm.ts:10](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/matcher/BlacklistedTerm.ts#L15) +[src/matcher/BlacklistedTerm.ts:15](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/BlacklistedTerm.ts#L15) diff --git a/docs/reference/interfaces/BoundaryAssertionNode.md b/docs/reference/interfaces/BoundaryAssertionNode.md index b029ed9..c353b9d 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/0b48eca/src/pattern/Nodes.ts#L72) +[src/pattern/Nodes.ts:72](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L72) diff --git a/docs/reference/interfaces/CollapseDuplicatesTransformerOptions.md b/docs/reference/interfaces/CollapseDuplicatesTransformerOptions.md index 77f7004..a051cd3 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/0b48eca/src/transformer/collapse-duplicates/index.ts#L91) +[src/transformer/collapse-duplicates/index.ts:91](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/transformer/collapse-duplicates/index.ts#L102) +[src/transformer/collapse-duplicates/index.ts:102](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/transformer/collapse-duplicates/index.ts#L102) diff --git a/docs/reference/interfaces/LiteralNode.md b/docs/reference/interfaces/LiteralNode.md index b48e4e1..b905d89 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/0b48eca/src/pattern/Nodes.ts#L63) +[src/pattern/Nodes.ts:63](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L63) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[src/pattern/Nodes.ts:65](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/Nodes.ts#L65) +[src/pattern/Nodes.ts:65](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L65) diff --git a/docs/reference/interfaces/MatchPayload.md b/docs/reference/interfaces/MatchPayload.md index b468b90..c95a6a1 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/0b48eca/src/matcher/MatchPayload.ts#L16) +[src/matcher/MatchPayload.ts:16](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/matcher/MatchPayload.ts#L21) +[src/matcher/MatchPayload.ts:21](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/matcher/MatchPayload.ts#L26) +[src/matcher/MatchPayload.ts:26](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/matcher/MatchPayload.ts#L31) +[src/matcher/MatchPayload.ts:31](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/MatchPayload.ts#L31) diff --git a/docs/reference/interfaces/Matcher.md b/docs/reference/interfaces/Matcher.md index a0dc8be..b1943e4 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/0b48eca/src/matcher/Matcher.ts#L25) +[src/matcher/Matcher.ts:25](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/matcher/Matcher.ts#L35) +[src/matcher/Matcher.ts:35](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/Matcher.ts#L35) diff --git a/docs/reference/interfaces/OptionalNode.md b/docs/reference/interfaces/OptionalNode.md index 135d673..fe9cdf7 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/0b48eca/src/pattern/Nodes.ts#L44) +[src/pattern/Nodes.ts:44](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L44) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[src/pattern/Nodes.ts:46](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/Nodes.ts#L46) +[src/pattern/Nodes.ts:46](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L46) diff --git a/docs/reference/interfaces/ParsedPattern.md b/docs/reference/interfaces/ParsedPattern.md index c3186ab..b08bc9b 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/0b48eca/src/pattern/Nodes.ts#L8) +[src/pattern/Nodes.ts:8](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/pattern/Nodes.ts#L13) +[src/pattern/Nodes.ts:13](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/pattern/Nodes.ts#L18) +[src/pattern/Nodes.ts:18](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L18) diff --git a/docs/reference/interfaces/PhraseContainer.md b/docs/reference/interfaces/PhraseContainer.md index 51b78b9..f0e4575 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/0b48eca/src/dataset/DataSet.ts#L204) +[src/dataset/DataSet.ts:204](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/dataset/DataSet.ts#L209) +[src/dataset/DataSet.ts:209](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/dataset/DataSet.ts#L214) +[src/dataset/DataSet.ts:214](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/dataset/DataSet.ts#L214) diff --git a/docs/reference/interfaces/ProcessedCollapseDuplicatesTransformerOptions.md b/docs/reference/interfaces/ProcessedCollapseDuplicatesTransformerOptions.md index 8710386..a4e5e25 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/0b48eca/src/transformer/collapse-duplicates/index.ts#L68) +[src/transformer/collapse-duplicates/index.ts:68](https://github.com/jo3-l/obscenity/blob/5bb1ef1/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/0b48eca/src/transformer/collapse-duplicates/index.ts#L69) +[src/transformer/collapse-duplicates/index.ts:69](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/transformer/collapse-duplicates/index.ts#L69) diff --git a/docs/reference/interfaces/RegExpMatcherOptions.md b/docs/reference/interfaces/RegExpMatcherOptions.md index 4ec01d2..a4c43db 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/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L220) +[src/matcher/regexp/RegExpMatcher.ts:220](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/regexp/RegExpMatcher.ts#L220) ___ @@ -45,7 +45,7 @@ A list of blacklisted terms. #### Defined in -[src/matcher/regexp/RegExpMatcher.ts:225](https://github.com/jo3-l/obscenity/blob/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L225) +[src/matcher/regexp/RegExpMatcher.ts:225](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/regexp/RegExpMatcher.ts#L225) ___ @@ -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/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L236) +[src/matcher/regexp/RegExpMatcher.ts:236](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/regexp/RegExpMatcher.ts#L236) ___ @@ -91,4 +91,4 @@ than the sword.` #### Defined in -[src/matcher/regexp/RegExpMatcher.ts:249](https://github.com/jo3-l/obscenity/blob/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L249) +[src/matcher/regexp/RegExpMatcher.ts:249](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/matcher/regexp/RegExpMatcher.ts#L249) diff --git a/docs/reference/interfaces/WildcardNode.md b/docs/reference/interfaces/WildcardNode.md index 6d3a418..3d95054 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/0b48eca/src/pattern/Nodes.ts#L53) +[src/pattern/Nodes.ts:53](https://github.com/jo3-l/obscenity/blob/5bb1ef1/src/pattern/Nodes.ts#L53) diff --git a/package.json b/package.json index 24fdcaf..648c035 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "obscenity", - "version": "0.1.4", + "version": "0.2.0", "description": "Robust, extensible profanity filter.", "main": "./dist/index.js", "module": "./dist/index.mjs",