Merge pull request #44 from PolymerLabs/new-runtime

Replace runtime code generation with static lit-localize library

Author: aomarks

CHANGELOG.md

@@ -10,16 +10,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [BREAKING] The `tsOut` parameter is replaced by the new `output` object with
   `mode: "runtime"|"transform"`.
 
+- [BREAKING] Runtime mode no longer emits a `localization.ts` module. Instead,
+  users should always import from the `lit-localize` module and use
+  `configureLocalization`, `msg`, and other functions. See the README details of
+  this new API.
+
 - Add `transform` output mode, which emits an entire copy of the program in each
   locale, where all `msg` calls have been replaced with the raw translated
   template for that locale.
 
-- Add ability to generate a `setLocale` function by setting
-  `output.exportSetLocaleFunction: true`.
-
-- Add ability to customize how locale is initialized from the URL through
-  the `regexp` and `param` properties of the `output.setLocaleFromUrl` object.
-
 - Fix incorrect JSON schema error about `targetLocales` field not being a
   `string[]`.
 

config.schema.json

@@ -25,38 +25,15 @@
             "additionalProperties": false,
             "description": "Configuration specific to the `runtime` output mode.",
             "properties": {
-                "defaultLocale": {
-                    "description": "The initial locale, if no other explicit locale selection has been made.\nDefaults to the value of `sourceLocale`.",
-                    "type": "string"
-                },
-                "exportSetLocaleFunction": {
-                    "description": "If true, export a `setLocale(locale: Locale)` function in the generated\n`<outputDir>/localization.ts` module. Defaults to false.\n\nNote that calling this function will set the locale for subsequent calls to\n`msg`, but will not automatically re-render existing templates.",
-                    "type": "boolean"
-                },
                 "mode": {
                     "enum": [
                         "runtime"
                     ],
                     "type": "string"
                 },
                 "outputDir": {
-                    "description": "Output directory for generated TypeScript modules. After running\nlit-localize, this directory will contain:\n\n1. localization.ts -- A TypeScript module that exports the `msg` function,\n    along with other utilities.\n\n2. <locale>.ts -- For each `targetLocale`, a TypeScript module that exports\n    the translations in that locale keyed by message ID. These modules are\n    used automatically by localization.ts and should not typically be\n    imported directly by user code.",
+                    "description": "Output directory for generated TypeScript modules. Into this directory will\nbe generated a <locale>.ts for each `targetLocale`, each a TypeScript\nmodule that exports the translations in that locale keyed by message ID.",
                     "type": "string"
-                },
-                "setLocaleFromUrl": {
-                    "additionalProperties": false,
-                    "description": "Automatically set the locale based on the URL at application startup.",
-                    "properties": {
-                        "param": {
-                            "description": "Set locale based on the value of a URL query parameter.\n\nFinds the first matching query parameter from `window.location.search`.\nIf no such URL query parameter is set, or if it is not a valid locale\ncode, then `defaultLocale` is used.\n\nIt is an error to set both `regexp` and `param`.\n\nExamples:\n\n1. \"lang\"\n\n     https://example.com?foo&lang=es&bar\n                                  ^^",
-                            "type": "string"
-                        },
-                        "regexp": {
-                            "description": "Set locale based on matching a regular expression against the URL.\n\nThe regexp will be matched against `window.location.href`, and the first\ncapturing group will be used as the locale. If no match is found, or if\nthe capturing group does not contain a valid locale code, then\n`defaultLocale` is used.\n\nOptionally use the special string `:LOCALE:` to substitute a capturing\ngroup into the regexp that will only match the currently configured\nlocale codes (`sourceLocale` and `targetLocales`). For example, if\nsourceLocale=en and targetLocales=es,zh_CN, then the regexp\n\"^https?://:LOCALE:\\\\.\" becomes \"^https?://(en|es|zh_CN)\\\\.\".\n\nTips: Remember to double-escape literal backslashes (once for JSON, once\nfor the regexp), and note that you can use `(?:foo)` to create a\nnon-capturing group.\n\nIt is an error to set both `regexp` and `param`.\n\nExamples:\n\n1. \"^https?://[^/]+/:LOCALE:(?:$|[/?#])\"\n\n     Set locale from the first path component.\n\n     E.g. https://www.example.com/es/foo\n                                  ^^\n\n2. \"^https?://:LOCALE:\\\\.\"\n\n     Set locale from the first subdomain.\n\n     E.g. https://es.example.com/foo\n                  ^^",
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
                 }
             },
             "required": [

src/config.ts

@@ -136,17 +136,6 @@ export function readConfigFileAndWriteSchema(configPath: string): Config {
   }
 
   const validated = parsed as ConfigFile;
-  const output = validated.output;
-  if (output.mode === 'runtime' && output.setLocaleFromUrl) {
-    if (!!output.setLocaleFromUrl.param === !!output.setLocaleFromUrl.regexp) {
-      throw new KnownError(
-        `Error validating config file ${configPath}:\n\n` +
-          `If output.setLocaleFromUrl is set, then either param or regexp ` +
-          `must be set, but not both.`
-      );
-    }
-  }
-
   writeConfigSchemaIfMissing(validated, configPath);
 
   const baseDir = pathLib.dirname(configPath);