Merge pull request #450 from stasm/ts-sequence

Migrate @fluent/sequence to TypeScript

Author: stasm

fluent-bundle/eslint_src.json renamed to eslint_ts.json

@@ -13,7 +13,7 @@
         "plugin:@typescript-eslint/eslint-recommended",
         "plugin:@typescript-eslint/recommended",
         "plugin:@typescript-eslint/recommended-requiring-type-checking",
-        "../eslint_src.json"
+        "./eslint_src.json"
     ],
     "rules": {
         "prefer-const": "off",

fluent-bundle/.gitignore

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

fluent-bundle/makefile

@@ -4,7 +4,7 @@ GLOBAL  := FluentBundle
 include ../common.mk
 
 lint:
-	@eslint --config ./eslint_src.json --max-warnings 0 src/*.ts
+	@eslint --config $(ROOT)/eslint_ts.json --max-warnings 0 src/*.ts
 	@eslint --config $(ROOT)/eslint_test.json --max-warnings 0 test/
 	@echo -e " $(OK) lint"
 
@@ -16,6 +16,13 @@ esm/.compiled: $(SOURCES)
 	@touch $@
 	@echo -e " $(OK) esm/ compiled"
 
+.PHONY: test
+test: esm/.compiled
+	@nyc --reporter=text --reporter=html mocha \
+	    --recursive --ui tdd \
+	    --require esm \
+	    test/**/*_test.js
+
 build: index.js compat.js
 
 index.js: esm/.compiled
@@ -36,13 +43,6 @@ compat.js: esm/.compiled
 	    --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 \

fluent-sequence/.esdoc.json

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

fluent-sequence/.gitignore

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

fluent-sequence/.npmignore

@@ -3,7 +3,21 @@ GLOBAL  := FluentSequence
 
 include ../common.mk
 
-test:
+lint:
+	@eslint --config $(ROOT)/eslint_ts.json --max-warnings 0 src/*.ts
+	@eslint --config $(ROOT)/eslint_test.json --max-warnings 0 test/
+	@echo -e " $(OK) lint"
+
+.PHONY: compile
+compile: esm/.compiled
+
+esm/.compiled: $(SOURCES)
+	@tsc
+	@touch $@
+	@echo -e " $(OK) esm/ compiled"
+
+.PHONY: test
+test: esm/.compiled
 	@nyc --reporter=text --reporter=html mocha \
 	    --recursive --ui tdd \
 	    --require esm \
@@ -12,7 +26,7 @@ test:
 build: index.js compat.js
 
 index.js: $(SOURCES)
-	@rollup $(CURDIR)/src/index.js \
+	@rollup $(CURDIR)/esm/index.js \
 	    --config $(ROOT)/bundle_config.js \
 	    --banner "/* $(PACKAGE)@$(VERSION) */" \
 	    --amd.id $(PACKAGE) \
@@ -21,14 +35,26 @@ index.js: $(SOURCES)
 	@echo -e " $(OK) $@ built"
 
 compat.js: $(SOURCES)
-	@rollup $(CURDIR)/src/index.js \
+	@rollup $(CURDIR)/esm/index.js \
 	    --config $(ROOT)/compat_config.js \
 	    --banner "/* $(PACKAGE)@$(VERSION) */" \
 	    --amd.id $(PACKAGE) \
 	    --name $(GLOBAL) \
 	    --output.file $@
 	@echo -e " $(OK) $@ built"
 
-lint: _lint
-html: _html
-clean: _clean
+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-sequence/makefile

@@ -15,11 +15,10 @@
       "email": "[email protected]"
     }
   ],
-  "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"
@@ -32,6 +31,7 @@
     "node": ">=10.0.0"
   },
   "devDependencies": {
+    "@fluent/bundle": ">= 0.15.0",
     "cached-iterable": "^0.2.1"
   },
   "peerDependencies": {

fluent-sequence/package.json

@@ -0,0 +1,7 @@
+/*
+ * @module fluent-sequence
+ * @overview Manage ordered sequences of FluentBundles.
+ */
+
+export { mapBundleSync } from "./map_sync.js";
+export { mapBundleAsync } from "./map_async.js";

fluent-sequence/src/index.js

@@ -0,0 +1,52 @@
+import { FluentBundle } from "@fluent/bundle";
+
+export function mapBundleAsync(
+  bundles: AsyncIterable<FluentBundle>,
+  ids: string
+): Promise<FluentBundle | null>
+
+export function mapBundleAsync(
+  bundles: AsyncIterable<FluentBundle>,
+  ids: Array<string>
+): Promise<Array<FluentBundle | null>>;
+
+/*
+ * Asynchronously map an identifier or an array of identifiers to the best
+ * `FluentBundle` instance(s).
+ *
+ * @param bundles - An iterable of bundles to sift through.
+ * @param ids - An id or ids to map.
+ */
+export async function mapBundleAsync(
+  bundles: AsyncIterable<FluentBundle>,
+  ids: string | Array<string>
+): Promise<FluentBundle | null | Array<FluentBundle | null>> {
+  if (!Array.isArray(ids)) {
+    for await (const bundle of bundles) {
+      if (bundle.hasMessage(ids)) {
+        return bundle;
+      }
+    }
+
+    return null;
+  }
+
+  const foundBundles = new Array(ids.length).fill(null);
+  let remainingCount = ids.length;
+
+  for await (const bundle of bundles) {
+    for (const [index, id] of ids.entries()) {
+      if (!foundBundles[index] && bundle.hasMessage(id)) {
+        foundBundles[index] = bundle;
+        remainingCount--;
+      }
+
+      // Return early when all ids have been mapped to bundles.
+      if (remainingCount === 0) {
+        return foundBundles;
+      }
+    }
+  }
+
+  return foundBundles;
+}

fluent-sequence/src/index.ts

@@ -0,0 +1,47 @@
+import { FluentBundle } from "@fluent/bundle";
+
+export function mapBundleSync(
+  bundles: Iterable<FluentBundle>,
+  ids: string
+): FluentBundle | null;
+
+export function mapBundleSync(
+  bundles: Iterable<FluentBundle>,
+  ids: Array<string>
+): Array<FluentBundle | null>;
+
+/*
+ * Synchronously map an identifier or an array of identifiers to the best
+ * `FluentBundle` instance(s).
+ *
+ * @param bundles - An iterable of bundles to sift through.
+ * @param ids - An id or ids to map.
+ */
+export function mapBundleSync(
+  bundles: Iterable<FluentBundle>,
+  ids: string | Array<string>
+): FluentBundle | null | Array<FluentBundle | null> {
+  if (!Array.isArray(ids)) {
+    return getBundleForId(bundles, ids);
+  }
+
+  return ids.map(
+    id => getBundleForId(bundles, id)
+  );
+}
+
+/*
+ * Find the best `FluentBundle` with the translation for `id`.
+ */
+function getBundleForId(
+  bundles: Iterable<FluentBundle>,
+  id: string
+): NonNullable<FluentBundle> | null {
+  for (const bundle of bundles) {
+    if (bundle.hasMessage(id)) {
+      return bundle;
+    }
+  }
+
+  return null;
+}