⬆️ Upgrade to oclif v2

packages/cli/bin/dev

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+require("dotenv-flow").config();
+
+const oclif = require("@oclif/core");
+
+const path = require("path");
+const project = path.join(__dirname, "..", "tsconfig.json");
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = "development";
+
+require("ts-node").register({ project });
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle);

packages/cli/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

packages/cli/bin/run

@@ -2,7 +2,9 @@
 
 require("dotenv-flow").config();
 
-require("@oclif/command")
+const oclif = require("@oclif/core");
+
+oclif
   .run()
-  .then(require("@oclif/command/flush"))
-  .catch(require("@oclif/errors/handle"));
+  .then(require("@oclif/core/flush"))
+  .catch(require("@oclif/core/handle"));

packages/cli/package.json

@@ -12,11 +12,9 @@
   "bugs": "https://github.com/AckeeCZ/lokse/issues",
   "dependencies": {
     "@lokse/core": "^2.1.4",
-    "@oclif/command": "^1",
-    "@oclif/config": "^1",
     "@oclif/core": "^1.9.2",
     "@oclif/errors": "^1.3.4",
-    "@oclif/plugin-help": "^3",
+    "@oclif/plugin-help": "^5",
     "@oclif/plugin-version": "^1.1.0",
     "@sindresorhus/slugify": "^1.1.0",
     "@types/array.prototype.flat": "^1.2.1",
@@ -35,8 +33,8 @@
     "update-notifier": "^5.1.0"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1",
-    "@oclif/test": "^1",
+    "oclif": "^2",
+    "@oclif/test": "^2",
     "@types/jest-when": "^2.7.2",
     "@types/node": "^12",
     "jest-when": "^3.0.1"
@@ -52,7 +50,9 @@
   ],
   "homepage": "https://github.com/AckeeCZ/lokse",
   "keywords": [
-    "oclif"
+    "cli",
+    "localization",
+    "spreadsheet"
   ],
   "license": "MIT",
   "main": "lib/index.js",

packages/cli/src/base.ts

@@ -1,4 +1,4 @@
-import { Command } from "@oclif/command";
+import { Command } from "@oclif/core";
 import * as updateNotifier from "update-notifier";
 
 import { getConfig } from "@lokse/core";
@@ -17,6 +17,6 @@ export default abstract class Base extends Command {
     });
     notifier.notify();
 
-    this.conf = getConfig();
+    this.conf = await getConfig();
   }
 }

packages/cli/src/commands/__tests__/init.test.ts

@@ -1,5 +1,5 @@
 import { test as oclifTest } from "@oclif/test";
-import { cosmiconfigSync } from "cosmiconfig";
+import { cosmiconfig } from "cosmiconfig";
 import * as dedent from "dedent";
 import { prompt } from "inquirer";
 import logger from "../../logger";
@@ -8,7 +8,7 @@ jest.mock("cosmiconfig");
 const explorerMock = {
   search: jest.fn(),
 };
-(cosmiconfigSync as jest.Mock).mockReturnValue(explorerMock);
+(cosmiconfig as jest.Mock).mockReturnValue(explorerMock);
 
 const writeFileAsyncMock = jest.fn();
 
