Migrate @fluent/bundle to TypeScript

common.mk

@@ -14,34 +14,28 @@ all: lint test build
 # Used for pre-publishing.
 dist: clean lint test build html
 
-lint:
+_lint:
 	@eslint --config $(ROOT)/eslint_src.json --max-warnings 0 src/
 	@eslint --config $(ROOT)/eslint_test.json --max-warnings 0 test/
-	@echo -e " $(OK) $@"
+	@echo -e " $(OK) lint"
 
-html:
+_html:
 ifneq (,$(wildcard ./.esdoc.json))
 	@esdoc
-	@echo -e " $(OK) $@ built"
+	@echo -e " $(OK) html built"
 endif
 
+_clean:
+	@rm -f index.js compat.js
+	@rm -rf .nyc_output coverage
+	@echo -e " $(OK) clean"
+
 deps:
 	@npm install
-	@echo -e " $(OK) $@ installed"
+	@echo -e " $(OK) deps installed"
 
 depsclean:
 	@rm -rf node_modules
-	@echo -e " $(OK) $@"
-
-CHANGELOG.md:
-	@if [ -z "$(SINCE)" ]; \
-	    then echo 'Specify last version with SINCE=x.y.z' && exit 1; \
-	fi
-	@git log $(PACKAGE)@$(SINCE) HEAD --pretty=format:'  - (%h) %s' $(CURDIR) \
-	    | cat - <(echo -e "\n\n") CHANGELOG.md \
-	    | sponge CHANGELOG.md
-	@echo -e " $(OK) $@ updated; make sure to edit it"
-
-.PHONY: test html CHANGELOG.md
+	@echo -e " $(OK) deps clean"
 
 OK := \033[32;01m✓\033[0m

fluent-bundle/.gitignore

@@ -1,2 +1,3 @@
+esm/
 index.js
 compat.js

fluent-bundle/.npmignore

@@ -1,5 +1,7 @@
 .nyc_output
 coverage
-docs
+esm/.compiled
+src
 test
 makefile
+tsconfig.json

fluent-bundle/eslint_src.json

@@ -0,0 +1,26 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 9,
+        "sourceType": "module",
+        "project": "./tsconfig.json"
+    },
+    "env": {
+        "es6": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "../eslint_src.json"
+    ],
+    "rules": {
+        "prefer-const": "off",
+        "no-unused-vars": ["error", {"args": "none"}],
+        "@typescript-eslint/no-inferrable-types": "off",
+        "@typescript-eslint/no-unused-vars": ["error", {"args": "none"}],
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/explicit-function-return-type": "error"
+    }
+}

fluent-bundle/makefile

@@ -3,34 +3,57 @@ GLOBAL  := FluentBundle
 
 include ../common.mk
 
-build: index.js compat.js
+lint:
+	@eslint --config ./eslint_src.json --max-warnings 0 src/*.ts
+	@eslint --config $(ROOT)/eslint_test.json --max-warnings 0 test/
+	@echo -e " $(OK) lint"
 
-test:
-	@nyc --reporter=text --reporter=html mocha \
-	    --recursive --ui tdd \
-	    --require esm \
-	    --require ./test/index \
-	    test/**/*_test.js
+compile: esm/.compiled
+
+esm/.compiled: $(SOURCES)
+	@tsc
+	@touch $@
+	@echo -e " $(OK) esm/ compiled"
+
+build: index.js compat.js
 
-index.js: $(SOURCES)
-	@rollup $(CURDIR)/src/index.js \
+index.js: esm/.compiled
+	@rollup $(CURDIR)/esm/index.js \
 	    --config $(ROOT)/bundle_config.js \
 	    --banner "/* $(PACKAGE)@$(VERSION) */" \
 	    --amd.id $(PACKAGE) \
 	    --name $(GLOBAL) \
 	    --output.file $@
 	@echo -e " $(OK) $@ built"
 
-compat.js: $(SOURCES)
-	@rollup $(CURDIR)/src/index.js \
+compat.js: esm/.compiled
+	@rollup $(CURDIR)/esm/index.js \
 	    --config $(ROOT)/compat_config.js \
 	    --banner "/* $(PACKAGE)@$(VERSION) */" \
 	    --amd.id $(PACKAGE) \
 	    --name $(GLOBAL) \
 	    --output.file $@
 	@echo -e " $(OK) $@ built"
 
