[88] Add version script to build tools #119

jordanharris-6 · 2024-05-24T14:25:29Z

88 - This PR adds a new command to the build tools package so you can increase the increment the project version in all files without updating them manually.

The command is build-tools version <version type> <project>

The versions currently are

Major X.0.0
Minor 1.X.0
Patch 1.1.X
major:beta X.0.0-beta.0
minor:beta 1.X.0-beta.0
patch:beta 1.0.X-beta.0
beta 1.0.0-beta.X
*X representing the value which will change when the command is applied.

The project command can be left blank which will search the whole directory or you can list projects for example theme,plugin1, plugin2 etc

This will then go through and update the files in those directories.

It currently updates the version in package.json, plugin.php and style.css

To test:
Once you have build-tools and yalc added to your test project
Run build-tools version minor for example and this will go through all the files and folders in the directory your in and increment the version.
It will also return which files it found and inform you of the old version and the version it has been upgraded too.

Video -> http://bigbite.im/v/tf2VBx

Change Log

New version.js
Adds the semver package to increment the values.

ampersarnie

Thanks for putting the work into this Jordan. There's a lot to understand within this process and Node.js has its own quirks that you don't get in the browser.

I've left some feedback, there's a few issues that I've noticed. Some minor, and some that will need more work. I've also got some additional issues that I found through testing that can't be added as part of the code review so I'll make individual comments.

src/commands/version.js

ampersarnie · 2024-06-04T18:54:30Z

src/commands/version.js

+  // with no projects listed it returns a empty array
+  const projectsList = projects.split(',').filter((item) => item.length > 0);
+  const excludeDirs = ['node_modules', 'dist', 'build', 'vendor', 'vendor_prefixed'];
+  const targetFiles = ['package.json', 'style.css', 'plugin.php'];


There are additional target files and it wouldn't just be limited to those three. If you refer back to our Slack conversation it was mentioned that there could be additional plugin files that we would need to look at.

Much like using plugin.php as the entry point file for a plugin file, it's also possible to use any other named file. As long the heading doc block exists. Normally these will be the same as the plugin directory but can be different, there can also be multiple.

As an example the following are all valid in any combination and/or multiple:

File Works

example-plugin/plugin.php ✅

example-plugin/example-plugin.php ❌

example-plugin/some-file.php ❌

example-plugin.php ❌

Because of this it doesn't make sense to have a hardcoded list, and should be more dynamic to account for this variation in possibilities.

I have refactored this now so it searches files for Version instead of finding specific files.

Come across several issues with this change, you can find them discussed in this comment.

ampersarnie · 2024-06-04T19:03:07Z

src/commands/version.js

+  /**
+   * Function to search for all files which are not in the excluded directories
+   *
+   * @param {string} basePath - The base directory to start searching from.
+   * @param {Array} directoryNames - An array of directory names to match.
+   * @returns {Array} - An array of matching directory paths.
+   */
+  const getAllFiles = (dirPath, arrayOfFiles) => {
+    const files = fs.readdirSync(dirPath);
+
+    arrayOfFiles = arrayOfFiles || [];
+
+    files.forEach((file) => {
+      const filePath = path.join(dirPath, file);
+      if (fs.statSync(filePath).isDirectory()) {
+        if (!excludeDirs.includes(file)) {
+          arrayOfFiles = getAllFiles(filePath, arrayOfFiles);
+        }
+      } else {
+        arrayOfFiles.push(filePath);
+      }
+    });
+
+    return arrayOfFiles;
+  };
+
+  /**
+   * Function to find the files we want to use.
+   * @param {string} baseDirs - Base directory to search from.
+   * @param {Array} targets - Files we want to find
+   */
+  const findTargetFiles = (baseDirs, targets) => {
+    baseDirs.forEach((baseDir) => {
+      if (fs.existsSync(baseDir) && fs.statSync(baseDir).isDirectory()) {
+        const allFiles = getAllFiles(baseDir);
+        allFiles.forEach((filePath) => {
+          const fileName = path.basename(filePath);
+          if (targets.includes(fileName)) {
+            incrementVersionNumber(fileName, filePath, type);
+          }
+        });
+      } else {
+        console.error(`Directory not found: ${baseDir}`);
+      }
+    });
+  };


We don't need to recursively seek out files in this manner. This will add a lot of overhead when creating compiling the list, especially in larger projects where theres multiple layers and directories. You can reduce this down into something more performant by using the project directories and targeting those, as we already know that all the files required will live in the project directory.

For example these are what you need to be looking for at a minimum:

File

