ModusCreateOrg / ModusCreateOrg/gimbal

.gimbalrc.yml in root folder being ignored

Open
#160 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
TypeScript
Stars
116
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
The lighthouse audit thresholds set in my .gimbalrc.yml seem to be ignored when running the audit command, and command gimbal audit runs and produces a report but exits with an error:
error Command failed with exit code 1. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

To Reproduce

install dev dependencies:
"devDependencies": {
"@modus/gimbal": "^1.2.6",
"@modus/gimbal-plugin-axe": "^1.2.6",
"@modus/gimbal-plugin-last-value": "^1.2.6",
"@modus/gimbal-plugin-sqlite": "^1.2.6"
}

test script before setting up .gimbalrc.yml

"scripts": {
"gimbal-audit": "gimbal audit"
}

run script:
yarn run gimbal-audit

OUTPUT:
Label │ Value │ Threshold │ Success │
│ Size Checks [ success: ✓ ]│
│ Heap Snapshot Checks [ success: x ] │
│ Documents │ 3 │ 5 │ ✓ │
│ Frames │ 1 │ 2 │ ✓ │
│ JSHeapTotalSize │ 23199744 │ │ ✓ │
│ JSHeapUsedSize │ 15893968 │ │ ✓ │
│ LayoutCount │ 2 │ 5 │ ✓ │
│ Nodes │ 1381 │ 75 │ x │
│ RecalcStyleCount │ 4 │ 6 │ ✓ │
│ Unused Source Checks [ success: x ] │
│ http://localhost:3000/ │ 68.63% │ 65% │ x │
│ ... p://localhost:3000/static/css/2.b31c041a.chunk.css │ 100.00% │ 35% │ x │
│ ... /localhost:3000/static/css/main.3d2bbf6e.chunk.css │ 89.62% │ 35% │ x │
│ http://localhost:3000/ │ 23.33% │ 30% │ ✓ │
│ ... ttp://localhost:3000/static/js/2.b80883ac.chunk.js │ 69.57% │ 70% │ ✓ │
│ ... ://localhost:3000/static/js/main.aae40300.chunk.js │ 53.01% │ 15% │ x │
│ Lighthouse Audits [ success: x ]│
│ Performance │ 0 │ 50 │ x │
│ Accessibility │ 79 │ 75 │ ✓ │
│ Best Practices │ 100 │ 95 │ ✓ │
│ SEO │ 82 │ 90 │ x │
│ Progressive Web App │ 28 │ 50 │ x │

error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Add .gimbalrc.yml to root folder of project

The .gimbalrc.yml is configured by default from here,
changes include;

  • lighthouse audit thresholds changed to 95
  • output directory changed to folder in source folder.

Run script:
yarn run gimbal-audit

OUTPUT:
Same results as above with same error.

Expected behaviour
I am expecting my lighthouse audit thresholds to all be 95 and for the script to run, produce a report without an error.

Screenshots
image

.gimbalrc.yml
image

Desktop (please complete the following information):

  • OS: [Windows 10]
  • Browser [Firefox]
  • Version 69.0.3 (64-bit)

Additional context
Due to the .gimbalre.yml being ignored there is no output in the artifacts folder.
I suspect this is more a me issue than a gimbal issue but I was not able to find many answers online so I wanted to raise an issue with the source :-)

I am pretty excited about having this setup, and once this small issue is clarified I am looking to add a github action 😃
Please let me know if i need to provide any further information.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with the root .gimbalrc.yml and yarn run gimbal-audit, then trace how the gimbal audit command discovers and loads its configuration. Verify whether the configured Lighthouse thresholds and output directory are applied, and confirm the expected report and exit behavior once the configuration is honored.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, performance
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.