General question usage

[madelaney]

On Mac OS, using v5.3.1, I'm running into an issue where I always get the following error:

Error: InvalidConfig { message: "no header source found in config", loc: Location { file: "/Users/mdelaney/.cargo/registry/src/index.crates.io-6f17d22bba15001f/hawkeye-fmt-5.3.1/src/processor.rs", line: 74, column: 64 } }
Exit 1

I'm invoking using hawkeye format --config licenserc.toml and the following gist as the config - https://gist.github.com/madelaney/92a3d6c11ff7b699a8f32db7216f5ee0

Everything seems to be there but I'm not sure why it's failing.

[tisonkun]

This is a bug.

Sorry, I missed this path during the migration.

Here is a fix - #136.

[tisonkun]

v5.3.2 released with this supported.

@madelaney This seems a template of BSD. I wonder if a -

headerID = "BSD-3-Clause" # SPDX ID

a good experience for you.

[madelaney]

Awesome, I pulled the new version and it works as expected. Thank you for the quick turnaround. ☕

[madelaney]

v5.3.2 released with this supported.

@madelaney This seems a template of BSD. I wonder if a -

headerID = "BSD-3-Clause" # SPDX ID

a good experience for you.

Sorry, I don't understand the context. Could you explain more?

[tisonkun]

Currently, we have two methos to configure the content of header template: inlineHeader and headerPath.

We bundled Apache-2.0.txt and Apache-2.0-ASF.txt so that headerPath = "Apache-2.0.txt" can match even if users do not have such file in workdir.

Your situation seems suitable to add a new bundled "BSD-3-Clause.txt" file. And I wonder if we should introduce a new concept "headerId".

After some more consideration, I prefer to keep use the headerPath with bundled ones way. So if you'd like to make BSD-3-Clause a bundled template, you can add it to https://github.com/korandoru/hawkeye/tree/main/fmt/src/license and modify:

hawkeye/fmt/src/license/mod.rs

Lines 55 to 65 in 6a159b1

	pub fn bundled_headers(name: &str) -> Option<HeaderSource> {
	match name {
	"Apache-2.0.txt" => Some(HeaderSource {
	content: include_str!("Apache-2.0.txt").to_string(),
	}),
	"Apache-2.0-ASF.txt" => Some(HeaderSource {
	content: include_str!("Apache-2.0-ASF.txt").to_string(),
	}),
	_ => None,
	}
	}

Also I think the bundled ones should take lower priority to user configured ones.