book-source 0.1.1

package/lib/Style.js

@@ -0,0 +1,102 @@
+/*
+	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" ;
+
+
+
+const Color = require( './Color.js' ) ;
+
+
+
+function Style() {
+	this.textColor = null ;
+	this.backgroundColor = null ;
+	this.bold = null ;
+	this.italic = null ;
+	this.underline = null ;
+}
+
+module.exports = Style ;
+
+
+
+Style.merge = function( ... styles ) {
+	var mergedStyle = new Style() ;
+
+	for ( let style of styles ) {
+		if ( style.textColor !== null ) { mergedStyle.textColor = style.textColor ; }
+		if ( style.backgroundColor !== null ) { mergedStyle.backgroundColor = style.backgroundColor ; }
+		if ( style.bold !== null ) { mergedStyle.bold = style.bold ; }
+		if ( style.italic !== null ) { mergedStyle.italic = style.italic ; }
+		if ( style.underline !== null ) { mergedStyle.underline = style.underline ; }
+	}
+
+	return mergedStyle ;
+} ;
+
+
+
+const BOOLEAN_PROPERTIES = new Set( [ 'bold' , 'italic' , 'underline' ] ) ;
+const TEXT_COLOR_PROPERTIES = new Set( [ 'text' , 'tx' , 'foreground' , 'fg' ] ) ;
+const BACKGROUND_COLOR_PROPERTIES = new Set( [ 'background' , 'bg' ] ) ;
+
+
+
+Style.parse = function( str , forTextElement = true ) {
+	var style = new Style() ;
+
+	for ( let part of str.trim().split( /,/g ) ) {
+		let [ property , value ] = part.split( ':' ) ;
+
+		if ( value ) {
+			property = TEXT_COLOR_PROPERTIES.has( property ) ? 'text' :
+				BACKGROUND_COLOR_PROPERTIES.has( property ) ? 'background' :
+				forTextElement ? 'text' : 'background' ;
+		}
+		else {
+			if ( BOOLEAN_PROPERTIES.has( property ) ) {
+				style[ property ] = true ;
+				continue ;
+			}
+
+			value = property ;
+			property = forTextElement ? 'text' : 'background' ;
+		}
+
+		switch ( property ) {
+			case 'text' :
+				style.textColor = Color.parse( value ) ;
+				break ;
+			case 'background' :
+				style.backgroundColor = Color.parse( value ) ;
+				break ;
+		}
+	}
+
+	return style ;
+} ;
+

package/lib/Theme.js

@@ -0,0 +1,127 @@
+/*
+	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" ;
+
+
+
+const Palette = require( './Palette.js' ) ;
+const Color = require( './Color.js' ) ;
+
+
+
+function Theme( params = {} ) {
+	this.colors = {
+		background: '%white' ,
+
+		text: '%black' ,
+		linkText: '%blue' ,
+		hoverLinkText: '%bright blue' ,
+		visitedLinkText: '%blue' ,
+
+		headerRule: '%brighter gray' ,
+
+		//quoteBackground: '%lighter blue tint' ,
+		quoteBackground: '%brightest blue duller tone' ,
+		quote2Background: '%brighter blue duller tone' ,	// quote in quote
+		quote3Background: '%bright blue duller tone' ,	// quote in quote in quote
+
+		codeBackground: '%bright blue tint slightly dull' ,
+		codeBorder: '%slightly bright blue tint' ,
+
+		figureCaptionBackground: '%brightest blue dull tone' ,
+
+		tableRowBackground: '%white' ,
+		tableEvenRowBackground: '%lightest blue tint' ,
+		tableBorder: '%brighter blue tone slightly dull' ,
+		tableCaptionBackground: '%orange' ,
+		tableCaptionText: '%white' ,
+		tableColumnHead: '%lightest red' ,
+		tableRowHead: '%lightest green' ,
+		tableBothHead: '%brighter gray'
+	} ;
+
+	this.fonts = {
+		main: 'Helvetica,arial,freesans,clean,sans-serif'
+	} ;
+
+	this.sizes = {
+		text: '14px' ,
+		lineHeight: '1.7' ,
+		codeLineHeight: '1.4'
+	} ;
+
+	this.printSizes = {
+		text: '9pt' ,
+		lineHeight: '1.5' ,
+		codeLineHeight: '1.4'
+	} ;
+
+	this.palette = ! params.palette || typeof params.palette !== 'object' ? new Palette() :
+		params.palette instanceof Palette ? params.palette :
+		new Palette( params.palette ) ;
+
+	this.set( params ) ;
+	if ( this.palette ) { this.substituteWithPalette() ; }
+}
+
+module.exports = Theme ;
+
+
+
+const CATEGORIES = [ 'colors' , 'fonts' , 'sizes' , 'printSizes' ] ;
+
+
+
+Theme.prototype.set = function( params ) {
+	for ( let category of CATEGORIES ) {
+		if ( params[ category ] && typeof params[ category ] === 'object' ) {
+			for ( let key in params[ category ] ) {
+				if ( this[ category ][ key ] !== undefined ) {
+					this[ category ][ key ] = params[ category ][ key ] ;
+				}
+			}
+		}
+	}
+} ;
+
+
+
+Theme.prototype.substituteWithPalette = function() {
+	var property , value , colorObject ;
+
+	for ( property in this.colors ) {
+		value = this.colors[ property ] ;
+
+		if ( value[ 0 ] === '%' ) {
+			colorObject = Color.parse( value.slice( 1 ) ) ;
+			if ( this.palette.has( colorObject ) ) {
+				this.colors[ property ] = colorObject ;
+			}
+		}
+	}
+} ;
+

package/lib/book-source.js

@@ -0,0 +1,68 @@
+/*
+	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" ;
+
+
+
+const bookSource = {} ;
+module.exports = bookSource ;
+
+bookSource.StructuredDocument = require( './StructuredDocument.js' ) ;
+bookSource.Style = require( './Style.js' ) ;
+bookSource.Color = require( './Color.js' ) ;
+
+bookSource.Palette = require( './Palette.js' ) ;
+bookSource.Theme = require( './Theme.js' ) ;
+bookSource.HtmlRenderer = require( './HtmlRenderer.js' ) ;
+
+bookSource.parse = bookSource.StructuredDocument.parse ;
+
+
+
+const path = require( 'path' ) ;
+
+bookSource.getBuiltinCssPath = type => {
+	switch ( type ) {
+		case 'core' :
+		case 'standalone' :
+		case 'code' :
+			return path.join( __dirname , '..' , 'css' , type + '.css' ) ;
+	}
+
+	throw new Error( "There is no built-in CSS of type '" + type + "'" ) ;
+} ;
+
+bookSource.getBuiltinCssSync = type => {
+	const fs = require( 'fs' ) ;
+	return fs.readFileSync( bookSource.getBuiltinCssPath( type ) , 'utf8' ) ;
+} ;
+
+bookSource.getBuiltinCss = type => {
+	const fs = require( 'fs' ) ;
+	return fs.promises.readFile( bookSource.getBuiltinCssPath( type ) , 'utf8' ) ;
+} ;
+

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "book-source",
+  "version": "0.1.1",
+  "description": "A lightweight markup language, inspired by Markdown",
+  "main": "lib/book-source.js",
+  "directories": {
+    "test": "test"
+  },
+  "dependencies": {
+    "array-kit": "^0.2.6",
+    "highlight.js": "^11.9.0",
+    "string-kit": "^0.18.0"
+  },
+  "scripts": {
+    "test": "tea-time -R dot"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cronvel/book-source.git"
+  },
+  "keywords": [
+    "markup",
+    "book",
+    "source"
+  ],
+  "author": "Cédric Ronvel",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/cronvel/book-source/issues"
+  },
+  "copyright": {
+    "title": "Book Source",
+    "years": [
+      2023
+    ],
+    "owner": "Cédric Ronvel"
+  }
+}