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/README.md

32 lines
1.5 KiB
Markdown
Raw Normal View History

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
Currently there are just 2 commands:
Extract the scanning functionality from code-analyzer, move common code into a separate package (#34600) Also add contributor command and auto tagging to release-post-generator (#34608)
2022-09-10 21:55:53 +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 GH actions `set-output`.
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
Extract the scanning functionality from code-analyzer, move common code into a separate package (#34600) Also add contributor command and auto tagging to release-post-generator (#34608)
2022-09-10 21:55:53 +00:00
`pnpm run 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).
Extract the scanning functionality from code-analyzer, move common code into a separate package (#34600) Also add contributor command and auto tagging to release-post-generator (#34608)
2022-09-10 21:55:53 +00:00
To find out more about the other arguments to the command you can run `pnpm run 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
Extract the scanning functionality from code-analyzer, move common code into a separate package (#34600) Also add contributor command and auto tagging to release-post-generator (#34608)
2022-09-10 21:55:53 +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
Extract the scanning functionality from code-analyzer, move common code into a separate package (#34600) Also add contributor command and auto tagging to release-post-generator (#34608)
2022-09-10 21:55:53 +00:00
`pnpm run 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`.