fluent-transpiler 0.0.1 → 0.0.2

package/cli.js

@@ -21,9 +21,14 @@ new Command()
   .addOption(new Option('--comments', 'Include comments in output file.')
     .preset(true)
   )
+  .addOption(new Option('--include <includeMessages...>', 'Allowed messages to be included. Default to include all.'))
+  .addOption(new Option('--exclude <excludeMessages...>', 'Ignored messages to be excluded. Default to exclude none.'))
+  /*.addOption(new Option('--tree-shaking', 'Export all messages to allow tree shaking')
+    .preset(true)
+  )*/
   .addOption(new Option('--variable-notation <variableNotation>', 'What variable notation to use with exports')
     .choices(['camelCase','pascalCase','constantCase','snakeCase'])
-	.default('camelCase')
+	  .default('camelCase')
   )
   .addOption(new Option('--disable-minify', 'If disabled, all exported messages will have the same interface `(params) => ({value, attributes})`.')
 	.preset(true)

package/index.js

@@ -10,18 +10,24 @@ const exportDefault = `(id, params) => {
 `
 export const compile = (src, opts) => {
 	const options = {
-		variableNotation: 'camelCase',
-		disableMinify: false, // TODO needs better name
-		params: 'params',
 		comments: true,
 		errorOnJunk: true,
+		includeMessages: [],
+		excludeMessages: [],
+		//treeShaking: false,
+		variableNotation: 'camelCase',
+		disableMinify: false, // TODO needs better name strictInterface?
 		useIsolating: false,
+		params: 'params',
 		exportDefault,
 		...opts,
 	}
 	if (!Array.isArray(options.locale)) options.locale = [options.locale]
+	if (!Array.isArray(options.includeMessages)) options.includeMessages = [options.includeMessages]
+	if (!Array.isArray(options.excludeMessages)) options.excludeMessages = [options.excludeMessages]
 	
 	const metadata = {}
+	const exports = []
 	const functions = {} // global functions
 	let variable
 	
@@ -90,6 +96,15 @@ export const compile = (src, opts) => {
 		},
 		Message: (data) => {
 			const assignment = compileAssignment(data.id)
+			
+			if (options.includeMessages.length && !options.includeMessages.includes(assignment)) {
+				return ''
+			}
+			
+			if (options.excludeMessages.length && options.excludeMessages.includes(assignment)) {
+				return ''
+			}
+			
 			const templateStringLiteral = data.value && compileType(data.value, data.type)
 			metadata[assignment].attributes = data.attributes.length
 			let attributes = {}
@@ -100,29 +115,47 @@ export const compile = (src, opts) => {
 					}).join(',\n')}\n  }`
 			}
 			//
+			let message = ''
 			if (!options.disableMinify) {
-				if (metadata[variable].attributes) {
+				if (metadata[assignment].attributes) {
 					if (metadata[assignment].params) {
-						return `export const ${assignment} = (${options.params}) => ({
+						message = `(${options.params}) => ({
   value:${templateStringLiteral},
   attributes:${attributes}
 })\n`
-					}
-					return `export const ${assignment} = {
+					} else {
+					    message = `{
   value: ${templateStringLiteral},
   attributes: ${attributes}
 }\n`
+					}
+				} else if (metadata[assignment].params) {
+					message = `(${options.params}) => ${templateStringLiteral}\n`
+				} else {
+					message = `${templateStringLiteral}\n`
 				}
-				if (metadata[assignment].params) {
-					return `export const ${assignment} = (${options.params}) => ${templateStringLiteral}\n`
-				}
-				return `export const ${assignment} = ${templateStringLiteral}\n`
-			}
+			} else {
 			// consistent API
-			return `export const ${variable} = (${metadata[assignment].params ? options.params : ''}) => ({
+			  message = `(${metadata[assignment].params ? options.params : ''}) => ({
   value:${templateStringLiteral},
   attributes:${attributes}
 })\n`
+			}
+			//if (options.treeShaking) {
+				if (assignment === metadata[assignment].id) {
+					exports.push(`${assignment}`)
+				} else {
+					exports.push(`'${metadata[assignment].id}': ${assignment}`)
+				}
+				return `export const ${assignment} = ${message}`
+			/*} else {
+				if (assignment === metadata[assignment].id) {
+					exports.push(`${assignment}: ${message}`)
+				} else {
+					exports.push(`'${metadata[assignment].id}': ${message}`)
+				}
+			}*/
+			return ''
 		},
 		Comment: (data) => {
 			if (options.comments) return `// # ${data.content}\n`
@@ -300,14 +333,7 @@ const __select = (value, cases, fallback, options) => {
 `
 	}
 	output += `\n`+translations
-	output += `const __exports = {${Object.keys(metadata)
-			.filter(key => !metadata[key].term)
-			.map(key => {
-				if (key === metadata[key].id) return key
-				return `'${metadata[key].id}':${key}`
-			})
-			.join(', ')
-		}}\n`
+	output += `const __exports = {\n  ${exports.join(',\n  ')}\n}`
 	output += `\nexport default ${options.exportDefault}`
 	
 	return output
@@ -320,6 +346,5 @@ const variableNotation = {
 	snakeCase, 
 	constantCase
 }
-// for `export defaults`
 
 export default compile

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "fluent-transpiler",
-  "version": "0.0.1",
-  "description": "Transpile Fluent (ftl) files into optomized, tree-shakable, JavaScript EcmaScript Modules (esm).",
+  "version": "0.0.2",
+  "description": "Transpile Fluent (ftl) files into optimized, tree-shakable, JavaScript EcmaScript Modules (esm).",
   "main": "index.js",
   "type": "module",
   "bin": {
     "ftl": "cli.js"
   },
+  "files":[
+    "cli.js",
+    "index.js"
+  ],
   "scripts": {
     "test": "npm run test:cli && npm run test:unit",
     "test:cli": "./cli.js --locale en-CA --locale en --use-isolating --variable-notation camelCase test/files/index.ftl --output test/files/index.mjs",
@@ -33,7 +37,7 @@
   "bugs": {
     "url": "https://github.com/willfarrell/fluent-transpiler/issues"
   },
-  "homepage": "https://middy.js.org",
+  "homepage": "https://github.com/willfarrell/fluent-transpiler",
   "dependencies": {
     "@fluent/syntax": "0.18.1",
     "change-case": "4.1.2",

package/test/files/index.ftl

@@ -1,123 +0,0 @@
-# https://projectfluent.org/fluent/guide/
-# Writing Text
-text = text: hard coded.
-
-## Placeables
-replaceParam = param: { $string } | { $integer } | {$decimal} | {$number} .
-
--term = Firefox
-replaceTerm = term: { -term }.
-
--brand-name = 
-    { $case ->
-        *[nominative] Firefox
-        [locative] Firefoksie
-    }
-parameterized-terms = Informacje o { -brand-name(case: "locative") }.
-
-
--term-with-var = {$number}
-termWithVariable = {-term-with-var}
-
-### Message References
-messageValue = message: { replaceTerm }
-messageNestedParamValue = message: { replaceParam }
-
-
-## Special Characters
-openingBrace = This message features an opening curly brace: {"{"}.
-closingBrace = This message features a closing curly brace: {"}"}.
-
-blankIsRemoved =     This message starts with no blanks.
-blankIsPreserved = {"    "}This message starts with 4 spaces.
-
-leadingBracket =
-  This message has an opening square bracket
-  at the beginning of the third line:
-  {"["}.
-
-literalQuote = Text in "double quotes".
-# This is OK, but cryptic and hard to read and edit.
-literalEscapedQuote = Text in {"\""}double quotes{"\""}.
-
-
-privacyLabel = Privacy{"\u00A0"}Policy
-
-# The dash character is an EM DASH but depending on the font face,
-# it might look like an EN DASH.
-dash = It's a dash—or is it?
-
-dashUnicode = It's a dash{"\u2014"}or is it?
-
-emoji = 😂
-emojiUnicode = {"\u01F602"}
-
-## Multiline Text
-singleLine = Text can be written in a single line.
-
-multiLine = Text can also span multiple lines
-  as long as each new line is indented
-  by at least one space.
-
-block =
-  Sometimes it's more readable to format
-  multiline text as a "block", which means
-  starting it on a new line. All lines must
-  be indented by at least one space.
-  
-leadingBlankSpaces =     This message's value starts with the word "This".
-leadingBlankLines =
-
-
-  This message's value starts with the word "This".
-  The blank lines under the identifier are ignored.
-
-blankLines =
-
-  The blank line above this line is ignored.
-  This is a second line of the value.
-  
-  The blank line above this line is preserved.
-
-multiLineIndent =
-    This message has 4 spaces of indent
-    on the second line of its value.
-
-## Functions
-timeElapsed = Time elapsed: { NUMBER($number, maximumFractionDigits: 0) }s.
-
-todayIs = Today is { DATETIME($date) }
-
-## Selectors
-selectorNumberCardinal =
-{ $number ->
-  [zero] There are {$number} (zero).
-  [one] There are {$number} (one).
-   *[other] There are { $number } (other).
-}
-
-selectorNumberOrdinal =
-{ NUMBER($number, type: "ordinal") ->
-  [-1] There are {$number} (-1).
-  [zero] There are {$number} (zero).
-  [one] There are {$number} (one).
-  [two] There are {$number} (two).
-  [3.0] There are {$number} (3).
-  [few] There are {$number} (few).
-  [many] There are {$number} (many).
-  [toomany] There are {$number} (toomany).
-   *[other] There are { $number } (other).
-}
-
-subSelector = {selectorNumberOrdinal}
-
-## Attributes
-loginInput = Predefined value
-  .placeholder = email@example.com
-  .ariaLabel = Login input value
-  .title = Type your login email
-
-attributeHowTo =
-    To add an attribute to this messages, write
-    {".attr = Value"} on a new line.
-    .attr = An actual attribute (not part of the text value above)

package/test/files/index.mjs

@@ -1,125 +0,0 @@
-const __locales = "en-CA"
-
-const __formatDateTime = (value, options) => {
-	return new Intl.DateTimeFormat(__locales, options).format(value)
-}
-
-const __formatNumber = (value, options) => {
-	return new Intl.NumberFormat(__locales, options).format(value)
-}
-
-const __formatVariable = (value) => {
-  if (typeof value === 'string') return value
-  const decimal =  Number.parseFloat(value)
-  const number = Number.isInteger(decimal) ? Number.parseInt(value) : decimal
-  return __formatNumber(number)
-}
-
-const __select = (value, cases, fallback, options) => {
-	const pluralRules = new Intl.PluralRules(__locales, options)
-	const rule = pluralRules.select(value)
-	return cases[value] ?? cases[rule] ?? fallback
-}
-
-export const text = `text: hard coded.`
-// ## Placeables
-export const replaceParam = (params) => `param: ${__formatVariable(params?.string)} | ${__formatVariable(params?.integer)} | ${__formatVariable(params?.decimal)} | ${__formatVariable(params?.number)} .`
-const term = `Firefox`
-export const replaceTerm = `term: ${term}.`
-const brandName = (params) => `${__select(
-    params?.case,
-    {
-      'locative': `Firefoksie`
-    },
-    `Firefox`
-  )}`
-export const parameterizedTerms = (params) => `Informacje o ${brandName({ ...params, "case":"locative" })}.`
-const termWithVar = (params) => `${params?.number}`
-export const termWithVariable = (params) => `${termWithVar(params)}`
-// ### Message References
-export const messageValue = `message: ${replaceTerm}`
-export const messageNestedParamValue = (params) => `message: ${replaceParam(params)}`
-// ## Special Characters
-export const openingBrace = `This message features an opening curly brace: ${"{"}.`
-export const closingBrace = `This message features a closing curly brace: ${"}"}.`
-export const blankIsRemoved = `This message starts with no blanks.`
-export const blankIsPreserved = `${"    "}This message starts with 4 spaces.`
-export const leadingBracket = `This message has an opening square bracket
-at the beginning of the third line:
-${"["}.`
-export const literalQuote = `Text in "double quotes".`
-export const literalEscapedQuote = `Text in ${"\""}double quotes${"\""}.`
-export const privacyLabel = `Privacy${"\u00A0"}Policy`
-export const dash = `It's a dash—or is it?`
-export const dashUnicode = `It's a dash${"\u2014"}or is it?`
-export const emoji = `😂`
-export const emojiUnicode = `${"\u01F602"}`
-// ## Multiline Text
-export const singleLine = `Text can be written in a single line.`
-export const multiLine = `Text can also span multiple lines
-as long as each new line is indented
-by at least one space.`
-export const block = `Sometimes it's more readable to format
-multiline text as a "block", which means
-starting it on a new line. All lines must
-be indented by at least one space.`
-export const leadingBlankSpaces = `This message's value starts with the word "This".`
-export const leadingBlankLines = `This message's value starts with the word "This".
-The blank lines under the identifier are ignored.`
-export const blankLines = `The blank line above this line is ignored.
-This is a second line of the value.
-
-The blank line above this line is preserved.`
-export const multiLineIndent = `This message has 4 spaces of indent
-on the second line of its value.`
-// ## Functions
-export const timeElapsed = (params) => `Time elapsed: ${__formatNumber(params?.number, {"maximumFractionDigits":"0"})}s.`
-export const todayIs = (params) => `Today is ${__formatDateTime(params?.date, {})}`
-// ## Selectors
-export const selectorNumberCardinal = (params) => `${__select(
-    params?.number,
-    {
-      'zero': `There are ${__formatVariable(params?.number)} (zero).`,
-      'one': `There are ${__formatVariable(params?.number)} (one).`
-    },
-    `There are ${__formatVariable(params?.number)} (other).`
-  )}`
-export const selectorNumberOrdinal = (params) => `${__select(
-    __formatNumber(params?.number, {"type":"ordinal"}),
-    {
-      '-1': `There are ${__formatVariable(params?.number)} (-1).`,
-      'zero': `There are ${__formatVariable(params?.number)} (zero).`,
-      'one': `There are ${__formatVariable(params?.number)} (one).`,
-      'two': `There are ${__formatVariable(params?.number)} (two).`,
-      '3': `There are ${__formatVariable(params?.number)} (3).`,
-      'few': `There are ${__formatVariable(params?.number)} (few).`,
-      'many': `There are ${__formatVariable(params?.number)} (many).`,
-      'toomany': `There are ${__formatVariable(params?.number)} (toomany).`
-    },
-    `There are ${__formatVariable(params?.number)} (other).`
-  )}`
-export const subSelector = (params) => `${selectorNumberOrdinal(params)}`
-// ## Attributes
-export const loginInput = {
-  value: `Predefined value`,
-  attributes: {
-    placeholder: `email@example.com`,
-    ariaLabel: `Login input value`,
-    title: `Type your login email`
-  }
-}
-export const attributeHowTo = {
-  value: `To add an attribute to this messages, write
-${".attr = Value"} on a new line.`,
-  attributes: {
-    attr: `An actual attribute (not part of the text value above)`
-  }
-}
-const __exports = {text, replaceParam, replaceTerm, 'parameterized-terms':parameterizedTerms, termWithVariable, messageValue, messageNestedParamValue, openingBrace, closingBrace, blankIsRemoved, blankIsPreserved, leadingBracket, literalQuote, literalEscapedQuote, privacyLabel, dash, dashUnicode, emoji, emojiUnicode, singleLine, multiLine, block, leadingBlankSpaces, leadingBlankLines, blankLines, multiLineIndent, timeElapsed, todayIs, selectorNumberCardinal, selectorNumberOrdinal, subSelector, loginInput, attributeHowTo}
-
-export default (id, params) => {
-	const source = __exports[id] ?? __exports['_'+id]
-	if (typeof source === 'undefined') return '*** '+id+' ***'
-	if (typeof source === 'function') return source(params)
-	return source
-}

package/test/index.js

@@ -1,84 +0,0 @@
-import test from 'node:test'
-import { deepEqual } from 'node:assert'
-import {readFile,writeFile} from 'node:fs/promises'
-import compile from '../index.js'
-
-import { FluentBundle, FluentResource } from "@fluent/bundle"
-
-// input
-const ftl = await readFile('./test/files/index.ftl', {encoding:'utf8'})
-
-// compiled
-const js = compile(ftl, {locale:'en-CA', variableNotation: 'camelCase', useIsolating:false})
-await writeFile('./test/files/index.mjs', js, 'utf8')
-const {default:fluentCompiled} = await import('./files/index.mjs') // TODO fix default
-
-// core
-let bundle = new FluentBundle('en-CA', {useIsolating:false});
-let errors = bundle.addResource(new FluentResource(ftl));
-if (errors.length) {
-  console.log('Error: bundle.addResource', errors)
-}
-const fluentBundle = (id, params) => {
-  const message = bundle.getMessage(id)
-  if (!message) {
-    console.log('Error', id, message)
-    return 'error'
-  }
-  const attributes = {}
-  for(const attr in message.attributes) {
-    attributes[attr] = bundle.formatPattern(message.attributes[attr], params)
-  }
-  const value = bundle.formatPattern(message.value, params)
-  if (Object.keys(message.attributes).length) {
-    return {value, attributes}
-  }
-  return value
-}
-
-// compile
-test(`Should throw error when Junk is parsed`, async (t) => {
-  try {
-    const js = compile(`-brand-name = {}`, {locale:'en-CA', errorOnJunk:true})
-    console.log(js)
-    throw new Error('fail')
-  } catch (e) {
-    deepEqual(e.message, 'Junk found')
-  }
-})
-
-test(`Should include comments`, async (t) => {
-    const js = compile(`
-# Comment
-## GroupComment
-### ResourceComment
-`, {locale:'en-CA', comments:true})
-    deepEqual(js.includes(`// # Comment
-// ## GroupComment
-// ### ResourceComment`), true)
-
-})
-
-// tests
-const params = {string:'0.0',integer:-2, decimal: 3.5, number:9999999.00, date: new Date()}
-for (const id of Object.keys(fluentCompiled)) {
-  if (id === 'default') continue
-  test(`Should format ${id}`, async (t) => {
-    deepEqual(fluentCompiled(id, params), fluentBundle(id, params))
-  })
-}
-
-// selector
-for(const param of [-1,0,1,2,3,4,5,10]) {
-  let id = 'selectorNumberCardinal'
-  test(`Should format ${id} with ${param}`, async (t) => {
-     params.number = param
-    deepEqual(fluentCompiled(id, params), fluentBundle(id, params))
-  })
-
-  id = 'selectorNumberOrdinal'
-  test(`Should format ${id} with ${param}`, async (t) => {
-     params.number = param
-    deepEqual(fluentCompiled(id, params), fluentBundle(id, params))
-  })
-}