css-diff-action icon indicating copy to clipboard operation
css-diff-action copied to clipboard

add option to include/exclude metrics in comment

Open bartveneman opened this issue 4 years ago • 0 comments

All projects are different and sometimes I'm not interested in complexity-related metrics, and sometimes I'm not interested in the amount of colors. I'd like an option to specifify which metrics to include or exclude.

Example config with excluding

This would create a table with ALL metrics, except the ones listed in the exclude array.

- name: Project Wallace Diff
  uses: projectwallace/css-diff-action@master
  with:
    project-wallace-token: ${{ secrets.PROJECT_WALLACE_TOKEN }}
    github-token: ${{ secrets.GITHUB_TOKEN }}
    css-path: ./build/style.css
    exclude:
      - 'atrules.fontfaces.unique'
      - 'stylesheets.browserhacks.total'

Example config with inclusion

This would create a table with ONLY the metrics listed in the include array.

- name: Project Wallace Diff
  uses: projectwallace/css-diff-action@master
  with:
    project-wallace-token: ${{ secrets.PROJECT_WALLACE_TOKEN }}
    github-token: ${{ secrets.GITHUB_TOKEN }}
    css-path: ./build/style.css
    include:
      - 'atrules.fontfaces.unique'
      - 'stylesheets.browserhacks.total'

Additional

  • Unknown options should be ignored
  • It would be nice to support configs like *.browserhacks or values.colors.*
  • The diff comment should mention if any metrics are hidden because of this config, and if so, how many of them. Maybe we can add a toggle to display them anyway

bartveneman avatar Mar 29 '20 21:03 bartveneman