book-source 0.3.4 → 0.3.5

package/lib/StructuredDocument.js

@@ -31,6 +31,7 @@
 const documentParts = require( './documentParts.js' ) ;
 const Style = require( './Style.js' ) ;
 const Theme = require( './Theme.js' ) ;
+const textPostFilters = require( './textPostFilters.js' ) ;
 
 const inPlaceFilter = require( 'array-kit/lib/inPlaceFilter.js' ) ;
 
@@ -217,6 +218,36 @@ StructuredDocument.prototype.getText = function( parts = this.parts ) {
 
 
 
+StructuredDocument.prototype.textPostFilter = function( postFilterList , parts = this.parts ) {
+	for ( let postFilter of postFilterList ) {
+		if ( typeof postFilter === 'string' ) {
+			postFilter = textPostFilters[ postFilter ] ;
+		}
+
+		if ( typeof postFilter === 'function' ) {
+			this.oneTextPostFilter( postFilter , parts ) ;
+		}
+	}
+} ;
+
+
+
+StructuredDocument.prototype.oneTextPostFilter = function( postFilter , parts , runtime = { lastPart: null } ) {
+	for ( let part of parts ) {
+		if ( ( part instanceof documentParts.Text ) && part.text ) {
+			postFilter( part , runtime.lastPart ) ;
+
+			// Can be modified by the callback
+			if ( part.text ) { runtime.lastPart = part ; }
+		}
+		else if ( part.parts?.length ) {
+			this.oneTextPostFilter( postFilter , part.parts , runtime ) ;
+		}
+	}
+} ;
+
+
+
 // Parser
 
 StructuredDocument.parse = function( str , options ) {

package/lib/book-source.js

@@ -34,10 +34,11 @@ module.exports = bookSource ;
 bookSource.StructuredDocument = require( './StructuredDocument.js' ) ;
 bookSource.Style = require( './Style.js' ) ;
 bookSource.Theme = require( './Theme.js' ) ;
+bookSource.textPostFilters = require( './textPostFilters.js' ) ;
 
 Object.assign( bookSource , require( './documentParts.js' ) ) ;
 
-// Exposed external lib
+// Exposed external libs
 const paletteShade = require( 'palette-shade' ) ;
 bookSource.Color = paletteShade.Color ;
 bookSource.Palette = paletteShade.Palette ;

package/lib/textPostFilters.js

@@ -0,0 +1,100 @@
+/*
+	Book Source
+
+	Copyright (c) 2023 Cédric Ronvel
+
+	The MIT License (MIT)
+
+	Permission is hereby granted, free of charge, to any person obtaining a copy
+	of this software and associated documentation files (the "Software"), to deal
+	in the Software without restriction, including without limitation the rights
+	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	copies of the Software, and to permit persons to whom the Software is
+	furnished to do so, subject to the following conditions:
+
+	The above copyright notice and this permission notice shall be included in all
+	copies or substantial portions of the Software.
+
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+	SOFTWARE.
+*/
+
+"use strict" ;
+
+
+
+// Non-breaking space
+const NBSP = String.fromCharCode( 0xa0 ) ;
+//const NBSP = '#' ;
+
+
+
+const DOUBLE_GRAPH_PUNCTUATIONS = [ ':' , ';' , '!' , '?' ] ;
+const SPACES = [ ' ' , NBSP ] ;
+const DOUBLE_GRAPH_PUNCTUATIONS_AND_SPACES = DOUBLE_GRAPH_PUNCTUATIONS.concat( SPACES ) ;
+const FRENCH_TYPO_PUNCTUATION_REGEX =
+	"([^" + DOUBLE_GRAPH_PUNCTUATIONS_AND_SPACES.join( '' ) + "])"
+	+ "[" + SPACES.join( '' ) + "]?"
+	+ "([" + DOUBLE_GRAPH_PUNCTUATIONS.join( '' ) + "]+)" ;
+const FRENCH_TYPO_PUNCTUATION_REGEX_WITHOUT_PREVIOUS =
+	"[" + SPACES.join( '' ) + "]?"
+	+ "([" + DOUBLE_GRAPH_PUNCTUATIONS.join( '' ) + "]+)" ;
+const FRENCH_TYPO_PUNCTUATION_REGEX_ALT_START =
+	"(?:"
+	+ "^" + FRENCH_TYPO_PUNCTUATION_REGEX_WITHOUT_PREVIOUS
+	+ "|(?<!^)" + FRENCH_TYPO_PUNCTUATION_REGEX
+	+ ")" ;
+
+
+
+exports['french-typo'] = exports.frenchTypo = ( part , lastPart ) => {
+	var useRegexAltStart = false ;
+
+	if ( lastPart ) {
+		let firstChar = part.text[ 0 ] ;
+		let lastChar = lastPart.text[ lastPart.text.length - 1 ] ;
+
+		if (
+			DOUBLE_GRAPH_PUNCTUATIONS.includes( firstChar )
+			&& ! DOUBLE_GRAPH_PUNCTUATIONS.includes( lastChar )
+			&& lastChar !== NBSP
+		) {
+			if ( lastChar === ' ' ) {
+				lastPart.text = lastPart.text.slice( 0 , - 1 ) + NBSP ;
+			}
+			else {
+				part.text = NBSP + part.text ;
+			}
+		}
+		else if ( ! DOUBLE_GRAPH_PUNCTUATIONS_AND_SPACES.includes( lastChar ) ) {
+			useRegexAltStart = true ;
+		}
+	}
+
+	if ( useRegexAltStart ) {
+		part.text = part.text.replace(
+			new RegExp( FRENCH_TYPO_PUNCTUATION_REGEX_ALT_START , 'g' ) ,
+			( match , punctuations1 , previous , punctuations2 ) =>
+				punctuations1 ? NBSP + punctuations1 :
+				previous + NBSP + punctuations2
+		) ;
+	}
+	else {
+		part.text = part.text.replace(
+			new RegExp( FRENCH_TYPO_PUNCTUATION_REGEX , 'g' ) ,
+			( match , previous , punctuations ) => previous + NBSP + punctuations
+		) ;
+	}
+} ;
+
+
+
+exports.apostrophe = ( part ) => {
+	part.text = part.text.replace( /'/g , '’' ) ;
+} ;
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "book-source",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "A lightweight markup language, inspired by Markdown.",
   "main": "lib/book-source.js",
   "directories": {