example-plugin/*.php

example-plugin/style.css

example-plugin/package.json

example-plugin/package-lock.json

@ampersarnie would it be possible to get another example on this please im struggling to get my head around this. My thoughts are that you would need to recursively search to find the plugins ?

If you look at the build command file you will see that it already holds functionality for finding plugins/themes that Build Tools can and should process. Lines 62 through to 113 handle all of the looking up projects and creating that list for you to work from. It provides a whole range of paths and file points that you can use, such as the package.json.

Because we know that the files you need to increment are in the root of a project (i.e. plugins/my-plugin/*), you can target files within that directory alone, removing the need for recursion.

For consistency with targeting correct projects, you should use that same process that the build command uses, rather than trying to create it from scratch and implementing a different solution.

As for why not use recursion, there are a number of them:

It can add unnecessary processing to the file look up as its not just targeting files, or directory levels that we are aware of (the root level). But it's also going to look through every other directory in the plugin. For example I was able to get a file processed that I added to dir1/dir2/dir3/some-file.php. It doesn't need it for the case we have here.

In conjunction with the changes you made here and after further testing, it is also possible due to the recursion setup to have a plugin and/or theme that should not be processed by Build Tools. This is because the recursion and lookup is targeting any file and any directory that has a package.json file. This is going to cause issues with updating versions in 3rd party plugins/themes. Take the following steps:

Create a plugin package.json - plugins/non-build-tools-plugin/package.json - and add the following basic config:

{ "version": "12.3.4" }

Create a plugin entry file - plugins/non-build-tools-plugin/plugin.php - and add the following:

<?php /** * Version: 12.3.4 **/

Run a version update on all projects from wp-content

build-tools version patch

You should see non-build-tools-plugin being processed in the list.

That dummy project you have created should not have a version increase as it doesn't have the correct setup to work across our build setup. You will also see the same results if you add a third-party plugin/theme to one of the related directories - client-mu-plugins, plugins or themes.

Does this help?

src/commands/version.js

ampersarnie · 2024-06-04T19:13:32Z

Not able to update from project directory.

When working from a theme or plugin directory, I am not able to increment the version of that project. I should be able to increment a project version on an individual basis.

Example

cd example-site/themes/test-theme
node ../../../src/cli.js version minor

Output

No Projects Found

Note

Edit: Issue has been addressed.

ampersarnie · 2024-06-04T19:13:50Z

Short version numbers not updated.

When updating a theme or plugin, if there is an assignment of a version such as 1.0 rather than 1.0.0. As 1.0 or similar is still valid when it comes to semver standards, these should also be accepted and incremented appropriately. Here's a list of some expectations around that.

Patch → 1.0 → 1.0.1
Minor → 1.0 → 1.1.0
Major → 1.0 → 2.0.0

Example
If I change the version to 1.3 in example-site/themes/test-theme/styles.css and run the blow command.

cd example-site/themes/test-theme
node ../../../src/cli.js version minor

The blow is output, where it can be seen that it does not pick up the changed styles.css and opening the file itself will show that it remains 1.3.

searching all projects.....
Error incrementing version in client-mu-plugins/test-client-plugin/package.json: Invalid version: undefined
Error incrementing version in plugins/standards/package.json: Invalid version: undefined
#plugins/test-plugin/package.json: 1.4.0 -> 1.5.0
#plugins/test-plugin/src/plugin.php: 1.4.0 -> 1.5.0
#themes/test-theme/package.json: 1.3.0 -> 1.4.0

Note

Edit: Issue has been addressed.

ampersarnie · 2024-06-04T19:13:59Z

`package-lock.json` file not incremented

When updating a version, the package-lock.json also needs incrementing to keep it consistent with the package.json increase. Its also worth bearing in mind that this file may not exist, in which case it should be allowed to be skipped, so we're not forcing this file to exist even when required.

Note

Edit: Issue has been addressed.

ampersarnie · 2024-06-04T19:14:07Z

There are no options for a Release Candidate

Not in the original ticket but it would be nice to be able pass an rc sub command through to the script to create a Release Candidate version. This should work in the same way that has been implemented for Beta releases with the *:beta subcommand.

Example

build-tools version minor:rc

Output

#plugins/test-plugin/package.json: 1.8.0 -> 1.9.0-rc.1
#plugins/test-plugin/src/plugin.php: 1.8.0 -> 1.9.0-rc.1

Note

Edit: Issue has been addressed.

ampersarnie · 2024-06-04T19:14:21Z

Messaging inconsistencies

Terminal output doesn't have consistent approaches and language. The following changes should be made:

searching all projects.... → Incrementing All Projects...
finding all projects to increment.... → Incrementing List of Projects...

Note

Edit: Issue has been addressed.

ampersarnie · 2024-06-04T19:14:34Z

non-lowercase subcommands fail

Using subcommands that are not lowercase will fail, causing the same null assignment that happens without a subcommand.

Example

cd example-site/themes/test-theme
node ../../../src/cli.js version MINOR

Output