+.PHONY: test
+test: esm/.compiled
+	@nyc --reporter=text --reporter=html mocha \
+	    --recursive --ui tdd \
+	    --require esm \
+	    test/**/*_test.js
+
+html:
+	@typedoc src \
+	    --out ../html/bundle \
+	    --mode file \
+	    --excludeNotExported \
+	    --excludePrivate \
+	    --logger none \
+	    --hideGenerator
+	@echo -e " $(OK) html build"
+
 clean:
+	@rm -f esm/*.js esm/*.d.ts esm/.compiled
 	@rm -f index.js compat.js
 	@rm -rf .nyc_output coverage
 	@echo -e " $(OK) clean"

fluent-bundle/package.json

@@ -15,11 +15,10 @@
       "email": "stas@mozilla.com"
     }
   ],
-  "directories": {
-    "lib": "./src"
-  },
+  "type": "commonjs",
   "main": "./index.js",
-  "module": "./src/index.js",
+  "module": "./esm/index.js",
+  "types": "./esm/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/projectfluent/fluent.js.git"

fluent-bundle/src/ast.ts

@@ -0,0 +1,80 @@
+export type Message = {
+  id: string;
+  value: Pattern | null;
+  attributes: Record<string, Pattern>;
+};
+
+export type Term = {
+  id: string;
+  value: Pattern;
+  attributes: Record<string, Pattern>;
+};
+
+export type Pattern = string | ComplexPattern;
+
+export type ComplexPattern = Array<PatternElement>;
+
+export type PatternElement = string | Expression;
+
+export type Expression =
+  | SelectExpression
+  | VariableReference
+  | TermReference
+  | MessageReference
+  | FunctionReference
+  | Literal;
+
+export type SelectExpression = {
+  type: "select";
+  selector: Expression;
+  variants: Array<Variant>;
+  star: number;
+};
+
+export type VariableReference = {
+  type: "var";
+  name: string;
+};
+
+export type TermReference = {
+  type: "term";
+  name: string;
+  attr: string | null;
+  args: Array<Expression | NamedArgument>;
+};
+
+export type MessageReference = {
+  type: "mesg";
+  name: string;
+  attr: string | null;
+};
+
+export type FunctionReference = {
+  type: "func";
+  name: string;
+  args: Array<Expression | NamedArgument>;
+};
+
+export type Variant = {
+  key: Literal;
+  value: Pattern;
+};
+
+export type NamedArgument = {
+  type: "narg";
+  name: string;
+  value: Literal;
+};
+
+export type Literal = StringLiteral | NumberLiteral;
+
+export type StringLiteral = {
+  type: "str";
+  value: string;
+};
+
+export type NumberLiteral = {
+  type: "num";
+  value: number;
+  precision: number;
+};

fluent-bundle/src/builtins.ts

@@ -0,0 +1,61 @@
+/**
+ * @overview
+ *
+ * The FTL resolver ships with a number of functions built-in.
+ *
+ * Each function take two arguments:
+ *   - args - an array of positional args
+ *   - opts - an object of key-value args
+ *
+ * Arguments to functions are guaranteed to already be instances of
+ * `FluentValue`.  Functions must return `FluentValues` as well.
+ */
+
+import {
+  FluentValue,
+  FluentNone,
+  FluentNumber,
+  FluentDateTime
+} from "./types.js";
+
+function values(opts: Record<string, FluentValue>): Record<string, unknown> {
+  const unwrapped: Record<string, unknown> = {};
+  for (const [name, opt] of Object.entries(opts)) {
+    unwrapped[name] = opt.valueOf();
+  }
+  return unwrapped;
+}
+
+export function NUMBER(
+  args: Array<FluentValue>,
+  opts: Record<string, FluentValue>
+): FluentValue {
+  let arg = args[0];
+
+  if (arg instanceof FluentNone) {
+    return new FluentNone(`NUMBER(${arg.valueOf()})`);
+  }
+
+  if (arg instanceof FluentNumber || arg instanceof FluentDateTime) {
+    return new FluentNumber(arg.valueOf(), { ...arg.opts, ...values(opts) });
+  }
+
+  throw new TypeError("Invalid argument to NUMBER");
+}
+
+export function DATETIME(
+  args: Array<FluentValue>,
+  opts: Record<string, FluentValue>
+): FluentValue {
+  let arg = args[0];
+
+  if (arg instanceof FluentNone) {
+    return new FluentNone(`DATETIME(${arg.valueOf()})`);
+  }
+
+  if (arg instanceof FluentNumber || arg instanceof FluentDateTime) {
+    return new FluentDateTime(arg.valueOf(), { ...arg.opts, ...values(opts) });
+  }
+
+  throw new TypeError("Invalid argument to DATETIME");
+}