Merge pull request #409 from ibi-group/fix-scripts-package

Fix scripts package

Author: binh-dam-ibigroup

Diff for: package.json

@@ -92,7 +92,7 @@
     "bootstrap": "lerna bootstrap --use-workspaces",
     "build:cjs": "lerna exec --parallel -- babel --extensions '.js,.ts,.tsx' --ignore **/*.story.js,**/*.story.ts,**/*.story.d.ts,**/*.story.tsx,**/*.spec.js,**/*.spec.ts,**/*.test.js,**/*.test.ts,**/__tests__/**,**/__unpublished__/** --root-mode upward --source-maps true src -d lib",
     "build:esm": "lerna exec --parallel -- cross-env BABEL_ENV=esm babel --extensions '.js,.ts,.tsx' --ignore **/*.story.js,**/*.story.ts,**/*.story.d.ts,**/*.story.tsx,**/*.spec.js,**/*.spec.ts,**/*.test.js,**/*.test.ts,**/__tests__/**,**/__unpublished__/** --root-mode upward --source-maps true src -d esm",
-    "check:i18n": "node packages/scripts/lib/validate-i18n.js packages/**/src packages/**/i18n",
+    "check:i18n": "node packages/scripts/lib/run-validate-i18n.js packages/**/src packages/**/i18n",
     "prepublish": "yarn typescript && yarn build:cjs && yarn build:esm",
     "check-eslint-config": "eslint --print-config jestconfig.js | eslint-config-prettier-check",
     "coverage": "jest --coverage",

Diff for: packages/scripts/package.json

@@ -18,9 +18,9 @@
     "js-yaml": "^4.1.0"
   },
   "scripts": {
-    "collect-i18n": "node lib/collect-i18n-messages.js ../**/src ../**/i18n/en-US.yml > i18n.csv",
+    "collect-i18n": "node lib/run-collect-i18n-messages.js ../**/src ../**/i18n/en-US.yml > i18n.csv",
     "tsc": "tsc",
-    "validate-i18n": "node lib/validate-i18n.js ../**/src ../**/i18n"
+    "validate-i18n": "node lib/run-validate-i18n.js ../**/src ../**/i18n"
   },
   "bugs": {
     "url": "https://github.com/opentripplanner/otp-ui/issues"

Diff for: packages/scripts/src/collect-i18n-messages.ts

@@ -1,14 +1,4 @@
 /* eslint-disable no-console */
-/**
- * This script collects message ids gathered by the formatjs extract command in the specified files and folder(s)
- * and creates a CSV file with the id, description, and messages in the selected language(s).
- * This script is shipped as part of a package so it can be used in other code bases as needed.
- */
-// Example usage for all packages and all languages in this repo:
-//   node path-to/lib/collect-i18n-messages.js ../**/src ../**/i18n
-// Example usage for all packages and one language in this repo:
-//   node path-to-lib/collect-i18n-messages.js ../**/src ../**/i18n/en-US.yml
-
 import { extract } from "@formatjs/cli";
 import flatten from "flat";
 
@@ -74,4 +64,11 @@ async function collectAndPrintOutMessages({ sourceFiles, ymlFilesByLocale }) {
   });
 }
 
-sortSourceAndYmlFiles(process.argv).then(collectAndPrintOutMessages);
+/**
+ * This script collects message ids gathered by the formatjs extract command in the specified files and folder(s)
+ * and creates a CSV file with the id, description, and messages in the selected language(s).
+ * This script is shipped as part of a package so it can be used in other code bases as needed.
+ */
+export default function run(): Promise<void> {
+  return sortSourceAndYmlFiles(process.argv).then(collectAndPrintOutMessages);
+}

Diff for: packages/scripts/src/index.ts

@@ -0,0 +1,7 @@
+import collectI18nMessages from "./collect-i18n-messages";
+import validateI18n from "./validate-i18n";
+
+export default {
+  collectI18nMessages,
+  validateI18n
+};

Diff for: packages/scripts/src/run-collect-i18n-messages.ts

@@ -0,0 +1,12 @@
+/**
+ * This script collects message ids gathered by the formatjs extract command in the specified files and folder(s)
+ * and creates a CSV file with the id, description, and messages in the selected language(s).
+ */
+// Example usage for all packages and all languages in this repo:
+//   node path-to/lib/run-collect-i18n-messages.js ../**/src ../**/i18n
+// Example usage for all packages and one language in this repo:
+//   node path-to-lib/run-collect-i18n-messages.js ../**/src ../**/i18n/en-US.yml
+
+import collectI18nMessages from "./collect-i18n-messages";
+
+collectI18nMessages();

Diff for: packages/scripts/src/run-validate-i18n.ts

@@ -0,0 +1,11 @@
+/**
+ * Checks that message ids gathered by the formatjs extract command are present in the specified folder(s).
+ */
+// Example usage for one package in this repo:
+//   node path-to/lib/run-validate-i18n.js ../trip-details/src ../trip-details/i18n
+// Example usage for all packages in this repo:
+//   node path-to/lib/run-validate-i18n.js ../**/src ../**/i18n
+
+import validateI18n from "./validate-i18n";
+
+validateI18n();

Diff for: packages/scripts/src/validate-i18n.ts

@@ -1,24 +1,8 @@
 /* eslint-disable no-console */
-/**
- * This script checks that message ids gathered by the formatjs extract command
- * are present in the specified folder(s).
- * It will produce an error code if message ids are present in a language but not another,
- * or if message ids are in a i18n yml files but not in the code or vice-versa.
- * This script is shipped as part of a package so it can be used in other code bases as needed.
- */
-// Example usage for one package in this repo:
-//   node path-to/lib/validate-i18n.js ../trip-details/src ../trip-details/i18n
-// Example usage for all packages in this repo:
-//   node path-to/lib/validate-i18n.js ../**/src ../**/i18n
-
-const { extract } = require("@formatjs/cli");
-const flatten = require("flat");
+import flatten from "flat";
+import { extract } from "@formatjs/cli";
 
-const {
-  isNotSpecialId,
-  loadYamlFile,
-  sortSourceAndYmlFiles
-} = require("./util");
+import { isNotSpecialId, loadYamlFile, sortSourceAndYmlFiles } from "./util";
 
 /**
  * Checks message ids completeness between code and yml files for all locales in repo.
@@ -83,4 +67,12 @@ async function checkI18n({ sourceFiles, ymlFilesByLocale }) {
   }
 }
 
-sortSourceAndYmlFiles(process.argv).then(checkI18n);
+/**
+ * Checks that message ids gathered by the formatjs extract command are present in the specified folder(s).
+ * Produces a process error if message ids are present in a language but not another,
+ * or if message ids are found in i18n yml files but not in the code or vice-versa.
+ * This script is shipped as part of a package so it can be used in other code bases as needed.
+ */
+export default function run(): Promise<void> {
+  return sortSourceAndYmlFiles(process.argv).then(checkI18n);
+}