Error incrementing version in client-mu-plugins/test-client-plugin/package.json: Invalid version: undefined
Error incrementing version in plugins/standards/package.json: Invalid version: undefined
Error incrementing version in plugins/test-plugin/package.json: Invalid version: null
#themes/test-theme/package.json: 1.8.0 -> null
#themes/test-theme/style.css: 1.2.0 -> null

You have two options on how to approach this:

Force all subcommands to be treated as lowercase so they're always actionable when used, or
Check for non-valid subcommands and throw an error, preventing the process from going further and creating null versions.

Note

Edit: Issue has been addressed.

ampersarnie · 2024-06-04T19:14:48Z

Spacing inconsistencies

There's a fair amount of spacing consistencies between variable, and logical declarations. There are some indentation issues across files that would need addressing also.

const example = 'value';

if (logicCheck !== 123) {
	// ... 
}

Keeping some separation will help readability overall for others.

ampersarnie · 2024-06-04T19:14:59Z

Terminal Output Colours

It would be nice to be able to have some additional styling and formatting with the terminal output that takes advantage of ANSI escape codes and colours. See how it is done here for example.

Note

Edit: Issue has been addressed.

ampersarnie

The following issues still need addressing:

There are no options for a Release Candidate - [88] Add version script to build tools #119 (comment)
Spacing Inconsistencies - [88] Add version script to build tools #119 (comment)

src/utils/increment-version.js

jordanharris-6 · 2024-07-04T13:34:00Z

@ampersarnie on this comment #119 (comment)

Could you let me know what im missing here please? when I add a RC to the command it adds a rc release number http://bigbite.im/i/qcTpJF

Also I added the 1 to the prerelease to semver inc as requested however it still comes out as .0 I wondered if you know where im going wrong with this?

Thanks 😄

ampersarnie · 2024-07-05T13:03:54Z

@jordanharris-6

Could you let me know what im missing here please? when I add a RC to the command it adds a rc release number http://bigbite.im/i/qcTpJF

When I'm looking at it, its increasing the wrong version. So if I have a current version of 10.0.0 and run a major:rc version increase, what I'm not left with is 10.0.1-rc.1. It's increasing the patch number, not the major. I would expect to get 11.0.0-rc.1.

Also I added the 1 to the prerelease to semver inc as requested however it still comes out as .0 I wondered if you know where im going wrong with this?

I changed it on your previous version to a 1 and it comes out as expected. But I'm not able to test with your latest changes as I'm getting the following error:

example-site git:(feat/88-version-increment) ✗ node ../src/cli.js version major:beta
Incrementing All Projects...
ReferenceError: path is not defined%

jordanharris-6 · 2024-07-08T10:57:01Z

@ampersarnie I think I have solved this by removing an if statement and adding in another command http://bigbite.im/v/ZIup9l

You can now do build-tools version prerelease:beta << this will change the last value in the version after -beta

ampersarnie

I've not done any thorough testing this time around, this is purely a code review. Will test once these have been addressed.

ampersarnie · 2024-07-11T15:27:57Z

src/commands/version.js

+const { getPackageVersion } = require('./../utils/get-package-version');
+const { findAllProjectPaths } = require('./../utils/get-version-project-paths');


You don't need these custom functions, we already have prior art that covers both of these situations. As mentioned in this comment you can use the same setup from the build command file.

If you look in the build command file, and at lines 62 through to 113 you will see the function in use that compiles the list of packages available to compile. There you will also find the code that extracts a object config which creates all variations of the paths required for you to use these, including a path to the package.json file and extracted version from that file.

To keep things consistent across both commands, use these and adapt them if you need.

ampersarnie · 2024-07-11T15:29:40Z

src/commands/version.js

+  try {
+    if (projectsList.length === 0 && !isAllProjects) {
+      // Increment projects in current directory
+      terminal('\x1b[1mIncrementing Projects In \x1b[4mDirectory\x1b[0m...\n');
+      packages.push(getPackageVersion(path.resolve('./')));
+    } else if (isAllProjects) {
+      // Increment all projects i.e from wp-content folder
+      terminal('\x1b[1mIncrementing \x1b[4mAll Projects\x1b[0m...\n');
+      packages = findAllProjectPaths(targetDirs).map((path) => getPackageVersion(path));
+    } else {
+      // Increment specified projects
+      terminal('\x1b[1mIncrementing \x1b[4mList of Projects\x1b[0m...\n');
+      packages = findAllProjectPaths(targetDirs, projectsList).map((path) =>
+        getPackageVersion(path),
+      );
+
+      const packageNames = packages.map((pkg) => pkg.name);
+      projectsList.map((projectName) => {
+        if (!packageNames.includes(projectName)) {
+          terminal.red(`Error: Project ${projectName} does not exist.\n`);
+        }
+        packageNames.includes(projectName);
+      });
+    }
+  } catch (e) {
+    terminal.red(e);
+    process.exit(1);
+  }


