magtools/m2-core

Core Module

0.1.5 2024-09-07 15:38 UTC

Requires

• magento/framework: *

Apache-2.0

• Martin Gonzalez

• magento2

README

Magento 2 core module

codeanalyzer.sh

Copy the devops/codeanalyzer.sh file to the magento root and perform fast static code reviews. You also need to copy the devops/TestPR.xml ruleset file to app/devops/TestPr.xml to use option 4 and bitbucket pipeline.

$ bash codeanalyzer.sh

There are 3 available tools
1) phpcs
2) phpcbf
3) phpmd
4) testPR
5) HELP
which tool do you want to use? 3
you selected phpmd!

There are 5 available paths to process
1) app/code/Example/Core/    
2) app/code/Example/Setup/    
3) app/design/frontend/Example/  
4) app/design/adminhtml/Example/ 
5) extensions/magtools/
which path do you want to process? 1
you selected app/code/Example/Core/!

Processed path app/code/Example/Core/ with phpmd, you can find the output in var/static/phpmd_Example_Core.txt

path extensions

The codeanalizer.sh utility references to an extensions path, this is an optional path for local composer repository.

"repositories": [
    {
        "type": "composer",
        "url": "https://repo.magento.com/"
    },
    {
        "type": "path",
        "url": "extensions/*/*",
        "options": {
            "symlink": true
        }
    }
],

Example:

[vendor]/[project] = composer.json package name
extensions/[vendor]/[project] or extensions/magtools/m2-core     

devdump.sh

This is a dump script that do not export sensitive data from certain tables. You can find this file on devops folder.

Configure:

HOST="localhost"
USER="root"
PASSWORD="password"
PORT="3306"

Usage:

$ bash devdump.sh dbname 
$ bash devdump.sh dbname compact #no sales info

bitbucket-pipelines.yml

This is a pipeline for bitbucket that runs on pull requests create/update events running code analysis tools. You will find this file on devops/bitbucket-pipelines.yml, also need to copy the devops/TestPR.xml ruleset file to app/devops/TestPr.xml to use bitbucket pipeline and codeanalyzer.sh option 4.