book-source 0.1.1

package/.eslintrc.js

@@ -0,0 +1,168 @@
+module.exports = {
+	'root': true ,
+	'env': {
+		'browser': true ,
+		'node': true ,
+		'es6': true ,
+		'es2022': true
+	} ,
+	'parserOptions': {
+		'ecmaVersion': 2022
+	} ,
+	'extends': [ 'eslint:recommended' ] ,
+	'ignorePatterns': [ "*.min.js" ] ,
+	'rules': {
+		
+		/*
+			Bad code -- detect anything that can be broken or lead to bugs
+		*/
+		
+		
+		
+		'strict': [ 'error' , 'global' ] ,
+		'unicode-bom': [ 'error' , 'never' ] ,
+		'radix': 'error' ,
+		'eqeqeq': 'error' ,
+		'consistent-return': 'off' ,
+		'valid-typeof': 'error' ,
+		'no-unneeded-ternary': 'error' ,
+		'no-unused-vars': 'warn' ,	// During development phase, it's boring to clean unused var since they can be used later
+		'no-lonely-if': 'off' ,		// Can hurt semantic programming
+		'no-nested-ternary': 'off' ,	// Now I use the streamlined ternary operator a lot
+		'no-shadow': 'error' ,
+		'no-shadow-restricted-names': 'error' ,
+		'require-atomic-updates': 'off' ,	// check for possible race condition on assignment, interesting but too nitpicky
+		
+		
+		
+		/*
+			Code preferences
+		*/
+		
+		
+		
+		'prefer-arrow-callback': 'error' ,
+		'prefer-spread': 'warn' ,
+		'prefer-rest-params': 'warn' ,
+		'no-control-regex': 'off' ,	// because thing like \x00 are considered like a control even if escaped...
+		'no-fallthrough': 'off' ,
+		'no-empty': [ 'error' , {
+			'allowEmptyCatch': true
+		} ] ,
+		
+		
+		
+		/*
+			Coding styles -- cosmetic rules and opinionated preferences
+		*/
+		
+		
+		
+		// Indent & spaces (general)
+		'indent': [ 'error' , 'tab' , {
+			'SwitchCase': 1 ,
+			'MemberExpression': 1 ,
+			'flatTernaryExpressions': true
+		} ] ,
+		'newline-per-chained-call': 'off',
+		'no-multi-spaces': 'off' ,
+		'block-spacing': 'error' ,
+		'comma-spacing': [ 'error' , {
+			'before': true ,
+			'after': true
+		} ] ,
+		'no-whitespace-before-property': 'error' ,
+		'space-before-blocks': 'error' ,
+		'space-before-function-paren': [ 'error' , {
+			'anonymous': 'never',
+			'named': 'never',
+			'asyncArrow': 'always'
+		} ] ,
+		'space-infix-ops': 'error' ,
+		'space-unary-ops': [ 'error' , {
+			'words': true ,
+			'nonwords': true ,
+			'overrides': {
+				//'-': false ,
+			}
+		} ] ,
+		'space-in-parens': [ 'error' , 'always' , {
+			'exceptions': [ 'empty' ]
+		} ] ,
+		'no-trailing-spaces': 'error' ,
+		'switch-colon-spacing': [ 'error' , {
+			'after': true ,
+			'before': true
+		} ] ,
+		'arrow-spacing': 'error' ,
+		'rest-spread-spacing': [ 'error' , 'always' ] ,
+		/* Troublesome with commented line of code
+		'spaced-comment': [ 'error' , 'always' , {
+			'line': {
+				'markers': [ '/' ],
+				'exceptions': [ '-', '*', '/' ]
+			} ,
+			'block': {
+				'exceptions': [ '*' ] ,
+				'balanced': true
+			}
+		} ] ,
+		*/
+		
+		
+		// Semi-colon
+		'semi': [ 'error' , 'always' ] ,
+		'semi-style': [ 'error' , 'last' ] ,
+		'semi-spacing': [ 'error' , {
+			'before': true ,
+			'after': true
+		} ] ,
+
+		// Objects
+		'key-spacing': [ 'error' , {
+			'beforeColon': false ,
+			'afterColon': true ,
+			'mode': 'strict'
+		} ] ,
+		'object-curly-newline': [ 'error' , {
+			'ObjectExpression' : {
+				'consistent': true ,
+				'minProperties': 4
+			} ,
+			'ObjectPattern' : {
+				// object destructuring assigment
+				'consistent': true ,
+				'minProperties': 8
+			}
+		} ] ,
+		'object-curly-spacing': [ 'error' , 'always' ] ,
+		'object-property-newline': [ 'error' , { 'allowMultiplePropertiesPerLine': true } ] ,
+
+		
+		// Arrays
+		'array-bracket-newline': [ 'error' , 'consistent' ] ,
+		//'array-element-newline': [ 'error' , { 'multiline': true , 'minItems': 5 } ] ,
+		'array-bracket-spacing': [ 'error' , 'always' ],
+		
+		'brace-style': [ 'error' , 'stroustrup' , {
+			'allowSingleLine': true
+		} ] ,
+		
+		
+		// Misc style
+		'no-else-return': 'warn' ,
+		'comma-dangle': [ 'error' , 'never' ] ,
+		'quotes': 'off' ,
+		'camelcase': 'warn' ,
+		
+		
+		
+		/*
+			Method limitation
+		*/
+		
+		
+		
+		'no-console': 'off'
+	}
+} ;

