Map output file to content file inside a custom check?

[jmf...@gmail.com]

Inside a custom nanoc check I built, I would like the error message to point to the input file that contains the problem, not just the output file. 

There is a collection of @items available inside the checks, as well as the "output_filenames" collection but there does not seem to be an easy way to get a mapping from one to the other? I was hoping to use @item.path or something. I assume nanoc has that information somewhere in its innards. Am I overlooking something?

[Denis Defreyne]

Hey Jan,

That information is indeed (mostly) available. Here is an example check that bases itself off @items:

Nanoc::Check.define(:sample) do

  all_item_reps = @items.flat_map { |i| i.reps.to_a }

  all_item_reps.each do |rep|

    path = rep.raw_path

    next unless path # some reps have no paths (are not written)

    add_issue(

      "something is rotten",

      subject: "#{path} --- #{rep.item.identifier}",

    )

  end

end

There is one limitation here: it only looks at the :default snapshot of item representations. That is fine if you 1) don’t have rules that have multiple `write` instructions, and 2) don’t have routing rules that apply to specific non-default snapshots.

There is currently no way to request the list of snapshot names of an item representation. I’ll look into making that possible. Then, the code would look like this:

  all_item_reps.each do |rep|

    # DOES NOT WORK YET:

    rep.snapshot_names.each do |snapshot_name|

      path = rep.raw_path(snapshot: snapshot_name)

      next unless path # some reps have no paths (are not written)

Hope this helps,

Denis Defreyne

[dəˈni] • pronouns: he/him

+49 (0) 1573 1969 173

he...@denisdefreyne.com

https://denisdefreyne.com

On 2025-11-26 at 22:19, jmf...@gmail.com wrote:

Inside a custom nanoc check I built, I would like the error message to point to the input file that contains the problem, not just the output file. 

There is a collection of @items available inside the checks, as well as the "output_filenames" collection but there does not seem to be an easy way to get a mapping from one to the other? I was hoping to use @item.path or something. I assume nanoc has that information somewhere in its innards. Am I overlooking something?

--

You received this message because you are subscribed to the Google Groups "nanoc" group.

To unsubscribe from this group and stop receiving emails from it, send an email to nanoc+un...@googlegroups.com.

To view this discussion visit https://groups.google.com/d/msgid/nanoc/d82e7fd5-0ace-49d6-9fa2-53d2c2b0eda3n%40googlegroups.com.

[jmf...@gmail.com]

Thanks, I'll give that a try. Not sure why ChatGPT wasn't able to tell me that :-)