openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

Bump jmustache 1.15 -> 1.16

Open bachorp opened this issue 6 months ago • 0 comments

Superseeds https://github.com/OpenAPITools/openapi-generator/pull/19575, resolves https://github.com/OpenAPITools/openapi-generator/issues/20375.

I applied the following logic to adjust our templates to jmustache's changed semantics.

import re
from pathlib import Path

for file in filter(
    lambda p: p.is_file()
    and not p.name.endswith(".jar.mustache")
    and not p.name.endswith(".war.mustache"),
    Path("modules/openapi-generator/src/main/resources").glob("**/*.mustache"),
):
    # I don't know how jmustache behaves with trailing whitespace, but this does not occur.
    assert not re.match(r"^ *\{\{>[^\}]+\}\} +$",
                        file.read_text(), flags=re.MULTILINE)
    file.write_text(
        # add comment to avoid standalone mode
        re.sub(
            r"^ +\{\{>[^\}]+\}\}$",
            lambda m: m.group(0) + "{{! prevent indent}}",
            # add newline to non-indented standalones (except at start of file)
            re.sub(
                r"^\{\{>[^\}]+\}\}\n",
                lambda m: m.group(0) if m.start(0) == 0 else m.group(0) + "\n",
                file.read_text(),
                flags=re.MULTILINE,
            ),
            flags=re.MULTILINE,
        )
    )

PR checklist

  • [x] Read the contribution guidelines.
  • [x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL) Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [x] File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

bachorp avatar May 29 '25 19:05 bachorp