(@fluent/dedent) Migrate to TypeScript

Author: stasm

fluent-dedent/.esdoc.json

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

fluent-dedent/.gitignore

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

fluent-dedent/.npmignore

@@ -3,16 +3,30 @@ GLOBAL  := FluentDedent
 
 include ../common.mk
 
-build: index.js compat.js
+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"
 
-test:
+.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: $(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-dedent/makefile

@@ -11,11 +11,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"

fluent-dedent/package.json

@@ -9,24 +9,28 @@ const RE_BLANK = /^[ \t]*$/;
  * line and it must end on a line of its own, with the closing delimiter on a
  * next line.
  *
- * @param {Array<string>} strings
- * @param {...any} values
- * @returns string
+ * @param strings
+ * @param values
  */
-export default function ftl(strings, ...values) {
+export default function ftl(
+  strings: TemplateStringsArray,
+  ...values: Array<unknown>
+): string {
   let code = strings.reduce((acc, cur) => acc + values.shift() + cur);
   let lines = code.split("\n");
-  let [first, commonIndent] = [lines.shift(), lines.pop()];
 
-  if (!RE_BLANK.test(first)) {
+  let first = lines.shift();
+  if (first === undefined || !RE_BLANK.test(first)) {
     throw new RangeError("Content must start on a new line.");
   }
-  if (!RE_BLANK.test(commonIndent)) {
+
+  let commonIndent = lines.pop();
+  if (commonIndent === undefined || !RE_BLANK.test(commonIndent)) {
     throw new RangeError("Closing delimiter must appear on a new line.");
   }
 
-  function dedent(line, idx) {
-    let lineIndent = line.slice(0, commonIndent.length);
+  function dedent(line: string, idx: number): string {
+    let lineIndent = line.slice(0, (commonIndent as string).length);
     if (lineIndent.length === 0) {
       // Empty blank lines are preserved even if technically they are not
       // indented at all. This also short-circuits the dedentation logic when

fluent-dedent/src/index.js renamed to fluent-dedent/src/index.ts

@@ -1,7 +1,7 @@
 "use strict";
 
 import assert from "assert";
-import ftl from "../src/index";
+import ftl from "../esm/index";
 
 suite("blank lines", function() {
   test("leading", function() {

fluent-dedent/test/blank_test.js

@@ -1,7 +1,7 @@
 "use strict";
 
 import assert from "assert";
-import ftl from "../src/index";
+import ftl from "../esm/index";
 
 suite("content lines", function() {
   test("no indent", function () {

fluent-dedent/test/content_test.js

@@ -1,7 +1,7 @@
 "use strict";
 
 import assert from "assert";
-import ftl from "../src/index";
+import ftl from "../esm/index";
 
 suite("EOL at extremes", function () {
   test("no EOLs", function () {

fluent-dedent/test/eol_test.js

@@ -1,7 +1,7 @@
 "use strict";
 
 import assert from "assert";
-import ftl from "../src/index";
+import ftl from "../esm/index";
 
 suite("interpolation", function() {
   test("single", function() {

fluent-dedent/test/interpolation_test.js

@@ -1,7 +1,7 @@
 "use strict";
 
 import assert from "assert";
-import ftl from "../src/index";
+import ftl from "../esm/index";
 
 suite("mixed indent", function() {
   test("same amount", function() {

fluent-dedent/test/mixed_test.js

@@ -1,7 +1,7 @@
 "use strict";
 
 import assert from "assert";
-import ftl from "../src/index";
+import ftl from "../esm/index";
 
 suite("tab indent", function() {
   test("same amount", function() {

fluent-dedent/test/tabs_test.js

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "target": "es2019",
+        "module": "es2015",
+        "strict": true,
+        "allowJs": false,
+        "esModuleInterop": true,
+        "moduleResolution": "node",
+        "noEmitHelpers": true,
+        "declaration": true,
+        "outDir": "./esm",
+    },
+    "include": [
+        "./src/**/*.ts"
+    ]
+}