magento-coding-standard icon indicating copy to clipboard operation
magento-coding-standard copied to clipboard

Warnings on well formatted GraphQL files

Open p-makowski opened this issue 1 year ago • 2 comments

Preconditions

The bug is reproducible in custom Magento modules that have schema.graphqls files written in readable manner, so e.g. with new line breaks or indentation.

A rule that those not work well with well formatted files is Magento2.GraphQL.ValidTypeName.NotCamelCaps.

Steps to reproduce

  1. Create a well formatted schema.graphqls file or fix it with Prettier
type CartCampaign
    @doc(
        description: "CartCampaign returns the discount amount set in the quote"
    ) {
    full_discount_amount: Float
}
  1. Run code sniffer vendor/bin/phpcs -s schema.graphqls

Expected result

No warnings discovered.

Actual result

------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNINGS AFFECTING 2 LINES
------------------------------------------------------------------------------------------------------------------------
  1 | WARNING | Type name "CartCampaign
    |         | " is not in PascalCase format (Magento2.GraphQL.ValidTypeName.NotCamelCaps)
------------------------------------------------------------------------------------------------------------------------

p-makowski avatar Sep 13 '23 18:09 p-makowski

Hi @p-makowski. Thank you for your report. To speed up processing of this issue, make sure that you provided sufficient information. Add a comment to assign the issue: @magento I am working on this


Join Magento Community Engineering Slack and ask your questions in #github channel.

m2-assistant[bot] avatar Sep 13 '23 18:09 m2-assistant[bot]

@magento I am working on this

p-makowski avatar Sep 13 '23 18:09 p-makowski