@todesktop/cli 0.28.2 → 1.1.1

package/README.md

@@ -11,7 +11,9 @@ For more information, visit the project [landing page](https://www.todesktop.com
 - [CLI commands](#cli-commands)
 - [Automating your builds (CI)](#automating-your-builds-ci)
 - [Project configuration (todesktop.json)](#project-configuration-todesktopjson)
+- [Build lifecycle hooks (package.json scripts)](#build-lifecycle-hooks-packagejson-scripts)
 - [App package.json requirements](#packagejson-requirements)
+- [Changelog](#changelog)
 
 ## Installation
 
@@ -647,6 +649,86 @@ Default: The root [`icon`](#icon---string) is used.
 
 The path to your application's Windows desktop icon. It must be an ICO, ICNS, or PNG.
 
+## Build lifecycle hooks (package.json scripts)
+
+Sometimes you want to do something before or during the build process. For example, you might want to run a script before the build starts, or you might want to run a script after the files have been packaged. Our lifecycle hooks provide a way to do this.
+
+To specify a script, add a `scripts` property to your `package.json` file. The key is the name of the script (prefixed by `todesktop:`), and the value is the path to the script.
+
+```json
+{
+  "scripts": {
+    "todesktop:beforeInstall": "./scripts/beforeInstall.js",
+    "todesktop:afterPack": "./scripts/afterPack.js"
+  }
+}
+```
+
+When writing your script, you can follow this template:
+
+```js
+module.exports = async ({ pkgJsonPath, pkgJson, appDir, hookName }) => {
+  /**
+   * pkgJsonPath - string - path to the package.json file
+   * pkgJson - object - the parsed package.json file
+   * appDir - string - the path to the app directory
+   * hookName - string - the name of the hook ("todesktop:beforeInstall" or "todesktop:afterPack")
+   */
+};
+```
+
+### `todesktop:beforeInstall` - (optional) path to script
+
+Example: `./scripts/beforeInstall.js`.
+
+The path to a script that will be run before the build starts.
+
+Example script:
+
+```js
+const { writeFile } = require("fs/promises");
+
+// Delete `internal` dependency from package.json
+module.exports = async ({ pkgJsonPath, pkgJson, appDir, hookName }) => {
+  delete pkgJson.dependencies["internal"];
+  await writeFile(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
+};
+```
+
+### `todesktop:afterPack` - (optional) path to script
+
+Example: `./scripts/afterPack.js`.
+
+The path to a script that will be run after the app has been packed (but _before_ it has been transformed into a distributable installer format and signed).
+
+The `afterPack` function also has the following arguments added to it's signature:
+
+- appPkgName - string - the name of the app package
+- appId - string - the app id
+- shouldCodeSign - boolean - whether the app will be code signed or not
+- outDir - string - the path to the output directory
+- appOutDir - string - the path to the app output directory
+- arch - string - the architecture of the app
+- packager - object - the packager object
+
+Example script:
+
+```js
+const { writeFile } = require("fs/promises");
+
+// Add a copyright file inside of the app directory on Mac only
+module.exports = async ({ appOutDir, packager }) => {
+  if (os.platform() === "darwin") {
+    const appName = packager.appInfo.productFilename;
+    const appPath = path.join(`${appOutDir}`, `${APP_NAME}.app`);
+    await writeFile(
+      path.join(appPath, "copyright.txt"),
+      `Copyright © ${new Date().getFullYear()} ${APP_NAME}`
+    );
+  }
+};
+```
+
 ## App package.json requirements
 
 - Electron must be in your `devDependencies` and it must be a fixed version. I.e. it doesn't start with `^` or `~`.
@@ -674,3 +756,16 @@ To summarize:
 ```
 
 Note: **Do not put a token in this file**. You are specifying a literal value of `${NPM_TOKEN}`. NPM will replace the value for you. 5. Add `.npmrc` to your `appFiles` array `[".npmrc"]` in `todesktop.json`.
+
+## Changelog
+
+### v1.1.0
+
+- Add support for `beforeInstall` and `afterPack` hooks.
+
+### v1.0.0
+
+- Feature: Support multiple concurrent builds
+- Enhancement: Switched to presigned uploads (removes AWS dependency)
+- Fix: Fixed package resolution for Ink
+- Add PNPM support