fluent-transpiler 0.2.0 → 0.3.0

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 <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(
+      '--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

@@ -14,6 +14,7 @@ export const compile = (src, opts) => {
     errorOnJunk: true,
     includeMessages: [],
     excludeMessages: [],
+    excludeMessageValue: undefined,
     //treeShaking: false,
     variableNotation: 'camelCase',
     disableMinify: false, // TODO needs better name strictInterface?
@@ -27,6 +28,10 @@ export const compile = (src, opts) => {
     options.includeMessages = [options.includeMessages]
   if (!Array.isArray(options.excludeMessages))
     options.excludeMessages = [options.excludeMessages]
+  if (options.excludeMessageValue) {
+    // cast to template literal
+    options.excludeMessageValue = '`' + options.excludeMessageValue + '`'
+  }
 
   const metadata = {}
   const exports = []
@@ -128,6 +133,11 @@ export const compile = (src, opts) => {
 
       const templateStringLiteral =
         data.value && compileType(data.value, data.type)
+
+      if (options.excludeMessageValue === templateStringLiteral) {
+        templateStringLiteral = '``'
+      }
+
       metadata[assignment].attributes = data.attributes.length
       let attributes = {}
       if (metadata[assignment].attributes) {
@@ -202,7 +212,8 @@ export const compile = (src, opts) => {
     },
     // Element
     TextElement: (data) => {
-      return data.value
+      if (data.value === options.emptyString) return
+      return data.value.replaceAll('`', '\\`') // escape string literal
     },
     Placeable: (data, parent) => {
       return `${options.useIsolating ? '\u2068' : ''}\${${compileType(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluent-transpiler",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "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"
   }
 }