fountain.ts
Advanced tools
Comparing version 1.0.0 to 1.0.1
{ | ||
"name": "fountain.ts", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"description": "A Typescript based parser for the screenplay format Fountain. Source originally from Matt Daly's fountain.js", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -18,6 +18,6 @@ # Fountain-ts | ||
``` Typescript | ||
import { Fountain } from 'fountain'; | ||
import { Fountain } from 'fountain.ts'; | ||
``` | ||
The output provided by Fountain-ts is an object literal of the format `{ title: '...', html: { title_page: '...', script: '...' } }`. | ||
The output provided by Fountain-ts is an object literal, a `Script` interface, of the format: `{ title: '...', html: { title_page: '...', script: '...' } }`. | ||
@@ -27,6 +27,6 @@ An example. | ||
``` Typescript | ||
import { Fountain, Script } from 'fountain'; | ||
import { Fountain, Script } from 'fountain.ts'; | ||
import * as assert from 'assert'; | ||
let text = `.OPENING TITLES | ||
const text = `.OPENING TITLES | ||
@@ -40,4 +40,4 @@ > BRICK & STEEL < | ||
let output: Script = fountain.parse(text), | ||
actual: string = output.html.script; | ||
let output: Script = fountain.parse(text); | ||
let actual = output.html.script; | ||
@@ -93,2 +93,4 @@ const expected = '<h3>OPENING TITLES</h3><p class="centered">BRICK & STEEL <br /> FULL RETIRED</p><h2>SMASH CUT TO:</h2>'; | ||
Just like fountain-js, Fountain-ts attaches some extra tokens, such as 'dialogue_begin' and 'dialogue_end'. These are used to block together sections, in the case of dialogue it allows Fountain-ts to attach a dual dialogue property to blocks of dialogue. | ||
Just like Fountain-js, Fountain-ts attaches some extra tokens, such as `'dialogue_begin'` and `'dialogue_end'`. These are used to block together sections. | ||
In the case of dual dialogue, it allows Fountain-ts to attach a `dual` property to blocks of dialogue. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
55558
93