package/Makefile

@@ -0,0 +1,112 @@
+
+
+
+# User rules
+
+# The first rule is the default rule, when invoking "make" without argument...
+# Build every buildable things
+#all: install doc browser
+all: install doc
+
+# Just install things so it works, basicaly: it just performs a "npm install --production" ATM
+install: log/npm-install.log
+
+# Just install things so it works, basicaly: it just performs a "npm install" ATM
+dev-install: log/npm-dev-install.log
+
+# Build
+#build: browser
+
+# Build the browser lib
+#browser: browser/svg-kit.js browser/svg-kit.min.js
+
+# This run the JsHint & Mocha BDD test, display it to STDOUT & save it to log/mocha.log and log/jshint.log
+test: log/jshint.log log/mocha.log
+
+# This run the JsHint, display it to STDOUT & save it to log/jshint.log
+lint: log/jshint.log
+
+# This run the Mocha BDD test, display it to STDOUT & save it to log/mocha.log
+unit: log/mocha.log
+
+# This build the doc and README.md
+doc: README.md
+
+# This publish to NPM and push to Github, if we are on master branch only
+publish: log/npm-publish.log log/github-push.log
+
+# Clean temporary things, or things that can be automatically regenerated
+clean: clean-all
+
+
+
+# Variables
+
+BROWSERIFY=browserify
+UGLIFY=uglifyjs
+
+
+
+# Files rules
+
+# Build the browser lib
+#browser/svg-kit.js: lib/*.js lib/*/*.js
+#	${BROWSERIFY} lib/svg-kit.js -i fs -i image-size -s svgKit -o browser/svg-kit.js
+
+# Build the browser minified lib
+#browser/svg-kit.min.js: browser/svg-kit.js
+#	${UGLIFY} browser/svg-kit.js -o browser/svg-kit.min.js -m
+
+# JsHint STDOUT test
+log/jshint.log: log/npm-dev-install.log lib/*.js test/*.js
+	${JSHINT} lib/*.js test/*.js | tee log/jshint.log ; exit $${PIPESTATUS[0]}
+
+# Mocha BDD STDOUT test
+log/mocha.log: log/npm-dev-install.log lib/*.js test/*.js
+	cd test ; ${MOCHA} *.js -R spec | tee ../log/mocha.log ; exit $${PIPESTATUS[0]}
+
+# README
+README.md: documentation.md
+	cat documentation.md > README.md
+
+# Mocha Markdown BDD spec
+bdd-spec.md: log/npm-dev-install.log lib/*.js test/*.js
+	cd test ; ${MOCHA} *.js -R markdown > ../bdd-spec.md
+
+# Upgrade version in package.json
+log/upgrade-package.log: lib/*.js test/*.js documentation.md
+	npm version patch -m "Upgrade package.json version to %s" | tee log/upgrade-package.log ; exit $${PIPESTATUS[0]}
+
+# Publish to NPM
+log/npm-publish.log: check-if-master-branch log/upgrade-package.log
+	npm publish | tee log/npm-publish.log ; exit $${PIPESTATUS[0]}
+
+# Push to Github/master
+log/github-push.log: lib/*.js test/*.js package.json
+	#'npm version patch' create the git tag by itself... 
+	#git tag v`cat package.json | grep version | sed -r 's/.*"([0-9.]*)".*/\1/'`
+	git push origin master --tags | tee log/github-push.log ; exit $${PIPESTATUS[0]}
+
+# NPM install
+log/npm-install.log: package.json
+	npm install --production | tee log/npm-install.log ; exit $${PIPESTATUS[0]}
+
+# NPM install for developpement usage
+log/npm-dev-install.log: package.json
+	npm install | tee log/npm-dev-install.log ; exit $${PIPESTATUS[0]}
+
+
+
+# PHONY rules
+
+.PHONY: clean-all check-if-master-branch
+
+# Delete files, mostly log and non-versioned files
+clean-all:
+	rm -rf log/*.log README.md bdd-spec.md node_modules
+
+# This will fail if we are not on master branch (grep exit 1 if nothing found)
+check-if-master-branch:
+	git branch | grep  "^* master$$"
+
+

package/README.md

@@ -0,0 +1,17 @@
+
+# Book Source
+
+A Lightweight Markup Language similar to Markdown.
+
+This lib parses Book Source and is shipped with a HTML renderer.
+
+New renderers can easily be created.
+
+The parser has zero regex.
+
+
+
+## Book Source syntax
+
+TODO
+

package/brainstorming

@@ -0,0 +1,213 @@
+
+
+✅ Heading: # Title
+✅ Anchor (generating <a name="anchor-name"></a>: #(anchor-name)
+
+✅ Paragraph are separated by empty lines
+✅ Forced line-break (at the end of line, with or without space after): \
+✅	or (at the begining of the line, with at least on space after): \
+
+✅ Multiline block are two-spaces indent (multiline header, list-item, etc)
+
+✅ Italic: *
+✅ Bold: **
+✅ Bold+italic: ***
+
+✅ Underline: _
+✅ 	or: __
+
+✅ Blockquote: (8-spaces-indent)
+✅ Nested blockquote: (multiple-of-8-spaces-indent)
+
+✅ Give proper credit to the quote: -- Name the quoted person, or the book, film, lyrics
+✅ Signature at the end of an article: -- Name of the signing person
+
+✅ Unordered list: *
+✅ 	or: -
+✅ Ordered list: 1.
+✅ Nested list, having more indentation
+
+✅ Inline code: `some code`
+✅ Inline code with double bacquote escape: ``some `code` with backquote``
+✅ 	or (extra forced space is trimmed): `` `code` ``
+✅ Code block: ```language
+
+✅ Clear float (3 or more -): <--->
+✅ Horizontal rule (3 or more -): ---
+✅ Horizontal rule + Clear float (3 or more - at both side): ---<>---
+
+✅ Custom style: [text]<style>
+   (where style can be a color like red, green, black, or other style like bold, italic, oblique, separated by comma ",")
+   (generate a <span>)
+
+✅ Title tooltip: [text][title text]
+
+✅ Link: [link text](href)
+✅ Link+Title: [link text][title text](href)
+
+✅ Inline image with alt text: ![alt text](href)
+✅ Inline image + alt text + title: ![alt text][title text](href)
+✅ Emoji and special characters: ![emoji-name]
+	pre-defined image: ![pre-defined-image-name]
+?	material icon: ![material-icon-name]
+✅ Block image: !=[alt text](href)
+✅ Block image with caption: !=[alt text][caption](href)
+✅ Block image + caption + title: !=[alt text][caption][title text](href)
+✅ Floating left block image: !<[alt text](href)
+✅ Floating right block image: !>[alt text](href)
+
+Block multimedia: !=[alt text](href)(media-type)
+	media type can be: image, video, audio
+
+
+
+
+
+## Metadata
+
+✅ Start metadata part: ---[[
+✅ End of metadata part: ]]---
+✅ Start special metadata part (spaces around the name are possible): ---[special-name[
+	Special metadata have a meaning for the renderer, for example most implementation should support 'theme' as a special metadata.
+	E.g.: ---[ theme [
+
+
+
+
+
+## Tables
+
+✅ Very simple table:
+
+| cell 1A  | cell 1B  | cell 1C  |
+| cell 2A  | cell 2B  | cell 2C  |
+| cell 3A  | cell 3B  | cell 3C  |
+
+
+
+✅ Table caption (no space between the pipe and the bracket chars): |[ Table caption text ]|
+✅ Multiline table caption (follow-up caption line): |[ ... follow-up text ]|
+✅ Template row/header-body separator (optional): |----------|--------|---------|
+✅ Multiline table head row (multiple lines before the row/body separator)
+✅ Optional row separator: |----------|--------|---------|
+✅ Multiline rows (all rows should be separated by a row separator)
+✅ Multiline single row is done by enforcing a trailing row separator
+✅ Table header should be before the row template
+✅ Template row (cell) defining a left-alignment column: |<------|
+✅ Template row (cell) defining a right-alignment column: |------>|
+✅ Template row (cell) defining a center-alignment column: |>------<|
+✅ Template row (cell) defining a justified content column: |<------>|
+✅ Template row (cell) defining a head column: |-------:|
+✅ Template row (cell) column background-color: |---<red>---|
+✅ Cell color background-color: |<red> some content |
+✅ Table caption background-color: |[ Table caption text ]|<red>
+✅ Row background-color (at the end of the row): |<red>
+✅ Thick column separator (the right-bar is doubled, inside template row, or any cell): ||
+✅ Thick row separator: |==========|========|=========|
+✅ Colspan (less cell in a row, use bar matching the template row to know which cell have colspan)
+✅ Rowspan (only one hyphen after and before the bar, with space in between: |-      -|
+✅ Rowspan + Colspan combo
+
+
+
+✅ Regular table:
+
+|[ Table caption text           ]|
+| header 1 | header 2 | header 3 |
+|----------|----------|----------|
+| cell 1A  | cell 1B  | cell 1C  |
+| cell 2A  | cell 2B  | cell 2C  |
+| cell 3A  | cell 3B  | cell 3C  |
+
+
+
+✅ Two-entries table:
+
+|[ Table caption text           ]|
+|          | header 1 | header 2 |
+|---------:|----------|----------|
+| entry 1  | cell 1A  | cell 1B  |
+| entry 2  | cell 2A  | cell 2B  |
+| entry 3  | cell 3A  | cell 3B  |
+
+
+
+✅ Multi-line table:
+
+|[ Multiline table caption text ]|
+|[ ... with extra line          ]|
+| header 1 | header 2 | header 3 |
+| ...      | ...      | ...      |
+|----------|----------|----------|
+| cell 1A  | cell 1B  | cell 1C  |
+| ...      | ...      | ...      |
+|----------|----------|----------|
+| cell 2A  | cell 2B  | cell 2C  |
+| ...      | ...      | ...      |
+|----------|----------|----------|
+| cell 3A  | cell 3B  | cell 3C  |
+| ...      | ...      | ...      |
+
+
+
+## Spreadsheet-like feature inside tables
+
+? Computed spreadsheet-like cell: |=(formula) |
+? Template row (cell) computed spreadsheet-like column: |---=(formula)---|
+? Computed spreadsheet-like row (starts with): |=(formula)|
+
+
+
+## Section and Column flow:
+
+Section break (3 or more): +++
+(Clearing all columns and start over on a fresh one-column section, close/open "section" tags)
+
+Column break (close/open "column" custom tags): |||
+
+
+
+## Misc:
+
+? Hover tooltip text block (support new lines inside the []): ?[text][[some block of text]]
+? Hover tooltip sub-document (href can point to markup, or html): ?[text](href)
+
+? Introduce a todo list item: -[ ]
+? Introduce a todo list item done: -[x]
+
+
+
+
+
+## Name Brainstorming for a Lightweight Markup Language
+
+Obvious names:
+
+Book Source (.bks) (to the point, but lacks of fun)
+XTX / eXtrem TeXt (.xtx) (txt -> xtx, quite memorable, neutral+ name)
+Mµ (.mu) (MarkUp)
+LMK (.lmk) (Lightweight MarKup)
+MKX (.mkx) (Markup X)
+MKTX (.mktx) (MarKup TeXt)
+Hyper Markdown (.hmd)
+Orthodoc (.otd) (not really cool, confusion with LibreOffice .odt)
+ArkTex / ArkTX (.arktx) (mARKup TEXt)
+CupTx (.cuptx) (marKUP TeXt)
+
+
+Abstract names:
+
+Feather / Plume (.fetr? .plume?)
+Hype (.hype) (but it's unlikely to have widespread adoption)
+Blast (.blast) (ok name, but not explicit)
+Popcorn (.pop .pcorn) (ok name, but not explicit)
+YO (.yo) (no pun, no reason, just sounds fun)
+
+
+Not available:
+
+Texy (.texy) (sounds sexy) (it's a PHP lib having the same scope than this one...)
+Litex (.litx) (Lite + Tex, because of Lightweight Markup Language, but too close to latex)
+Easy Doc / EZ Doc (.ezd) (cool, but not really available)
+xdoc (.xdoc) (similar to docx)
+

package/css/code.css

@@ -0,0 +1,120 @@
+.book-source .hljs {
+  display: block;
+  padding: 0.5em;
+  color: #333;
+  background: #f8f8f8;
+}
+
+.book-source .hljs-comment ,
+.book-source .hljs-template_comment ,
+.book-source .diff .hljs-header ,
+.book-source .hljs-javadoc {
+  color: #998;
+  font-style: italic;
+}
+
+.book-source .hljs-keyword ,
+.book-source .css .rule .hljs-keyword ,
+.book-source .hljs-winutils ,
+.book-source .javascript .hljs-title ,
+.book-source .nginx .hljs-title ,
+.book-source .hljs-subst ,
+.book-source .hljs-request ,
+.book-source .hljs-status {
+  color: #333;
+  font-weight: bold;
+}
+
+.book-source .hljs-number ,
+.book-source .hljs-hexcolor ,
+.book-source .ruby .hljs-constant {
+  color: #099;
+}
+
+.book-source .hljs-string ,
+.book-source .hljs-tag .hljs-value ,
+.book-source .hljs-phpdoc ,
+.book-source .tex .hljs-formula {
+  color: #d14;
+}
+
+.book-source .hljs-title ,
+.book-source .hljs-id ,
+.book-source .coffeescript .hljs-params ,
+.book-source .scss .hljs-preprocessor {
+  color: #900;
+  font-weight: bold;
+}
+
+.book-source .javascript .hljs-title ,
+.book-source .lisp .hljs-title ,
+.book-source .clojure .hljs-title ,
+.book-source .hljs-subst {
+  font-weight: normal;
+}
+
+.book-source .hljs-class .hljs-title ,
+.book-source .haskell .hljs-type ,
+.book-source .vhdl .hljs-literal ,
+.book-source .tex .hljs-command {
+  color: #458;
+  font-weight: bold;
+}
+
+.book-source .hljs-tag ,
+.book-source .hljs-tag .hljs-title ,
+.book-source .hljs-rules .hljs-property ,
+.book-source .django .hljs-tag .hljs-keyword {
+  color: #000080;
+  font-weight: normal;
+}
+
+.book-source .hljs-attribute ,
+.book-source .hljs-variable ,
+.book-source .lisp .hljs-body {
+  color: #008080;
+}
+
+.book-source .hljs-regexp {
+  color: #009926;
+}
+
+.book-source .hljs-symbol ,
+.book-source .ruby .hljs-symbol .hljs-string ,
+.book-source .lisp .hljs-keyword ,
+.book-source .tex .hljs-special ,
+.book-source .hljs-prompt {
+  color: #990073;
+}
+
+.book-source .hljs-built_in ,
+.book-source .lisp .hljs-title ,
+.book-source .clojure .hljs-built_in {
+  color: #0086b3;
+}
+
+.book-source .hljs-preprocessor ,
+.book-source .hljs-pragma ,
+.book-source .hljs-pi ,
+.book-source .hljs-doctype ,
+.book-source .hljs-shebang ,
+.book-source .hljs-cdata {
+  color: #999;
+  font-weight: bold;
+}
+
+.book-source .hljs-deletion {
+  background: #fdd;
+}
+
+.book-source .hljs-addition {
+  background: #dfd;
+}
+
+.book-source .diff .hljs-change {
+  background: #0086b3;
+}
+
+.book-source .hljs-chunk {
+  color: #aaa;
+}