From b54c4705597def884958cfa0b663a1caaff779f6 Mon Sep 17 00:00:00 2001 From: Glenn Rice Date: Wed, 20 Nov 2024 20:50:46 -0600 Subject: [PATCH] Switch to using Perl::Tidy version 20240903 (the latest). This commit just makes the changes in the scripts, but does not yet run perltidy with the new setup. That will be done in the next commit. Note that the `-vxl='q'` option has been removed. This option disables vertical alignment of qw quotes. Alignment of qw quotes was added in version 20220613 (the previous version), and this option to disable that was added to the webwork2 (and pg) perltidy configuration to avoid the alignment because it changes so many files. However, I don't think that alignment is bad, and I am tired of adding new options to prevent code changes. With this newer version another option would be needed to prevent the new signed number alignment (although that affects PG much more than webwork2). Note that the `bin/dev_scripts/run-perltidy.pl` script now insists on this specific version of perltidy instead of this version or newer. This is because every time a new version of perltidy comes out, it changes things. So developers really need to be using the same version or it will not be consistent with the github workflow result. Also, the version requirement in the check_modules.pl script has been removed. Only developers need a specific version of perltidy. Those running webwork2 can use other versions. This is only used for formatting problems in the PG problem editor, and using other versions may result in slightly different formatting there, but that is not so consequential that we need to require a specific version. Note that this change depends on the corresponding pg pull request, because in that pull request the `-vxl='q'` option has been removed. Otherwise version 20220613 or newer of perltidy would still be needed. --- .github/workflows/check-formats.yml | 2 +- .perltidyrc | 1 - bin/check_modules.pl | 1 - bin/dev_scripts/run-perltidy.pl | 5 ++--- 4 files changed, 3 insertions(+), 6 deletions(-) diff --git a/.github/workflows/check-formats.yml b/.github/workflows/check-formats.yml index e94ca09ae2..092dabe309 100644 --- a/.github/workflows/check-formats.yml +++ b/.github/workflows/check-formats.yml @@ -20,7 +20,7 @@ jobs: - name: Checkout code uses: actions/checkout@v4 - name: Install dependencies - run: cpanm -n Perl::Tidy@20220613 + run: cpanm -n Perl::Tidy@20240903 - name: Run perltidy shell: bash run: | diff --git a/.perltidyrc b/.perltidyrc index 4620751c6f..8314b7c173 100644 --- a/.perltidyrc +++ b/.perltidyrc @@ -20,4 +20,3 @@ -nlop # No logical padding (this causes mixed tabs and spaces) -wn # Weld nested containers -xci # Extended continuation indentation --vxl='q' # No vertical alignment of qw quotes diff --git a/bin/check_modules.pl b/bin/check_modules.pl index 428cb83094..8731bc7504 100755 --- a/bin/check_modules.pl +++ b/bin/check_modules.pl @@ -165,7 +165,6 @@ =head1 DESCRIPTION 'LWP::Protocol::https' => 6.06, 'Mojolicious' => 9.34, 'Net::SSLeay' => 1.46, - 'Perl::Tidy' => 20220613, 'SQL::Abstract' => 2.000000 ); diff --git a/bin/dev_scripts/run-perltidy.pl b/bin/dev_scripts/run-perltidy.pl index 1c882f608f..70f60faece 100755 --- a/bin/dev_scripts/run-perltidy.pl +++ b/bin/dev_scripts/run-perltidy.pl @@ -63,9 +63,8 @@ =head1 OPTIONS my $webwork_root = curfile->dirname->dirname->dirname; -die "Version 20220613 or newer of perltidy is required for this script.\n" - . "The installed version is $Perl::Tidy::VERSION.\n" - unless $Perl::Tidy::VERSION >= 20220613; +die "Version 20240903 of perltidy is required for this script.\nThe installed version is $Perl::Tidy::VERSION.\n" + unless $Perl::Tidy::VERSION == 20240903; die "The .perltidyrc file in the webwork root directory is not readable.\n" unless -r "$webwork_root/.perltidyrc";