@todesktop/cli 1.8.0 → 1.9.0

package/README.md

@@ -221,7 +221,7 @@ Example: `["dist/**", "!static/**"]`
 
 This option allows you to decide which files get uploaded to be built on the ToDesktop servers. By default, all files in your app path are included in your app, except for `node_modules` and `.git`. Dependencies are installed on our build servers as there could be platform-specific postinstall steps.
 
-If you wish to include files for the build process but exclude them in the distribtion version of your app then you should use the [`filesForDistribution`](#filesForDistribution---optional-array-of-glob-patterns) property
+If you wish to include files for the build process but exclude them in the distribution version of your app then you should use the [`filesForDistribution`](#filesForDistribution---optional-array-of-glob-patterns) property
 
 The files must be within your [`appPath`](#apppath---optional-string).
 
@@ -648,6 +648,12 @@ Example: `8.10.5`.
 
 The version of pnpm that ToDesktop should use for installation.
 
+### `rebuildLibrary` - (optional) string
+
+Default: `app-builder`.
+
+The library that ToDesktop should use for rebuilding native modules. Valid values are `app-builder` or `@electron/rebuild`.
+
 ### `schemaVersion` - number
 
 Example: `1`.
@@ -834,12 +840,6 @@ Default: `undefined`.
 
 The path to NSIS script to customize installer.
 
-### `yarnVersion` - string
-
-Example: `1.22.1`.
-
-The version of Yarn that ToDesktop should use for installation.
-
 ## 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.
@@ -948,6 +948,24 @@ 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`.
 
+### How can I specify a specific yarnVersion for use with my app?
+
+By default, ToDesktop uses version `1.x.x` of `Yarn` if a `yarn.lock` file is present in your project. You can override this by creating a `.yarnrc.yml` file in your project directory and specifying the `yarnPath` property to point to your specified version of yarn:
+
+```yml
+yarnPath: .yarn/releases/yarn-3.1.1.cjs
+```
+
+This can be done automatically by running `yarn set version x.x.x` from within your project directory. This will create a `.yarnrc.yml` file and a corresponding `.yarn/releases/yarn-x.x.x.cjs` that the `yarnPath` property points to. This will also add a `packageManager` field in your `package.json` with a value of `yarn@x.x.x`
+
+It's important to ensure that the `.yarn` folder is included in your build. If you had previously changed your `todesktop.json`'s [`appFiles`](#appfiles---optional-array-of-glob-patterns) property from its default glob implementation of `**`, then please ensure that it includes the `.yarn` directory:
+
+Example: `[".yarn/**", ".yarnrc.yml", "...include your other changes here..."]`
+
+You will want to exclude the `.yarn` directory in the distribution version of your app. You can use the [`filesForDistribution`](#filesForDistribution---optional-array-of-glob-patterns) property to achieve this:
+
+Example: `["!.yarn/**", "!.yarnrc.yml"]`
+
 ### How do I create a staging version of my app?
 
 ToDesktop CLI supports the concept of a staging version of your app. This is useful if you want to test your app before releasing it to the public. To create a staging version of your app, you need to do the following:
@@ -1038,6 +1056,14 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ## Changelog
 
+## v1.9.0
+
+- You can now specify `@electron/rebuild` as a custom `rebuildLibrary` in your `todesktop.json` file.
+
+### v1.8.1
+
+- Revert support for `yarnVersion` in config. Instead use `.yarnrc.yml` file to specify yarn version.
+
 ### v1.8.0
 
 - Add support for `--webhook` flag for `todesktop build` command

package/dist/cli.js

@@ -1451,6 +1451,11 @@ var full_default = (context) => {
     type: "object",
     required: ["id", "icon", "schemaVersion"],
     properties: {
+      appBuilderLibVersion: {
+        type: "string",
+        validSemver: {},
+        minLength: 1
+      },
       appId: { type: "string", minLength: 1 },
       appFiles: {
         type: "array",
@@ -1679,20 +1684,14 @@ var full_default = (context) => {
         validSemver: {},
         minLength: 1
       },
-      yarnVersion: {
-        type: "string",
-        validSemver: {},
-        minLength: 1
-      },
-      appBuilderLibVersion: {
-        type: "string",
-        validSemver: {},
-        minLength: 1
-      },
       packageManager: {
         type: "string",
         enum: ["npm", "yarn", "pnpm"]
       },
+      rebuildLibrary: {
+        type: "string",
+        enum: ["app-builder", "@electron/rebuild"]
+      },
       schemaVersion: { type: "number", minimum: 1, maximum: 1 },
       snap: {
         type: "object",
@@ -2445,7 +2444,6 @@ async function runBuild({
       nodeVersion: config2.nodeVersion,
       npmVersion: config2.npmVersion,
       pnpmVersion: config2.pnpmVersion,
-      yarnVersion: config2.yarnVersion,
       appBuilderLibVersion: config2.appBuilderLibVersion
     });
   } catch (e) {
@@ -4086,8 +4084,7 @@ async function getBuildAttributes({
     id: appId,
     nodeVersion,
     npmVersion,
-    pnpmVersion,
-    yarnVersion
+    pnpmVersion
   } = getProjectConfig(configPath).config;
   const { id: userId } = await findAppUserId_default(appId);
   const { uid: contextUserId } = currentUser();
@@ -4100,7 +4097,6 @@ async function getBuildAttributes({
     nodeVersion,
     npmVersion,
     pnpmVersion,
-    yarnVersion,
     userId
   };
 }
@@ -4931,7 +4927,6 @@ async function queueSmokeTest({
   nodeVersion,
   npmVersion,
   pnpmVersion,
-  yarnVersion,
   userId
 }) {
   try {
@@ -4941,7 +4936,6 @@ async function queueSmokeTest({
       nodeVersion,
       npmVersion,
       pnpmVersion,
-      yarnVersion,
       userId,
       contextUserId
     });
@@ -5059,7 +5053,6 @@ async function smokeTestWorkflow({
       nodeVersion,
       npmVersion,
       pnpmVersion,
-      yarnVersion,
       userId
     } = await getBuildAttributes({
       buildId,
@@ -5074,7 +5067,6 @@ async function smokeTestWorkflow({
         nodeVersion,
         npmVersion,
         pnpmVersion,
-        yarnVersion,
         userId,
         contextUserId
       });
@@ -5170,7 +5162,7 @@ var package_default = {
     access: "public"
   },
   name: "@todesktop/cli",
-  version: "1.7.7",
+  version: "1.8.1",
   license: "MIT",
   author: "Dave Jeffery <dave@todesktop.com> (http://www.todesktop.com/)",
   homepage: "https://todesktop.com/cli",