From be3ac531969705afd25a5b110d3ac350d160a63c Mon Sep 17 00:00:00 2001 From: David Baker Date: Tue, 10 Dec 2024 17:56:27 +0000 Subject: [PATCH] Manal upgrade to prettier 3.4.2 Including the reformatting changes needed to make it pass again (mostly due to https://github.com/prettier/prettier/pull/15526). --- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- README.md | 14 ++++++------- docs/SUMMARY.md | 12 +++++------ docs/native-node-modules.md | 6 +++--- docs/packaging.md | 4 ++-- docs/windows-requirements.md | 26 ++++++++++++------------ scripts/hak/README.md | 34 ++++++++++++++++---------------- yarn.lock | 6 +++--- 8 files changed, 55 insertions(+), 55 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 226d21f498..d20cda607c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,7 +2,7 @@ ## Checklist -- [ ] Ensure your code works with manual testing. -- [ ] New or updated `public`/`exported` symbols have accurate [TSDoc](https://tsdoc.org/) documentation. -- [ ] Linter and other CI checks pass. -- [ ] I have licensed the changes to Element by completing the [Contributor License Agreement (CLA)](https://cla-assistant.io/element-hq/element-desktop) +- [ ] Ensure your code works with manual testing. +- [ ] New or updated `public`/`exported` symbols have accurate [TSDoc](https://tsdoc.org/) documentation. +- [ ] Linter and other CI checks pass. +- [ ] I have licensed the changes to Element by completing the [Contributor License Agreement (CLA)](https://cla-assistant.io/element-hq/element-desktop) diff --git a/README.md b/README.md index e6db649202..2c2f2c983f 100644 --- a/README.md +++ b/README.md @@ -75,10 +75,10 @@ yarn run build This will do a couple of things: -- Run the `setversion` script to set the local package version to match whatever - version of Element you installed above. -- Run electron-builder to build a package. The package built will match the operating system - you're running the build process on. +- Run the `setversion` script to set the local package version to match whatever + version of Element you installed above. +- Run electron-builder to build a package. The package built will match the operating system + you're running the build process on. ## Docker @@ -131,9 +131,9 @@ Alternatively, a custom location for the profile data can be specified using the # User-specified config.json -- `%APPDATA%\$NAME\config.json` on Windows -- `$XDG_CONFIG_HOME/$NAME/config.json` or `~/.config/$NAME/config.json` on Linux -- `~/Library/Application Support/$NAME/config.json` on macOS +- `%APPDATA%\$NAME\config.json` on Windows +- `$XDG_CONFIG_HOME/$NAME/config.json` or `~/.config/$NAME/config.json` on Linux +- `~/Library/Application Support/$NAME/config.json` on macOS In the paths above, `$NAME` is typically `Element`, unless you use `--profile $PROFILE` in which case it becomes `Element-$PROFILE`, or it is using one of diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7842ec3d9e..316602efb1 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,17 +1,17 @@ # Summary -- [Introduction](../README.md) +- [Introduction](../README.md) # Build -- [Native Node modules](native-node-modules.md) -- [Windows requirements](windows-requirements.md) +- [Native Node modules](native-node-modules.md) +- [Windows requirements](windows-requirements.md) # Distribution -- [Updates](updates.md) -- [Packaging](packaging.md) +- [Updates](updates.md) +- [Packaging](packaging.md) # Setup -- [Config](config.md) +- [Config](config.md) diff --git a/docs/native-node-modules.md b/docs/native-node-modules.md index 87efc36a35..675af42cd2 100644 --- a/docs/native-node-modules.md +++ b/docs/native-node-modules.md @@ -17,9 +17,9 @@ when releasing. Install the pre-requisites for your system: -- [Windows pre-requisites](https://github.com/vector-im/element-desktop/blob/develop/docs/windows-requirements.md) -- Linux: TODO -- OS X: TODO +- [Windows pre-requisites](https://github.com/vector-im/element-desktop/blob/develop/docs/windows-requirements.md) +- Linux: TODO +- OS X: TODO Then optionally, [add seshat and dependencies to support search in E2E rooms](#adding-seshat-for-search-in-e2e-encrypted-rooms). diff --git a/docs/packaging.md b/docs/packaging.md index 2d501abb15..eec14f31d9 100644 --- a/docs/packaging.md +++ b/docs/packaging.md @@ -17,8 +17,8 @@ Simply go to https://github.com/vector-im/element-desktop/actions/workflows/buil For releasing Element Desktop, we assume the following prerequisites: -- a tag of `element-desktop` repo with the Element Desktop version to be released set in `package.json`. -- an Element Web tarball published to GitHub with a matching version number. +- a tag of `element-desktop` repo with the Element Desktop version to be released set in `package.json`. +- an Element Web tarball published to GitHub with a matching version number. **Both of these are done automatically when you run the release automation.** diff --git a/docs/windows-requirements.md b/docs/windows-requirements.md index 0b45899a1f..774b34782d 100644 --- a/docs/windows-requirements.md +++ b/docs/windows-requirements.md @@ -6,19 +6,19 @@ We rely on Github Actions `windows-2022` plus a few extra utilities as per [the If you want to build native modules, make sure that the following tools are installed on your system. -- [Git for Windows](https://git-scm.com/download/win) -- [Node 16](https://nodejs.org) -- [Python 3](https://www.python.org/downloads/) (if you type 'python' into command prompt it will offer to install it from the windows store) -- [Strawberry Perl](https://strawberryperl.com/) -- [Rustup](https://rustup.rs/) -- [NASM](https://www.nasm.us/) -- [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019) with the following configuration: - - On the Workloads tab: - - Desktop & Mobile -> C++ build tools - - On the Individual components tab: - - MSVC VS 2019 C++ build tools - - Windows 10 SDK (latest version available) - - C++ CMake tools for Windows +- [Git for Windows](https://git-scm.com/download/win) +- [Node 16](https://nodejs.org) +- [Python 3](https://www.python.org/downloads/) (if you type 'python' into command prompt it will offer to install it from the windows store) +- [Strawberry Perl](https://strawberryperl.com/) +- [Rustup](https://rustup.rs/) +- [NASM](https://www.nasm.us/) +- [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019) with the following configuration: + - On the Workloads tab: + - Desktop & Mobile -> C++ build tools + - On the Individual components tab: + - MSVC VS 2019 C++ build tools + - Windows 10 SDK (latest version available) + - C++ CMake tools for Windows Once installed make sure all those utilities are accessible in your `PATH`. diff --git a/scripts/hak/README.md b/scripts/hak/README.md index 472cd1c2a1..a5681d8b32 100644 --- a/scripts/hak/README.md +++ b/scripts/hak/README.md @@ -5,12 +5,12 @@ documentation for it. Goals: -- Must build compiled native node modules in a shippable state - (ie. only dynamically linked against libraries that will be on the - target system, all unnecessary files removed). -- Must be able to build any native module, no matter what build system - it uses (electron-rebuild is supposed to do this job but only works - for modules that use gyp). +- Must build compiled native node modules in a shippable state + (ie. only dynamically linked against libraries that will be on the + target system, all unnecessary files removed). +- Must be able to build any native module, no matter what build system + it uses (electron-rebuild is supposed to do this job but only works + for modules that use gyp). It's also loosely designed to be a general tool and agnostic to what it's actually building. It's used here to build modules for the electron app @@ -25,13 +25,13 @@ If no dependencies are given, hak runs the command on all dependencies. There are a lot of files involved: -- scripts/hak/... - The tool itself -- hak/[dependency] - Files provided by the app that tell hak how to build each of its native dependencies. - Contains a hak.json file and also some script files, each of which must be referenced in hak.json. -- .hak/ - Files generated by hak in the course of doing its job. Includes the dependency module itself and - any of the native dependency's native dependencies. -- .hak/[dependency]/build - An extracted copy of the dependency's node module used to build it. -- .hak/[dependency]/out - Another extracted copy of the dependency, this one contains only what will be shipped. +- scripts/hak/... - The tool itself +- hak/[dependency] - Files provided by the app that tell hak how to build each of its native dependencies. + Contains a hak.json file and also some script files, each of which must be referenced in hak.json. +- .hak/ - Files generated by hak in the course of doing its job. Includes the dependency module itself and + any of the native dependency's native dependencies. +- .hak/[dependency]/build - An extracted copy of the dependency's node module used to build it. +- .hak/[dependency]/out - Another extracted copy of the dependency, this one contains only what will be shipped. # Workings @@ -60,10 +60,10 @@ own in the .hak directory (unless one already exists, in which case this is your Hak is divided into lifecycle stages, in order: -- fetch - Download and extract the source of the dependency -- link - Link the copy of the dependency into your node_modules directory -- build - The Good Stuff. Configure and build any native dependencies, then the module itself. -- copy - Copy the built artifact from the module build directory to the module output directory. +- fetch - Download and extract the source of the dependency +- link - Link the copy of the dependency into your node_modules directory +- build - The Good Stuff. Configure and build any native dependencies, then the module itself. +- copy - Copy the built artifact from the module build directory to the module output directory. # hak.json diff --git a/yarn.lock b/yarn.lock index ac87c88e3b..1c121a42f5 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6353,9 +6353,9 @@ prelude-ls@^1.2.1: integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== prettier@^3.0.0: - version "3.3.3" - resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.3.3.tgz#30c54fe0be0d8d12e6ae61dbb10109ea00d53105" - integrity sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew== + version "3.4.2" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.4.2.tgz#a5ce1fb522a588bf2b78ca44c6e6fe5aa5a2b13f" + integrity sha512-e9MewbtFo+Fevyuxn/4rrcDAaq0IYxPGLvObpQjiZBMAzB9IGmzlnG9RZy3FFas+eBMu2vA0CszMeduow5dIuQ== pretty-ms@^9.0.0: version "9.2.0"