chore(release): 0.3.0

jo3-l · Jul 17, 2024 · bc6c388 · bc6c388
1 parent 384d3b0
commit bc6c388
Show file tree

Hide file tree

Showing 21 changed files with 87 additions and 91 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,15 @@
 
 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.3.0](https://github.com/jo3-l/obscenity/compare/v0.2.2...v0.3.0) (2024-07-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* The library no longer exports a version constant.
+
+* drop version constant ([2810674](https://github.com/jo3-l/obscenity/commit/2810674de20d82d7372c617d2e8ef76e911f27ad))
+
 ### [0.2.2](https://github.com/jo3-l/obscenity/compare/v0.2.1...v0.2.2) (2024-07-17)
 
 

diff --git a/docs/reference/README.md b/docs/reference/README.md
@@ -46,7 +46,6 @@ obscenity
 - [englishRecommendedBlacklistMatcherTransformers](README.md#englishrecommendedblacklistmatchertransformers)
 - [englishRecommendedTransformers](README.md#englishrecommendedtransformers)
 - [englishRecommendedWhitelistMatcherTransformers](README.md#englishrecommendedwhitelistmatchertransformers)
-- [version](README.md#version)
 
 ### Functions
 
@@ -78,7 +77,7 @@ Context passed to [[TextCensorStrategy | text censoring strategies]].
 
 #### Defined in
 
-[src/censor/TextCensor.ts:104](https://github.com/jo3-l/obscenity/blob/594f6f2/src/censor/TextCensor.ts#L104)
+[src/censor/TextCensor.ts:104](https://github.com/jo3-l/obscenity/blob/384d3b0/src/censor/TextCensor.ts#L104)
 
 ___
 
@@ -92,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/594f6f2/src/transformer/remap-characters/index.ts#L60)
+[src/transformer/remap-characters/index.ts:60](https://github.com/jo3-l/obscenity/blob/384d3b0/src/transformer/remap-characters/index.ts#L60)
 
 ___
 
@@ -104,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/594f6f2/src/preset/english.ts#L418)
+[src/preset/english.ts:418](https://github.com/jo3-l/obscenity/blob/384d3b0/src/preset/english.ts#L418)
 
 ___
 
@@ -122,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/594f6f2/src/dataset/DataSet.ts#L190)
+[src/dataset/DataSet.ts:190](https://github.com/jo3-l/obscenity/blob/384d3b0/src/dataset/DataSet.ts#L190)
 
 ___
 
@@ -134,7 +133,7 @@ All the possible kinds of nodes.
 
 #### Defined in
 
-[src/pattern/Nodes.ts:24](https://github.com/jo3-l/obscenity/blob/594f6f2/src/pattern/Nodes.ts#L24)
+[src/pattern/Nodes.ts:24](https://github.com/jo3-l/obscenity/blob/384d3b0/src/pattern/Nodes.ts#L24)
 
 ___
 
@@ -161,7 +160,7 @@ replacement string.
 
 #### Defined in
 
-[src/censor/TextCensor.ts:99](https://github.com/jo3-l/obscenity/blob/594f6f2/src/censor/TextCensor.ts#L99)
+[src/censor/TextCensor.ts:99](https://github.com/jo3-l/obscenity/blob/384d3b0/src/censor/TextCensor.ts#L99)
 
 ## Variables
 
@@ -222,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/594f6f2/src/preset/english.ts#L103)
+[src/preset/english.ts:103](https://github.com/jo3-l/obscenity/blob/384d3b0/src/preset/english.ts#L103)
 
 ___
 
@@ -235,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/594f6f2/src/preset/english.ts#L13)
+[src/preset/english.ts:13](https://github.com/jo3-l/obscenity/blob/384d3b0/src/preset/english.ts#L13)
 
 ___
 
@@ -248,7 +247,7 @@ dataset]] and the [[RegExpMatcher]].
 
 #### Defined in
 
-[src/preset/english.ts:48](https://github.com/jo3-l/obscenity/blob/594f6f2/src/preset/english.ts#L48)
+[src/preset/english.ts:48](https://github.com/jo3-l/obscenity/blob/384d3b0/src/preset/english.ts#L48)
 
 ___
 
@@ -261,19 +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/594f6f2/src/preset/english.ts#L36)
-
-___
-
-### version
-
-• `Const` **version**: ``"0.1.0"``
-
-The current version of the library, formatted as `MAJOR.MINOR.PATCH`.
-
-#### Defined in
-
-[src/index.ts:27](https://github.com/jo3-l/obscenity/blob/594f6f2/src/index.ts#L27)
+[src/preset/english.ts:36](https://github.com/jo3-l/obscenity/blob/384d3b0/src/preset/english.ts#L36)
 
 ## Functions
 
@@ -312,7 +299,7 @@ to the [[RegExpMatcher]].
 
 #### Defined in
 
-[src/matcher/BlacklistedTerm.ts:37](https://github.com/jo3-l/obscenity/blob/594f6f2/src/matcher/BlacklistedTerm.ts#L37)
+[src/matcher/BlacklistedTerm.ts:37](https://github.com/jo3-l/obscenity/blob/384d3b0/src/matcher/BlacklistedTerm.ts#L37)
 
 ___
 
@@ -339,7 +326,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].
 
 #### Defined in
 
-[src/censor/BuiltinStrategies.ts:71](https://github.com/jo3-l/obscenity/blob/594f6f2/src/censor/BuiltinStrategies.ts#L71)
+[src/censor/BuiltinStrategies.ts:71](https://github.com/jo3-l/obscenity/blob/384d3b0/src/censor/BuiltinStrategies.ts#L71)
 
 ___
 
@@ -402,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/594f6f2/src/transformer/collapse-duplicates/index.ts#L46)
+[src/transformer/collapse-duplicates/index.ts:46](https://github.com/jo3-l/obscenity/blob/384d3b0/src/transformer/collapse-duplicates/index.ts#L46)
 
 ___
 
@@ -443,7 +430,7 @@ than the first.
 
 #### Defined in
 
-[src/matcher/MatchPayload.ts:57](https://github.com/jo3-l/obscenity/blob/594f6f2/src/matcher/MatchPayload.ts#L57)
+[src/matcher/MatchPayload.ts:57](https://github.com/jo3-l/obscenity/blob/384d3b0/src/matcher/MatchPayload.ts#L57)
 
 ___
 
@@ -477,7 +464,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].
 
 #### Defined in
 
-[src/censor/BuiltinStrategies.ts:134](https://github.com/jo3-l/obscenity/blob/594f6f2/src/censor/BuiltinStrategies.ts#L134)
+[src/censor/BuiltinStrategies.ts:134](https://github.com/jo3-l/obscenity/blob/384d3b0/src/censor/BuiltinStrategies.ts#L134)
 
 ___
 
@@ -521,7 +508,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].
 
 #### Defined in
 
-[src/censor/BuiltinStrategies.ts:115](https://github.com/jo3-l/obscenity/blob/594f6f2/src/censor/BuiltinStrategies.ts#L115)
+[src/censor/BuiltinStrategies.ts:115](https://github.com/jo3-l/obscenity/blob/384d3b0/src/censor/BuiltinStrategies.ts#L115)
 
 ___
 
@@ -550,7 +537,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].
 
 #### Defined in
 
-[src/censor/BuiltinStrategies.ts:89](https://github.com/jo3-l/obscenity/blob/594f6f2/src/censor/BuiltinStrategies.ts#L89)
+[src/censor/BuiltinStrategies.ts:89](https://github.com/jo3-l/obscenity/blob/384d3b0/src/censor/BuiltinStrategies.ts#L89)
 
 ___
 
@@ -584,7 +571,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].
 
 #### Defined in
 
-[src/censor/BuiltinStrategies.ts:51](https://github.com/jo3-l/obscenity/blob/594f6f2/src/censor/BuiltinStrategies.ts#L51)
+[src/censor/BuiltinStrategies.ts:51](https://github.com/jo3-l/obscenity/blob/384d3b0/src/censor/BuiltinStrategies.ts#L51)
 
 ___
 
@@ -629,7 +616,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].
 
 #### Defined in
 
-[src/censor/BuiltinStrategies.ts:28](https://github.com/jo3-l/obscenity/blob/594f6f2/src/censor/BuiltinStrategies.ts#L28)
+[src/censor/BuiltinStrategies.ts:28](https://github.com/jo3-l/obscenity/blob/384d3b0/src/censor/BuiltinStrategies.ts#L28)
 
 ___
 
@@ -664,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/594f6f2/src/pattern/Pattern.ts#L130)
+[src/pattern/Pattern.ts:130](https://github.com/jo3-l/obscenity/blob/384d3b0/src/pattern/Pattern.ts#L130)
 
 ___
 
@@ -797,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/594f6f2/src/pattern/Pattern.ts#L106)
+[src/pattern/Pattern.ts:106](https://github.com/jo3-l/obscenity/blob/384d3b0/src/pattern/Pattern.ts#L106)
 
 ___
 
@@ -831,7 +818,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].
 
 #### Defined in
 
-[src/censor/BuiltinStrategies.ts:155](https://github.com/jo3-l/obscenity/blob/594f6f2/src/censor/BuiltinStrategies.ts#L155)
+[src/censor/BuiltinStrategies.ts:155](https://github.com/jo3-l/obscenity/blob/384d3b0/src/censor/BuiltinStrategies.ts#L155)
 
 ___
 
@@ -891,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/594f6f2/src/transformer/remap-characters/index.ts#L38)
+[src/transformer/remap-characters/index.ts:38](https://github.com/jo3-l/obscenity/blob/384d3b0/src/transformer/remap-characters/index.ts#L38)
 
 ___
 
@@ -924,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/594f6f2/src/transformer/resolve-confusables/index.ts#L22)
+[src/transformer/resolve-confusables/index.ts:22](https://github.com/jo3-l/obscenity/blob/384d3b0/src/transformer/resolve-confusables/index.ts#L22)
 
 ___
 
@@ -958,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/594f6f2/src/transformer/resolve-leetspeak/index.ts#L23)
+[src/transformer/resolve-leetspeak/index.ts:23](https://github.com/jo3-l/obscenity/blob/384d3b0/src/transformer/resolve-leetspeak/index.ts#L23)
 
 ___
 
@@ -1000,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/594f6f2/src/transformer/skip-non-alphabetic/index.ts#L31)
+[src/transformer/skip-non-alphabetic/index.ts:31](https://github.com/jo3-l/obscenity/blob/384d3b0/src/transformer/skip-non-alphabetic/index.ts#L31)
 
 ___
 
@@ -1027,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/594f6f2/src/transformer/to-ascii-lowercase/index.ts#L18)
+[src/transformer/to-ascii-lowercase/index.ts:18](https://github.com/jo3-l/obscenity/blob/384d3b0/src/transformer/to-ascii-lowercase/index.ts#L18)
diff --git 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/594f6f2/src/dataset/DataSet.ts#L29)
+[src/dataset/DataSet.ts:29](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/dataset/DataSet.ts#L75)
+[src/dataset/DataSet.ts:75](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/dataset/DataSet.ts#L118)
+[src/dataset/DataSet.ts:118](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/dataset/DataSet.ts#L94)
+[src/dataset/DataSet.ts:94](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/dataset/DataSet.ts#L46)
+[src/dataset/DataSet.ts:46](https://github.com/jo3-l/obscenity/blob/384d3b0/src/dataset/DataSet.ts#L46)
diff --git 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/594f6f2/src/pattern/ParserError.ts#L18)
+[src/pattern/ParserError.ts:18](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/pattern/ParserError.ts#L16)
+[src/pattern/ParserError.ts:16](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/pattern/ParserError.ts#L10)
+[src/pattern/ParserError.ts:10](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/pattern/ParserError.ts#L5)
+[src/pattern/ParserError.ts:5](https://github.com/jo3-l/obscenity/blob/384d3b0/src/pattern/ParserError.ts#L5)
 
 ___
 

diff --git 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/594f6f2/src/dataset/DataSet.ts#L149)
+[src/dataset/DataSet.ts:149](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/dataset/DataSet.ts#L159)
+[src/dataset/DataSet.ts:159](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/dataset/DataSet.ts#L178)
+[src/dataset/DataSet.ts:178](https://github.com/jo3-l/obscenity/blob/384d3b0/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/594f6f2/src/dataset/DataSet.ts#L169)
+[src/dataset/DataSet.ts:169](https://github.com/jo3-l/obscenity/blob/384d3b0/src/dataset/DataSet.ts#L169)