imagej / imagej/imagej.github.io

Add automated check for broken include templates

Open
#115 0 comments 0 reactions 0 assignees View on GitHub
cleanup
Dominant language
JavaScript
Stars
30
Forks
203
Avg merge
1h 50m
Merged PRs (30d)
1

Description

As noted in #114 it seems like putting an include that dumps html on a line with content can result in escaped html.

Cases where this occurs seem unintentional and we may want to catch and warn about them automatically, at least.

Note that whitespace-ignoring includes can actually make things worse in this, e.g.

```
here is some text {%- include my include -%}

## Here is some markdown
```

Will result in a rendering that also escapes the later markdown, i.e.:
```
here is some text ## Here is some markdown
```

Contributor guide

No contributing guide indexed for this repository

Research direction

No file, test, or entry point is named. Start by locating the repository's existing include or template validation, then reproduce the inline include example and define a warning for cases that cause later HTML or Markdown to be escaped. Done means the problematic pattern is detected automatically without changing valid whitespace-ignoring includes.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.