@todesktop/cli 1.13.0 → 1.15.0

package/README.md

@@ -10,7 +10,7 @@ For more information, visit the project [landing page](https://www.todesktop.com
 - [Get started](#get-started)
 - [CLI commands](#cli-commands)
 - [Automating your builds (CI)](#automating-your-builds-ci)
-- [Project configuration (todesktop.json)](#project-configuration-todesktopjson)
+- [Project configuration (todesktop.json, todesktop.js, or todesktop.ts)](#project-configuration-todesktopjson-todesktopjs-or-todesktops)
 - [Build lifecycle hooks (package.json scripts)](#build-lifecycle-hooks-packagejson-scripts)
 - [App package.json requirements](#app-packagejson-requirements)
 - [FAQs](#faqs)
@@ -42,14 +42,46 @@ Create a `todesktop.json` file in the root of your Electron project.
 
 ```json
 {
-  "$schema": "https://unpkg.com/@todesktop/cli@1.13.0-0/schemas/schema.json",
+  "$schema": "https://unpkg.com/@todesktop/cli@1.14.0/schemas/schema.json",
   "schemaVersion": 1
   "id": "your-todesktop-id",
   "icon": "./desktop-icon.png",
+  "schemaVersion": 1
 }
 ```
 
-See [Project configuration](#project-configuration-todesktopjson) for the full list of configuration options.
+Alternatively, you can create a `todesktop.js` file. This allows you to use JavaScript to dynamically generate your configuration. For example:
+
+```javascript
+const path = require("path");
+
+module.exports = {
+  id: process.env.TODESKTOP_APP_ID || "your-default-todesktop-id",
+  icon: path.join(__dirname, "assets", "desktop-icon.png"),
+  schemaVersion: 1,
+};
+```
+
+You can also create a `todesktop.ts` file for TypeScript projects with full type checking and IntelliSense:
+
+```typescript
+import type { Schema } from "@todesktop/cli";
+import path from "path";
+
+const config: Schema = {
+  id: process.env.TODESKTOP_APP_ID || "your-default-todesktop-id",
+  icon: path.join(__dirname, "assets", "desktop-icon.png"),
+  schemaVersion: 1,
+  nodeVersion: "18.12.1",
+  mac: {
+    category: "public.app-category.productivity",
+  },
+};
+
+export default config;
+```
+
+See [Project configuration](#project-configuration-todesktopjson-todesktopjs-or-todesktops) for the full list of configuration options.
 
 ### Step 3: Add @todesktop/runtime as a dependency
 
@@ -135,27 +167,27 @@ This builds your Electron app with native installers, code signing, and so on ba
 We also support:
 
 - `todesktop build --code-sign=false`. Run a build with code-signing and notarization disabled. This is handy for testing builds quickly.
-- `todesktop build --config=<path.to.another.todesktop.json>`. Run a build with a different configuration file.
+- `todesktop build --config=<path.to.config.file>`. Run a build with a different configuration file (e.g., `todesktop.staging.json` or `todesktop.prod.js`).
 - `todesktop build --async`. Run a build in the background. This is handy for CI environments.
 - `todesktop build --webhook URL`. Send a POST request to the webhook URL when the build is finished. It's especially useful together with the `--async` flag.
-- `todesktop build --ignore-extends-errors`. Ignore `id` and `appId` validation errors when extending another todesktop.json file.
+- `todesktop build --ignore-extends-errors`. Ignore `id` and `appId` validation errors when extending another configuration file (`.json` or `.js`).
 - `todesktop release`. Release a build. This will publish a new download and an auto-update for existing users. By default it shows a list of builds for you to choose from.
   - Use `todesktop release <id>` to release a specific build by ID.
   - `todesktop release --latest` will release the latest build.
   - Append `--force` to skip the interactive confirmation step.
-  - Append `--config=<path.to.another.todesktop.json>` to use a different configuration file.
+  - Append `--config=<path.to.config.file>` to use a different configuration file.
 - `todesktop builds`. View your recent builds.
   - Use `todesktop builds <id>` to view a specific build and its progress.
   - `todesktop builds --latest` will show the latest build and it's progress.
   - `todesktop builds --count=<number>` will show the last `<number>` builds.
   - `todesktop builds --format=json` will output build data in JSON format.
-  - Append `--config=<path.to.another.todesktop.json>` to use a different configuration file.
+  - Append `--config=<path.to.config.file>` to use a different configuration file.
   - Append `--exit` to disable dynamic pagination and exit the process once the build data has been displayed.
 - `todesktop logout`. Logs you out.
 - `todesktop smoke-test` Check whether the build works and can be successfully updated.
   - Use `todesktop smoke-test <id>` to test a specific build by ID.
   - `todesktop smoke-test --latest` will test the latest build.
-  - Append `--config=<path.to.another.todesktop.json>` to use a different configuration file.
+  - Append `--config=<path.to.config.file>` to use a different configuration file.
 - `todesktop whoami`. Prints the email of the account you're signed into.
 - `todesktop --help`. Shows the help documentation.
 - `todesktop --version`. Shows the current version of the CLI.
@@ -207,13 +239,27 @@ The webhook receives a POST request with the following JSON body:
 }
 ```
 
-## Project configuration (todesktop.json)
+## Project configuration (todesktop.json, todesktop.js, or todesktop.ts)
+
+This describes all of the possible configuration options in your `todesktop.json`, `todesktop.js`, or `todesktop.ts` file.
+
+You can use:
+
+- A standard JSON file (`todesktop.json`) for static configuration
+- A JavaScript file (`todesktop.js`) that exports a configuration object for dynamic configuration
+- A TypeScript file (`todesktop.ts`) that exports a configuration object with full type checking and IntelliSense
+
+Using `.js` or `.ts` files allows for dynamic configuration, such as setting values based on environment variables or computing paths.
 
-This describes all of the possible configuration options ín your `todesktop.json`.
+**Note:**
+
+- Schema validation and IntelliSense for `.json` files are available through the JSON schema (described under [Installation](#installation))
+- TypeScript files (`.ts`) provide full type checking and IntelliSense when using the exported `Schema` type from `@todesktop/cli`
+- TypeScript compilation requires a local installation of TypeScript in your project
 
 To avoid confusion, the following terms will be used throughout this file:
 
-- "Project root": this is the parent directory of your `todesktop.json`.
+- "Project root": this is the parent directory of your `todesktop.json`, `todesktop.js`, or `todesktop.ts`.
 
 ### `$schema` - (optional) string
 
@@ -226,7 +272,7 @@ To enable JSON validation and IntelliSense for your `todesktop.json` file in com
 - For example, if using a hosted version of the schema:
   ```json
   {
-    "$schema": "https://unpkg.com/@todesktop/cli@1.13.0-0/schemas/schema.json",
+    "$schema": "https://unpkg.com/@todesktop/cli@1.14.0/schemas/schema.json",
     "id": "your-todesktop-id"
   }
   ```
@@ -418,9 +464,11 @@ The DMG windows position and size. In most cases, you will only want to specify
 
 ### `extends` - (optional) string
 
-Example: `./todesktop.staging.json`
+Default: `null`.
+
+Example: `./todesktop.base.json` or `./todesktop.base.js`.
 
-This is the path to a base configuration file. This is especially useful for configuration sharing between staging and production builds. The base configuration file can be a relative path from the project root or an absolute path.
+This is the path to a base configuration file (`.json` or `.js`). This is especially useful for configuration sharing between different environments (e.g., staging and production). The base configuration file can be a relative path from the project root or an absolute path.
 
 For more information about how to create a staging version of your app see: [How do I create a staging version of my app?](#how-do-i-create-a-staging-version-of-my-app).
 
@@ -1202,9 +1250,9 @@ ToDesktop CLI supports the concept of a staging version of your app. This is use
 
 1. Create a new app in ToDesktop's web UI.
 
-2. Create a new todesktop configuration file named `todesktop.staging.json`
+2. Create a new configuration file, for example `todesktop.staging.json` or `todesktop.staging.js`.
 
-3. Add the following to your `todesktop.staging.json` file:
+3. Add the following to your staging configuration file (e.g., `todesktop.staging.json`):
 
 ```json
 {
@@ -1286,6 +1334,18 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ## Changelog
 
+### v1.15.0
+
+- Add support for `todesktop.ts` configuration file with full TypeScript type checking and IntelliSense.
+- Export `Schema` type from `@todesktop/cli` for TypeScript configuration files.
+- TypeScript compilation uses user's local TypeScript installation (no production dependencies added).
+
+### v1.14.0
+
+- Add support for `todesktop.js` configuration file for dynamic configurations.
+- Upgrade to Firebase v11.
+- Update Node.js engine requirement from >=12 to >=16.
+
 ### v1.13.0
 
 - Add support for `platformOverrides` in config to specify platform-specific overrides for app configuration
@@ -1398,7 +1458,7 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.9.0
 
-- You can now specify `@electron/rebuild` as a custom `rebuildLibrary` in your `todesktop.json` file.
+- You can now specify `@electron/rebuild` as a custom `rebuildLibrary` in your configuration file.
 
 ### v1.8.1
 
@@ -1408,8 +1468,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 - Add support for `--webhook` flag for `todesktop build` command
 - Add support for `--async` flag to run a build in the in the background
-- Add support for specifying custom `yarnVersion` in config
-- Add support for specifying custom `pnpmVersion` in config
+- Add support for specifying custom `yarnVersion` in the configuration file
+- Add support for specifying custom `pnpmVersion` in the configuration file
 
 ### v1.7.7
 
@@ -1421,8 +1481,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.7.5
 
-- Add support for specifying custom `npmVersion` in config
-- Add support for bundling a requirements file for Mac
+- Add support for specifying custom `npmVersion` in the configuration file
+- Add support for bundling a requirements file for Mac (`mac.requirements`)
 
 ### v1.7.4
 
@@ -1434,7 +1494,7 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.7.1
 
-- Add support for specifying custom `appBuilderLibVersion` in config
+- Add support for specifying custom `appBuilderLibVersion` in the configuration file
 - Show suggestion to run a Smoke Test when releasing an untested build
 
 ### v1.7.0
@@ -1443,15 +1503,15 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.6.3
 
-- Add support for specifying custom `windows.nsisCustomBinary` in config
+- Add support for specifying custom `windows.nsisCustomBinary` in the configuration file
 
 ### v1.6.2
 
-- Add support for specifying custom `nodeVersion` in config
+- Add support for specifying custom `nodeVersion` in the configuration file
 
 ### v1.6.1
 
-- Add support for specifying `windows.nsisInclude` in config
+- Add support for specifying `windows.nsisInclude` in the configuration file
 
 ### v1.6.0
 
@@ -1480,7 +1540,7 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ### v1.4.0
 
-- Adds `extends` and `packageJson` field to `todesktop.json` file.
+- Adds `extends` and `packageJson` fields to the configuration file.
 - Added `--config` option to pass a different configuration file.
 
 ### v1.3.0