Environment information Commands are being run in a <code class="n

🐛 Github Reporter not generating annotations correctly about biome HOT 5 CLOSED

tommoyang commented on June 30, 2024

🐛 Github Reporter not generating annotations correctly

from biome.

Comments (5)

Sec-ant commented on June 30, 2024 2

I think colors is the reason why the annotation doesn't work properly. Here is a working one I tested ~~in my fork~~ (not a fork, the website repo) with biome ci --reporter=github --colors=off using the v1.8.2 biome release, it correctly generated all the annotations.

from biome.

Sec-ant commented on June 30, 2024 1

I think if Github annotations are going to be generated it might be better to force colours off as opposed to setting a flag to explicitly turn them off

I completely agree with you.

One thing is turning colours off also means that the colours for summary details/total are also off:

biome/crates/biome_cli/src/reporter/terminal.rs

Lines 88 to 141 in fc9b1eb

 impl fmt::Display for SummaryDetail { 

 fn fmt(&self, fmt: &mut Formatter) -> io::Result<()> { 

 if self.0 > 0 { 

 fmt.write_markup(markup! { 

 " Fixed "{Files(self.0)}"." 

 }) 

 } else { 

 fmt.write_markup(markup! { 

 " No fixes applied." 

 }) 

 } 

 } 

 } 

 struct SummaryTotal<'a>(&'a TraversalMode, usize, &'a Duration); 

 impl<'a> fmt::Display for SummaryTotal<'a> { 

 fn fmt(&self, fmt: &mut Formatter) -> io::Result<()> { 

 let files = Files(self.1); 

 match self.0 { 

 TraversalMode::Check { .. } | TraversalMode::Lint { .. } | TraversalMode::CI { .. } => { 

 fmt.write_markup(markup! { 

 "Checked "{files}" in "{self.2}"." 

 }) 

 } 

 TraversalMode::Format { write, .. } => { 

 if *write { 

 fmt.write_markup(markup! { 

 "Formatted "{files}" in "{self.2}"." 

 }) 

 } else { 

 fmt.write_markup(markup! { 

 "Checked "{files}" in "{self.2}"." 

 }) 

 } 

 } 

 TraversalMode::Migrate { write, .. } => { 

 if *write { 

 fmt.write_markup(markup! { 

 "Migrated your configuration file in "{self.2}"." 

 }) 

 } else { 

 fmt.write_markup(markup! { 

 "Checked your configuration file in "{self.2}"." 

 }) 

 } 

 } 

 TraversalMode::Search { .. } => fmt.write_markup(markup! { 

 "Searched "{files}" in "{self.2}"." 

 }), 

 } 

 } 

 }

This is not a big deal, but the ideal fix for this should be only switching off colours for the "annotation" part.

I'd like to reopen this as a reminder. Either forcing colours off entirely in this mode, or only keeping annotataions colorless is an acceptable fix.

from biome.

ematipico commented on June 30, 2024 1

I'd like to reopen this as a reminder. Either forcing colours off entirely in this mode, or only keeping annotataions colorless is an acceptable fix.

I think removing colours based on the reporter is the way to go. Keeping annotation colourless feels too complex, and I don't envision future cases where we need such a sophisticated feature.

from biome.

ematipico commented on June 30, 2024

Yeah I have been trying to understand why it hasn't been working properly, and I can't figure out why

from biome.

tommoyang commented on June 30, 2024

Tested, it's also working for me! Thanks for the fix.

I think if Github annotations are going to be generated it might be better to force colours off as opposed to setting a flag to explicitly turn them off, but i'm happy to leave that as just a note and close this issue.

from biome.

🐛 Github Reporter not generating annotations correctly about biome HOT 5 CLOSED

Comments (5)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	impl fmt::Display for SummaryDetail {
	fn fmt(&self, fmt: &mut Formatter) -> io::Result<()> {
	if self.0 > 0 {
	fmt.write_markup(markup! {
	" Fixed "{Files(self.0)}"."
	})
	} else {
	fmt.write_markup(markup! {
	" No fixes applied."
	})
	}
	}
	}
	struct SummaryTotal<'a>(&'a TraversalMode, usize, &'a Duration);

	impl<'a> fmt::Display for SummaryTotal<'a> {
	fn fmt(&self, fmt: &mut Formatter) -> io::Result<()> {
	let files = Files(self.1);
	match self.0 {
	TraversalMode::Check { .. } \| TraversalMode::Lint { .. } \| TraversalMode::CI { .. } => {
	fmt.write_markup(markup! {
	"Checked "{files}" in "{self.2}"."
	})
	}
	TraversalMode::Format { write, .. } => {
	if *write {
	fmt.write_markup(markup! {
	"Formatted "{files}" in "{self.2}"."
	})
	} else {
	fmt.write_markup(markup! {
	"Checked "{files}" in "{self.2}"."
	})
	}
	}

	TraversalMode::Migrate { write, .. } => {
	if *write {
	fmt.write_markup(markup! {
	"Migrated your configuration file in "{self.2}"."
	})
	} else {
	fmt.write_markup(markup! {
	"Checked your configuration file in "{self.2}"."
	})
	}
	}

	TraversalMode::Search { .. } => fmt.write_markup(markup! {
	"Searched "{files}" in "{self.2}"."
	}),
	}
	}
	}