woocommerce/tools/code-analyzer/README.md

# Code Analyzer

## Description

`code-analyzer` is a CLI tool designed to analyze change information about plugins in the WooCommerce monorepo.

## Commands

Currently there are 3 commands:

1. `lint`. Analyzer is used as a linter for PRs to check if hook/template/db changes were introduced. It produces output either directly on CI or via setting output variables in GH actions.

Here is an example `analyzer` command, run from this directory:

`pnpm analyzer lint "release/6.8" "6.8.0" -b release/6.7`

In this command we compare the `release/6.7` and `release/6.8` branches to find differences, and we're looking for changes introduced since `6.8.0` (using the `@since` tag).

To find out more about the other arguments to the command you can run `pnpm analyzer -- --help`

2. `major-minor`. This simple CLI tool gives you the latest `.0` major/minor released version of a plugin's mainfile based on Woo release conventions.

Here is an example `major-minor` command, run from this directory:

`pnpm analyzer major-minor "release/6.8" "plugins/woocommerce/woocommerce.php"`

In this command we checkout the branch `release/6.8` and check the version of the woocommerce.php mainfile located at the path passed. Note that at the time of
writing the main file in this particular branch reports `6.8.1` so the output of this command is `6.8.0`.

This command is particularly useful combined with the analyzer, allowing you to determine the last major/minor.0 version of a branch or ref before passing that as the
version argument to `analyzer`.

3. `scan`. Scan is like `lint` but lets you scan for a specific change type. e.g. you can scan just for hook changes if you wish.

Here is an example of the `scan` command run to look for hook changes:

`pnpm analyzer scan hooks "release/6.8" "release/6.7" --since "6.8.0"`
\
In this command we compare the `release/6.7` and `release/6.8` branches to find hook changes, and we're looking for changes introduced since `6.8.0` (using the `@since` tag).
Pass the version argument explicitly to code-analyzer, introduce a new command that determines latest major/minor (#34404) This also adds a new command `major_minor` that contains some of the old logic of `getPluginData` to determine the latest major/minor version of WooCommerce 2022-08-22 04:29:59 +00:00			`# Code Analyzer`

			`## Description`

			`code-analyzer` is a CLI tool designed to analyze change information about plugins in the WooCommerce monorepo.

			`## Commands`

Allow composing code analyzer change detections (hooks, templates, db, schema) (#37161) * Add granular command for scanning individual change types. * documentation and clean up * Refactor the API to be more intuitive and memorable. * Update the documentation. * Update tools/code-analyzer/src/commands/analyzer/analyzer-scan.ts Co-authored-by: jonathansadowski <jonathansadowski@users.noreply.github.com> --------- Co-authored-by: jonathansadowski <jonathansadowski@users.noreply.github.com> 2023-03-21 14:36:30 +00:00			`Currently there are 3 commands:`
Pass the version argument explicitly to code-analyzer, introduce a new command that determines latest major/minor (#34404) This also adds a new command `major_minor` that contains some of the old logic of `getPluginData` to determine the latest major/minor version of WooCommerce 2022-08-22 04:29:59 +00:00
Migrate uses of ::set-output in code-analyzer to setOutput. (#35895) * Migrate uses of ::set-output to setOutput. 2022-12-12 06:41:00 +00:00			1. `lint`. Analyzer is used as a linter for PRs to check if hook/template/db changes were introduced. It produces output either directly on CI or via setting output variables in GH actions.
Pass the version argument explicitly to code-analyzer, introduce a new command that determines latest major/minor (#34404) This also adds a new command `major_minor` that contains some of the old logic of `getPluginData` to determine the latest major/minor version of WooCommerce 2022-08-22 04:29:59 +00:00
Upgrade to pnpm 7 (#34661) * Remove -- -- from scripts that fixed issue in pnpm 6, fix a couple TS issues in sep packages * Minor fixes to analyzer scripts and doco based on pnpm 7 * Add dompurify types to data package to avoid TS errors * Remove pnpx in favor of pnpm exec * Modify the code analyzer to respect pnpm version if present. * Update instructions for running recursive lint, add comments to explain 2022-09-15 21:21:42 +00:00			Here is an example `analyzer` command, run from this directory:
Pass the version argument explicitly to code-analyzer, introduce a new command that determines latest major/minor (#34404) This also adds a new command `major_minor` that contains some of the old logic of `getPluginData` to determine the latest major/minor version of WooCommerce 2022-08-22 04:29:59 +00:00
Code analyzer: find multiple hooks in single patch, add tests (#39566) 2023-08-09 01:05:00 +00:00			`pnpm analyzer lint "release/6.8" "6.8.0" -b release/6.7`
Pass the version argument explicitly to code-analyzer, introduce a new command that determines latest major/minor (#34404) This also adds a new command `major_minor` that contains some of the old logic of `getPluginData` to determine the latest major/minor version of WooCommerce 2022-08-22 04:29:59 +00:00
			In this command we compare the `release/6.7` and `release/6.8` branches to find differences, and we're looking for changes introduced since `6.8.0` (using the `@since` tag).

Removed Unnecessary `run` From `pnpm` 2023-11-28 22:50:43 +00:00			To find out more about the other arguments to the command you can run `pnpm analyzer -- --help`
Pass the version argument explicitly to code-analyzer, introduce a new command that determines latest major/minor (#34404) This also adds a new command `major_minor` that contains some of the old logic of `getPluginData` to determine the latest major/minor version of WooCommerce 2022-08-22 04:29:59 +00:00
Migrate uses of ::set-output in code-analyzer to setOutput. (#35895) * Migrate uses of ::set-output to setOutput. 2022-12-12 06:41:00 +00:00			2. `major-minor`. This simple CLI tool gives you the latest `.0` major/minor released version of a plugin's mainfile based on Woo release conventions.
Pass the version argument explicitly to code-analyzer, introduce a new command that determines latest major/minor (#34404) This also adds a new command `major_minor` that contains some of the old logic of `getPluginData` to determine the latest major/minor version of WooCommerce 2022-08-22 04:29:59 +00:00
Upgrade to pnpm 7 (#34661) * Remove -- -- from scripts that fixed issue in pnpm 6, fix a couple TS issues in sep packages * Minor fixes to analyzer scripts and doco based on pnpm 7 * Add dompurify types to data package to avoid TS errors * Remove pnpx in favor of pnpm exec * Modify the code analyzer to respect pnpm version if present. * Update instructions for running recursive lint, add comments to explain 2022-09-15 21:21:42 +00:00			Here is an example `major-minor` command, run from this directory:
Pass the version argument explicitly to code-analyzer, introduce a new command that determines latest major/minor (#34404) This also adds a new command `major_minor` that contains some of the old logic of `getPluginData` to determine the latest major/minor version of WooCommerce 2022-08-22 04:29:59 +00:00
Code analyzer: find multiple hooks in single patch, add tests (#39566) 2023-08-09 01:05:00 +00:00			`pnpm analyzer major-minor "release/6.8" "plugins/woocommerce/woocommerce.php"`
Pass the version argument explicitly to code-analyzer, introduce a new command that determines latest major/minor (#34404) This also adds a new command `major_minor` that contains some of the old logic of `getPluginData` to determine the latest major/minor version of WooCommerce 2022-08-22 04:29:59 +00:00
			In this command we checkout the branch `release/6.8` and check the version of the woocommerce.php mainfile located at the path passed. Note that at the time of
			writing the main file in this particular branch reports `6.8.1` so the output of this command is `6.8.0`.

			`This command is particularly useful combined with the analyzer, allowing you to determine the last major/minor.0 version of a branch or ref before passing that as the`
			version argument to `analyzer`.
Allow composing code analyzer change detections (hooks, templates, db, schema) (#37161) * Add granular command for scanning individual change types. * documentation and clean up * Refactor the API to be more intuitive and memorable. * Update the documentation. * Update tools/code-analyzer/src/commands/analyzer/analyzer-scan.ts Co-authored-by: jonathansadowski <jonathansadowski@users.noreply.github.com> --------- Co-authored-by: jonathansadowski <jonathansadowski@users.noreply.github.com> 2023-03-21 14:36:30 +00:00
			3. `scan`. Scan is like `lint` but lets you scan for a specific change type. e.g. you can scan just for hook changes if you wish.

			Here is an example of the `scan` command run to look for hook changes:

			`pnpm analyzer scan hooks "release/6.8" "release/6.7" --since "6.8.0"`
			`\`
			In this command we compare the `release/6.7` and `release/6.8` branches to find hook changes, and we're looking for changes introduced since `6.8.0` (using the `@since` tag).