fluent-transpiler 0.2.1 → 0.3.1

package/cli.js

@@ -6,10 +6,10 @@ import { Command, Option } from 'commander'
 import compile from './index.js'
 
 const fileExists = async (filepath) => {
-	const stats = await stat(filepath)
-	if (!stats.isFile()) {
-	  throw new Error(`${filepath} is not a file`)
-	}
+  const stats = await stat(filepath)
+  if (!stats.isFile()) {
+    throw new Error(`${filepath} is not a file`)
+  }
 }
 
 new Command()
@@ -17,38 +17,70 @@ new Command()
   .description('Compile Fluent (.ftl) files to JavaScript (.js or .mjs)')
   //.version(package.version)
   .argument('<input>', 'Path to the Fluent file to compile')
-  .requiredOption('--locale <locale...>', 'What locale(s) to be used. Multiple can be set to allow for fallback. i.e. en-CA')
-  .addOption(new Option('--comments', 'Include comments in output file.')
-    .preset(true)
+  .requiredOption(
+    '--locale <locale...>',
+    'What locale(s) to be used. Multiple can be set to allow for fallback. i.e. en-CA'
+  )
+  .addOption(
+    new Option('--comments', 'Include comments in output file.').preset(true)
+  )
+  .addOption(
+    new Option(
+      '--include-key <includeMessageKey...>',
+      'Allowed messages to be included. Default to include all.'
+    )
+  )
+  .addOption(
+    new Option(
+      '--exclude-key <excludeMessageKey...>',
+      'Ignored messages to be excluded. Default to exclude none.'
+    )
+  )
+  .addOption(
+    new Option(
+      '--exclude-value <excludeMessageValue>',
+      'Set message to an empty string when it contains this value. Default to not allowing empty strings.'
+    )
   )
-  .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')
+  .addOption(
+    new Option(
+      '--variable-notation <variableNotation>',
+      'What variable notation to use with exports'
+    )
+      .choices(['camelCase', 'pascalCase', 'constantCase', 'snakeCase'])
+      .default('camelCase')
   )
-  .addOption(new Option('--disable-minify', 'If disabled, all exported messages will have the same interface `(params) => ({value, attributes})`.')
-	.preset(true)
+  .addOption(
+    new Option(
+      '--disable-minify',
+      'If disabled, all exported messages will have the same interface `(params) => ({value, attributes})`.'
+    ).preset(true)
   )
-  .addOption(new Option('--use-isolating', 'Wrap placeable with \\u2068 and \\u2069.')
-  	.preset(true)
+  .addOption(
+    new Option(
+      '--use-isolating',
+      'Wrap placeable with \\u2068 and \\u2069.'
+    ).preset(true)
+  )
+  .addOption(
+    new Option(
+      '-o, --output <output>',
+      'Path to store the resulting JavaScript file. Will be in ESM.'
+    )
   )
-  .addOption(new Option('-o, --output <output>', 'Path to store the resulting JavaScript file. Will be in ESM.'))
   .action(async (input, options) => {
-	await fileExists(input)
-	
-	const ftl = await readFile(input, {encoding:'utf8'})
-	
-	const js = compile(ftl, options)
-	if (options.output) {
-		await writeFile(options.output, js, 'utf8')
-	} else {
-		console.log(js)
-	}
-	
+    await fileExists(input)
+
+    const ftl = await readFile(input, { encoding: 'utf8' })
+
+    const js = compile(ftl, options)
+    if (options.output) {
+      await writeFile(options.output, js, 'utf8')
+    } else {
+      console.log(js)
+    }
   })
   .parse()
-

package/index.js

@@ -2,18 +2,19 @@ import { parse } from '@fluent/syntax'
 import { camelCase, pascalCase, constantCase, snakeCase } from 'change-case'
 
 const exportDefault = `(id, params) => {
-	const source = __exports[id] ?? __exports['_'+id]
-	if (typeof source === 'undefined') return '*** '+id+' ***'
-	if (typeof source === 'function') return source(params)
-	return source
+  const source = __exports[id] ?? __exports['_'+id]
+  if (typeof source === 'undefined') return '*** '+id+' ***'
+  if (typeof source === 'function') return source(params)
+  return source
 }
 `
 export const compile = (src, opts) => {
   const options = {
     comments: true,
     errorOnJunk: true,
-    includeMessages: [],
-    excludeMessages: [],
+    includeKey: [],
+    excludeKey: [],
+    excludeValue: undefined,
     //treeShaking: false,
     variableNotation: 'camelCase',
     disableMinify: false, // TODO needs better name strictInterface?
@@ -23,10 +24,15 @@ export const compile = (src, opts) => {
     ...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]
+  if (!Array.isArray(options.includeKey))
+    options.includeKey = [options.includeKey]
+  if (!Array.isArray(options.excludeKey))
+    options.excludeKey = [options.excludeKey]
+  if (options.excludeValue) {
+    // cast to template literal
+    options.excludeValue = '`' + options.excludeValue + '`'
+  }
+  console.log({ options })
 
   const metadata = {}
   const exports = []
@@ -113,21 +119,26 @@ export const compile = (src, opts) => {
       const assignment = compileAssignment(data.id)
 
       if (
-        options.includeMessages.length &&
-        !options.includeMessages.includes(assignment)
+        options.includeKey.length &&
+        !options.includeKey.includes(assignment)
       ) {
         return ''
       }
 
       if (
-        options.excludeMessages.length &&
-        options.excludeMessages.includes(assignment)
+        options.excludeKey.length &&
+        options.excludeKey.includes(assignment)
       ) {
         return ''
       }
 
       const templateStringLiteral =
         data.value && compileType(data.value, data.type)
+
+      if (options.excludeValue === templateStringLiteral) {
+        templateStringLiteral = '``'
+      }
+
       metadata[assignment].attributes = data.attributes.length
       let attributes = {}
       if (metadata[assignment].attributes) {
@@ -173,12 +184,12 @@ export const compile = (src, opts) => {
       }
       return `export const ${assignment} = ${message}`
       /*} else {
-				if (assignment === metadata[assignment].id) {
-					exports.push(`${assignment}: ${message}`)
-				} else {
-					exports.push(`'${metadata[assignment].id}': ${message}`)
-				}
-			}*/
+        if (assignment === metadata[assignment].id) {
+          exports.push(`${assignment}: ${message}`)
+        } else {
+          exports.push(`'${metadata[assignment].id}': ${message}`)
+        }
+      }*/
       return ''
     },
     Comment: (data) => {
@@ -202,6 +213,7 @@ export const compile = (src, opts) => {
     },
     // Element
     TextElement: (data) => {
+      if (data.value === options.emptyString) return
       return data.value.replaceAll('`', '\\`') // escape string literal
     },
     Placeable: (data, parent) => {
@@ -358,10 +370,10 @@ const formatTime = (value) => {
   value = new Date(value)
   if (isNaN(value.getTime())) return value
   try {
-	const [duration, unit] = relativeTimeDiff(value)
-	return relativeTimeFormat.format(duration, unit)
+  const [duration, unit] = relativeTimeDiff(value)
+  return relativeTimeFormat.format(duration, unit)
   } catch (e) {
-	return dateTimeFormat.format(value)
+  return dateTimeFormat.format(value)
   }
 }
 */
@@ -375,24 +387,24 @@ const __relativeTimeDiff = (d) => {
   const msPerMonth = msPerDay * 30
   const msPerYear = msPerDay * 365.25
   const elapsed = d - new Date()
-	
+
   if (Math.abs(elapsed) < msPerMinute) {
     return [Math.round(elapsed / 1000), 'second']
   }
   if (Math.abs(elapsed) < msPerHour) {
-  	return [Math.round(elapsed / msPerMinute), 'minute']
+    return [Math.round(elapsed / msPerMinute), 'minute']
   }
   if (Math.abs(elapsed) < msPerDay) {
-  	return [Math.round(elapsed / msPerHour), 'hour']
+    return [Math.round(elapsed / msPerHour), 'hour']
   }
   if (Math.abs(elapsed) < msPerWeek * 2) {
-  	return [Math.round(elapsed / msPerDay), 'day']
+    return [Math.round(elapsed / msPerDay), 'day']
   }
   if (Math.abs(elapsed) < msPerMonth) {
-  	return [Math.round(elapsed / msPerWeek), 'week']
+    return [Math.round(elapsed / msPerWeek), 'week']
   }
   if (Math.abs(elapsed) < msPerYear) {
-  	return [Math.round(elapsed / msPerMonth), 'month']
+    return [Math.round(elapsed / msPerMonth), 'month']
   }
   return [Math.round(elapsed / msPerYear), 'year']
 }
@@ -400,8 +412,8 @@ const __formatRelativeTime = (value, options) => {
   if (typeof value === 'string') value = new Date(value)
   if (isNaN(value.getTime())) return value
   try {
-	const [duration, unit] = __relativeTimeDiff(value)
-	return new Intl.RelativeTimeFormat(__locales, options).format(duration, unit)
+  const [duration, unit] = __relativeTimeDiff(value)
+  return new Intl.RelativeTimeFormat(__locales, options).format(duration, unit)
   } catch (e) {}
   return new Intl.DateTimeFormat(__locales, options).format(value)
 }
@@ -410,16 +422,16 @@ const __formatRelativeTime = (value, options) => {
   if (functions.__formatDateTime) {
     output += `
 const __formatDateTime = (value, options) => {
-	if (typeof value === 'string') value = new Date(value)
-	if (isNaN(value.getTime())) return value
-	return new Intl.DateTimeFormat(__locales, options).format(value)
+  if (typeof value === 'string') value = new Date(value)
+  if (isNaN(value.getTime())) return value
+  return new Intl.DateTimeFormat(__locales, options).format(value)
 }
 `
   }
   if (functions.__formatVariable || functions.__formatNumber) {
     output += `
 const __formatNumber = (value, options) => {
-	return new Intl.NumberFormat(__locales, options).format(value)
+  return new Intl.NumberFormat(__locales, options).format(value)
 }
 `
   }
@@ -436,9 +448,9 @@ const __formatVariable = (value) => {
   if (functions.__select) {
     output += `
 const __select = (value, cases, fallback, options) => {
-	const pluralRules = new Intl.PluralRules(__locales, options)
-	const rule = pluralRules.select(value)
-	return cases[value] ?? cases[rule] ?? fallback
+  const pluralRules = new Intl.PluralRules(__locales, options)
+  const rule = pluralRules.select(value)
+  return cases[value] ?? cases[rule] ?? fallback
 }
 `
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluent-transpiler",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Transpile Fluent (ftl) files into optimized, tree-shakable, JavaScript EcmaScript Modules (esm).",
   "main": "index.js",
   "type": "module",
@@ -14,7 +14,7 @@
   "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",
-    "test:unit": "c8 node --test"
+    "test:unit": "node --test"
   },
   "repository": {
     "type": "git",
@@ -39,12 +39,15 @@
   },
   "homepage": "https://github.com/willfarrell/fluent-transpiler",
   "dependencies": {
-    "@fluent/syntax": "0.18.1",
-    "change-case": "4.1.2",
-    "commander": "9.4.0"
+    "@fluent/syntax": "0.19.0",
+    "change-case": "5.4.4",
+    "commander": "13.1.0"
   },
   "devDependencies": {
-    "@fluent/bundle": "^0.17.1",
-    "c8": "^7.12.0"
+    "@fluent/bundle": "^0.19.0"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/willfarrell"
   }
 }