Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md#L57-L60 No comment detected in first line for block with extension yaml #106

Open
cmoulliard opened this issue Aug 7, 2024 · 2 comments

Comments

@cmoulliard
Copy link

Issue

The command npx embedme README.md reports top of my README.md file that no comments exist

Embedding...
Skipped 0 files ignored in '.gitignore'
  Analysing README.md...
   README.md#L20-L22 No comment detected in first line for block with extension bash
   README.md#L28-L39 No comment detected in first line for block with extension bash
   README.md#L41-L43 No comment detected in first line for block with extension bash
   README.md#L57-L60 No comment detected in first line for block with extension yaml
   README.md#L62-L64 No comment detected in first line for block with extension bash
   README.md#L66-L90 No comment detected in first line for block with extension yaml
   README.md#L93-L111 No comment detected in first line for block with extension bash
   README.md#L113-L256 No comment detected in first line for block with extension yaml
   README.md#L261-L289 No comment detected in first line for block with extension bash
   README.md#L291-L649 No comment detected in first line for block with extension yaml
   README.md#L653-L663 No comment detected in first line for block with extension bash
   README.md#L668-L675 No comment detected in first line for block with extension bash
   README.md#L677-L690 No comment detected in first line for block with extension bash
  No changes to write for README.md

while the comment is well defined

##### Simple pipeline with script embedded

```yaml
// configurations/tekton/simple-job-embedded-script-cfg.yaml

I'm using the following version of the tool: 1.22.1

@zakhenry
Copy link
Owner

zakhenry commented Aug 7, 2024

the library expects comment formatting to match the format of the language being embedded, so in this case if you substitute // with # it should work for yaml files.

@cmoulliard
Copy link
Author

Such a feature is not documented at all as all the examples use // ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants