Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/tools/code-analyzer
History
Sam Seay 52bc1879bb
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 09:36:30 -05:00
..
src Allow composing code analyzer change detections (hooks, templates, db, schema) (#37161) 2023-03-21 09:36:30 -05:00
.eslintignore CLI tool and GH workflow to highlight PR changes (#32063) 2022-05-17 13:47:17 +12:00
.eslintrc.js Fix and consolidate linting across the monorepo (#35012) 2022-10-12 15:05:01 +13:00
.gitignore CLI tool and GH workflow to highlight PR changes (#32063) 2022-05-17 13:47:17 +12:00
README.md Allow composing code analyzer change detections (hooks, templates, db, schema) (#37161) 2023-03-21 09:36:30 -05:00
index.ts Extract the scanning functionality from code-analyzer, move common code into a separate package (#34600) 2022-09-11 09:55:53 +12:00
package.json Update the @woocommerce/eslint-plugin and fix bugs (#36988) 2023-03-02 11:36:38 +13:00
tsconfig.json Extract the scanning functionality from code-analyzer, move common code into a separate package (#34600) 2022-09-11 09:55:53 +12:00

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 run 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 run analyzer -- --help

  1. 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 run 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.

  1. 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).