Release Version 5.0.0

.github/actions/install-node-dependencies/action.yml

@@ -10,7 +10,7 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       env:
         cache-name: node_modules-cache
       with:

.github/workflows/required-checks.yml

@@ -1,23 +1,23 @@
 name: "Required Checks"
 
-on:
-  pull_request:
-    branches:
-      - master
+on: pull_request
 
 jobs:
   jest-tests:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     timeout-minutes: 5
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
       - name: Use Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 20
+
       - uses: ./.github/actions/install-node-dependencies
+
       - name: Jest Tests
         run: |
           npx jest --ci --silent --maxWorkers=1

README.md

@@ -1,18 +1,21 @@
 # Ditto CLI
 
-The Ditto CLI enables developers to access the Ditto API directly from the command line.
+The Ditto CLI enables developers to access the Ditto API directly from the command line. You can use the CLI to import Ditto data directly into your own codebase.
+
+The CLI is configured to fetch text from the latest version of Ditto by default. However, all legacy features are still fully supported by passing a `--legacy` flag along with the legacy CLI command. See [Legacy Setup](#legacy-setup) for details on using the CLI with older Ditto projects and components.
 
 [![NPM version](https://badge.fury.io/js/@dittowords%2Fcli.svg)](https://badge.fury.io/js/@dittowords%2Fcli)
 
 ## Documentation
 
-The official documentation can be found [here](http://developer.dittowords.com/cli-reference/authentication).
+- [Documentation](https://developer.dittowords.com/cli-reference/authentication)
+- [Changelog](https://developer.dittowords.com/feedback-support/changelog)
 
 ## Support
 
 - [Bug Reports](https://github.com/dittowords/cli/issues/)
 - [Support Chat](https://www.dittowords.com)
-- [What is Ditto?](https://www.dittowords.com/docs/what-is-ditto)
+- [What is Ditto?](https://developer.dittowords.com/introduction)
 
 ## Installation
 
@@ -24,7 +27,7 @@ It's recommended to install the CLI as a development dependency to ensure your w
 
 ## Authentication
 
-The first time you run the CLI, you’ll be asked to provide an API key. You can generate an API key from your [developer integrations settings](https://app.dittowords.com/account/devtools).
+The first time you run the CLI, you’ll be asked to provide an API key. You can generate an API key from your [developer integrations settings](https://app.dittowords.com/developers/api-keys).
 
 See the [Authentication](http://developer.dittowords.com/api-reference/authentication) page for more information on API keys.
 
@@ -37,32 +40,40 @@ The first time you run the CLI, a `ditto/` folder will be created if it doesn't
 The default file looks like this:
 
 ```yml
-sources:
-  components: true
-variants: true
-format: flat
+projects: [],
+components: {
+  folders: []
+},
+variants: [],
+outputs:
+  - format: json,
+    framework: i18next
 ```
 
-For more information on configuring the CLI, see [http://developer.dittowords.com/cli-reference/configuration](http://developer.dittowords.com/cli-reference/configuration).
+For more information on configuring the CLI, see [this documentation section](https://developer.dittowords.com/cli-reference/configuration).
 
 ## Usage
 
 ```bash
-npx @dittowords/cli
+npx @dittowords/cli pull
 ```
 
 Run the CLI to pull string data from Ditto and write it to disk.
 
-String files are written to the `ditto` folder in a format that corresponds to your configuration. After integrating these files into development, you can execute the CLI at any time to fetch the latest strings from Ditto and update them in your application.
+String files are written to the specified folder in a format that corresponds to your configuration. After integrating these files into development, you can execute the CLI at any time to fetch the latest strings from Ditto and update them in your application.
 
-For more information on how files written to disk, see [http://developer.dittowords.com/cli-reference/files](http://developer.dittowords.com/cli-reference/files).
+For more information on how files are written to disk, see [this documentation section](https://developer.dittowords.com/cli-reference/files).
 
 See our demo projects for examples of how to integrate the Ditto CLI in different environments:
 
 - [React web app](https://github.com/dittowords/ditto-react-demo)
 - [iOS mobile app](https://github.com/dittowords/ditto-react-demo)
 - [Android mobile app](https://github.com/dittowords/ditto-react-demo)
 
+## Legacy Setup
+
+Beginning with `v5.0.0`, the Ditto CLI points at the new Ditto experience by default. To run the CLI compatible with legacy Ditto, append the `--legacy` flag to any legacy command, and the CLI will work as it did in the `4.x` version. All existing legacy commands remain fully functional at this time.
+
 ## Feedback
 
 Have feedback? We’d love to hear it! Message us at [[email protected]](mailto:[email protected]).

esbuild.mjs

@@ -0,0 +1,49 @@
+import * as esbuild from "esbuild";
+
+let define = {};
+const KEYS_TO_DEFINE = [
+  "ENV",
+  "SENTRY_DSN",
+  "SENTRY_ORG",
+  "SENTRY_PROJECT",
+  "SENTRY_DSN",
+];
+
+if (process.env.ENV === "production") {
+  for (const k of KEYS_TO_DEFINE) {
+    define[`process.env.${k}`] = JSON.stringify(process.env[k]);
+  }
+}
+
+/**
+ * @type {esbuild.BuildOptions}
+ */
+const config = {
+  entryPoints: ["lib/ditto.ts"],
+  bundle: true,
+  metafile: true,
+  keepNames: true,
+  tsconfig: "tsconfig.json",
+  sourcemap: process.env.ENV === "production" ? "external" : "both",
+  minify: process.env.ENV === "production",
+  outdir: "bin",
+  target: "es2020",
+  packages: "external",
+  platform: "node",
+  define,
+};
+
+async function main() {
+  const result = await esbuild.build(config);
+  // Output build metafile so we can analyze the bundle
+  // size over time and check if anything unexpected is being bundled in.
+  if (process.env.ENV === "production") {
+    console.log(
+      await esbuild.analyzeMetafile(result.metafile, {
+        verbose: true,
+      })
+    );
+  }
+}
+
+main();

jest.config.ts

@@ -11,6 +11,7 @@ const config: Config = {
   ],
   watchPathIgnorePatterns: ["<rootDir>/.testing/", "<rootDir>/testing/"],
   collectCoverageFrom: ["lib/**/*.{js,jsx,ts,tsx}"],
+  restoreMocks: true,
 };
 
 export default config;