@@ -38,7 +38,7 @@ describe("init command", () => {
     .stdout()
     .setupMocks()
     .do(() => {
-      explorerMock.search.mockReturnValue({
+      explorerMock.search.mockResolvedValue({
         config: { splitTranslations: true },
       });
     })
@@ -55,7 +55,7 @@ describe("init command", () => {
   test
     .setupMocks()
     .do(() => {
-      explorerMock.search.mockReturnValue(null);
+      explorerMock.search.mockResolvedValue(null);
       promptMock
         .mockReturnValueOnce({ type: "typescript" })
         .mockReturnValueOnce({
@@ -93,7 +93,7 @@ describe("init command", () => {
   test
     .setupMocks()
     .do(() => {
-      explorerMock.search.mockReturnValue(null);
+      explorerMock.search.mockResolvedValue(null);
       promptMock
         .mockReturnValueOnce({ type: "javascript" })
         .mockReturnValueOnce({
@@ -132,7 +132,7 @@ describe("init command", () => {
   test
     .setupMocks()
     .do(() => {
-      explorerMock.search.mockReturnValue(null);
+      explorerMock.search.mockResolvedValue(null);
       promptMock.mockReturnValueOnce({ type: "rc file" }).mockReturnValueOnce({
         sheetId: "",
         outDir: "",
@@ -161,7 +161,7 @@ describe("init command", () => {
   test
     .setupMocks()
     .do(() => {
-      explorerMock.search.mockReturnValue(null);
+      explorerMock.search.mockResolvedValue(null);
       promptMock
         .mockReturnValueOnce({ type: "typescript" })
         .mockReturnValueOnce({

packages/cli/src/commands/__tests__/update.test.ts

@@ -1,5 +1,5 @@
 import { test as oclifTest } from "@oclif/test";
-import { cosmiconfigSync } from "cosmiconfig";
+import { cosmiconfig } from "cosmiconfig";
 import * as dedent from "dedent";
 import { when } from "jest-when";
 
@@ -21,7 +21,7 @@ jest.mock("cosmiconfig", () => {
   };
 
   return {
-    cosmiconfigSync: jest.fn().mockReturnValue(mockExplorer),
+    cosmiconfig: jest.fn().mockReturnValue(mockExplorer),
   };
 });
 
@@ -66,7 +66,7 @@ WorksheetReaderMock.mockReturnValue({
 const outputFormats = Object.values(OutputFormat).join(", ");
 
 describe("update command", () => {
-  const searchMock = cosmiconfigSync("foo").search as jest.Mock;
+  const searchMock = cosmiconfig("foo").search as jest.Mock;
 
   let consoleErrorBackup: typeof console.error;
   const fakeSpreadsheetId = "fake-spreadsheet-id";
@@ -154,7 +154,7 @@ describe("update command", () => {
 
   test
     .do(() =>
-      searchMock.mockReturnValue({
+      searchMock.mockResolvedValue({
         config: { languages: "cs,en" },
       })
     )
@@ -219,7 +219,7 @@ describe("update command", () => {
     test
       .setupMocks()
       .do(() => {
-        searchMock.mockReturnValue({ config: { sheets: true } });
+        searchMock.mockResolvedValue({ config: { sheets: true } });
 
         WorksheetReaderMock.mockImplementationOnce(() => {
           throw new InvalidFilterError(true);
@@ -237,7 +237,7 @@ describe("update command", () => {
     test
       .setupMocks()
       .do(() =>
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { sheets: "Secondary translations" },
         })
       )
@@ -253,7 +253,7 @@ describe("update command", () => {
     test
       .setupMocks()
       .do(() =>
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { sheets: ["Main translations", "Secondary translations"] },
         })
       )
@@ -270,7 +270,7 @@ describe("update command", () => {
     test
       .setupMocks()
       .do(() =>
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: {
             sheets: {
               include: ["Main translations", "Other translations"],
@@ -290,7 +290,7 @@ describe("update command", () => {
     test
       .setupMocks()
       .do(() =>
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: {
             sheets: {
               exclude: ["Main translations", "Other translations"],
@@ -309,7 +309,7 @@ describe("update command", () => {
     test
       .setupMocks()
       .do(() =>
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: {
             sheets: {
               include: "Main translations",
@@ -494,7 +494,7 @@ describe("update command", () => {
       .setupMocks()
       .do(() => {
         mockRead.mockReturnValue(threeSheets);
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { splitTranslations: true },
         });
         mockWrite
@@ -559,7 +559,7 @@ describe("update command", () => {
       .stub(process, "cwd", jest.fn().mockReturnValue("/ROOT_PKG_PATH"))
       .do(() => {
         mockRead.mockReturnValue(threeSheets);
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { splitTranslations: true },
         });
       })
@@ -625,7 +625,7 @@ describe("update command", () => {
       .setupMocks()
       .do(() => {
         mockRead.mockReturnValue({ "Sheet 1": mockSheetLines });
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { splitTranslations: true },
         });
       })
@@ -664,7 +664,7 @@ describe("update command", () => {
       .setupMocks()
       .do(() => {
         mockRead.mockReturnValue(threeSheets);
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { splitTranslations: ["sheet1", "sheet3"] },
         });
       })
@@ -778,7 +778,7 @@ describe("update command", () => {
             throw new Error(`Write error 2`);
           });
 
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { splitTranslations: true },
         });
       })
@@ -861,7 +861,7 @@ describe("update command", () => {
           "sheet1 Title": mockSheetLines,
           "sheet2 Title": mockSheetLines2,
         });
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { splitTranslations: ["sheet1", "sheet2"] },
         });
       })
@@ -932,7 +932,7 @@ describe("update command", () => {
           "sheet1 Title": [{ key: "sheet.1.line" }, { key: "sheet.1.line" }],
           "sheet2 Title": [{ key: "sheet.2.line" }, { key: "sheet.2.line" }],
         });
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { splitTranslations: ["sheet.1", "sheet.2"] },
         });
       })
@@ -983,7 +983,7 @@ describe("update command", () => {
             { key: "sheet12.line" },
           ],
         });
-        searchMock.mockReturnValue({
+        searchMock.mockResolvedValue({
           config: { splitTranslations: ["sheet1", "sheet12"] },
         });
       })

packages/cli/src/commands/init.ts

@@ -1,4 +1,4 @@
-import { flags } from "@oclif/command";
+import { Flags } from "@oclif/core";
 import { promisifyAll } from "bluebird";
 import { template } from "lodash";
 import * as path from "path";
@@ -22,7 +22,7 @@ class Init extends Base {
   static examples = [`$ ${NAME} init`];
 
   static flags = {
-    help: flags.help({ char: "h" }),
+    help: Flags.help({ char: "h" }),
   };
 
   async run(): Promise<void> {

packages/cli/src/commands/open.ts

@@ -1,4 +1,4 @@
-import { flags } from "@oclif/command";
+import { Flags } from "@oclif/core";
 import * as open from "open";
 
 import { NAME, createSheetUrl } from "@lokse/core";
@@ -13,12 +13,12 @@ class Open extends Base {
   ];
 
   static flags = {
-    help: flags.help({ char: "h" }),
+    help: Flags.help({ char: "h" }),
     id: idFlag.flag(),
   };
 
   async run(): Promise<void> {
-    const { flags } = this.parse(Open);
+    const { flags } = await this.parse(Open);
 
     const sheetId = flags.id;