You're creating a lot of duplicate code here, as mentioned in my other command you can use what exists in the build command. You should extract those functions and processes out into their own files, so you have shared utils.

ampersarnie · 2024-07-11T15:30:24Z

src/utils/get-package-version.js

You don't need this, see previous command about removing it and using prior art/code from build command.

ampersarnie · 2024-07-11T15:30:28Z

src/utils/get-version-project-paths.js

You don't need this, see previous command about removing it and using prior art/code from build command.

jordanharris-6 · 2024-07-22T14:32:24Z

@ampersarnie I've refactored this now to re-use the existing functions

made requested changes

jordanharris-6 added 3 commits May 24, 2024 14:44

feat: Add script to update version

1e77ddf

1.4.0

9637f56

fix: remove type of console log

6e7e152

jordanharris-6 requested a review from ampersarnie as a code owner May 24, 2024 14:25

ampersarnie requested changes Jun 4, 2024

View reviewed changes

jordanharris-6 added 2 commits June 18, 2024 16:32

refactor: use enum instead of switch

2eed3b4

feat: refactor of existing + added RC functionality

51dc3d9

jordanharris-6 added the enhancement New feature or request label Jun 27, 2024

jordanharris-6 requested a review from ampersarnie June 27, 2024 11:00

refactor: use semver inc

ef9a075

ampersarnie requested changes Jun 27, 2024

View reviewed changes

src/utils/increment-version.js Outdated Show resolved Hide resolved

refactor: change way of getting files

aec92ac

jordanharris-6 added 2 commits July 5, 2024 14:26

fix: change imports

3d49247

fix: don't use length when variable doesn't exist

68c5ab6

jordanharris-6 added 2 commits July 8, 2024 11:57

fix: increment rc properly

a0266c6

fix: tidy up console logs

61eb285

ampersarnie self-requested a review July 11, 2024 14:54

ampersarnie previously requested changes Jul 11, 2024

View reviewed changes

refactor: re-use exisiting functions

df56102

fix: return false if empty object

6b14405

jordanharris-6 requested a review from ampersarnie July 22, 2024 14:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[88] Add version script to build tools #119

[88] Add version script to build tools #119

jordanharris-6 commented May 24, 2024

ampersarnie left a comment •

edited

Loading

ampersarnie Jun 4, 2024

jordanharris-6 Jun 27, 2024

ampersarnie Jun 27, 2024

ampersarnie Jun 4, 2024

jordanharris-6 Jun 25, 2024

ampersarnie Jun 27, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie left a comment

jordanharris-6 commented Jul 4, 2024

ampersarnie commented Jul 5, 2024

jordanharris-6 commented Jul 8, 2024

ampersarnie left a comment

ampersarnie Jul 11, 2024

ampersarnie Jul 11, 2024

ampersarnie Jul 11, 2024

ampersarnie Jul 11, 2024

jordanharris-6 commented Jul 22, 2024

File	Works
`example-plugin/plugin.php`	✅
`example-plugin/example-plugin.php`	❌
`example-plugin/some-file.php`	❌
`example-plugin.php`	❌

		const { getPackageVersion } = require('./../utils/get-package-version');
		const { findAllProjectPaths } = require('./../utils/get-version-project-paths');

[88] Add version script to build tools #119

Are you sure you want to change the base?

[88] Add version script to build tools #119

Conversation

jordanharris-6 commented May 24, 2024

Change Log

ampersarnie left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ampersarnie Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

ampersarnie commented Jun 4, 2024 • edited Loading

Not able to update from project directory.

ampersarnie commented Jun 4, 2024 • edited Loading

Short version numbers not updated.

ampersarnie commented Jun 4, 2024 • edited Loading

package-lock.json file not incremented

ampersarnie commented Jun 4, 2024 • edited Loading

There are no options for a Release Candidate

ampersarnie commented Jun 4, 2024 • edited Loading

Messaging inconsistencies

ampersarnie commented Jun 4, 2024 • edited Loading

non-lowercase subcommands fail

ampersarnie commented Jun 4, 2024

Spacing inconsistencies

ampersarnie commented Jun 4, 2024 • edited Loading

Terminal Output Colours

ampersarnie left a comment

Choose a reason for hiding this comment

jordanharris-6 commented Jul 4, 2024

ampersarnie commented Jul 5, 2024

jordanharris-6 commented Jul 8, 2024

ampersarnie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jordanharris-6 commented Jul 22, 2024

ampersarnie left a comment •

edited

Loading

ampersarnie Jun 27, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

`package-lock.json` file not incremented

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading

ampersarnie commented Jun 4, 2024 •

edited

Loading