Skip to content

Commit

Permalink
chore(insert-description): Add the npm script insert:description
Browse files Browse the repository at this point in the history
  • Loading branch information
parmentf committed Feb 6, 2024
1 parent 4c1c231 commit 6aceeb1
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 1 deletion.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,23 @@ Exemples:
./bin/insert-description.sh services/terms-extraction/v1_teeft_fr.md
```

Alternative: utiliser le script npm `insert:description`:

```bash
$ npm run insert:description services/terms-extraction/v*.md

> [email protected] insert:description
> ./bin/insert-description.sh services/terms-extraction/v1_teeft_en.md services/terms-extraction/v1_teeft_fr.md services/terms-extraction/v1_teeft_with-numbers_en.md services/terms-extraction/v1_teeft_with-numbers_fr.md

- services/terms-extraction/v1/teeft/en.ini ✓
- services/terms-extraction/v1/teeft/fr.ini ✓
- services/terms-extraction/v1/teeft/with-numbers/en.ini ✓
- services/terms-extraction/v1/teeft/with-numbers/fr.ini ✓
```

> **Note**: si vous voulez bénéficier de l'auto-complétion des chemins de
> fichiers, utilisez plutôt `./bin/insert-description.sh`.
## Développement

### Sans docker
Expand Down
24 changes: 24 additions & 0 deletions SCRIPTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Available scripts:
- generate:example-tests
- generate:service
- help
- insert:description
- publish
- update:images
- test:local
Expand Down Expand Up @@ -59,6 +60,29 @@ Help is colorized if you have `bat` installed.

See <https://github.com/sharkdp/bat>.

## insert:description

Usage: `npm run insert:description services/service-name/v1_path.md`

Insert the Markdown description of a route into the matching `.ini` metadata
(`post.description`).
Convert multiline markdown into one-line metadata (using `^M` character).
Replace the `_` character in the markdown files names with `/`, to match the path of the `.ini`s to be modified.

Example:

```bash
$ npm run insert:description services/terms-extraction/v*.md

> [email protected] insert:description
> ./bin/insert-description.sh services/terms-extraction/v1_teeft_en.md services/terms-extraction/v1_teeft_fr.md services/terms-extraction/v1_teeft_with-numbers_en.md services/terms-extraction/v1_teeft_with-numbers_fr.md

- services/terms-extraction/v1/teeft/en.ini ✓
- services/terms-extraction/v1/teeft/fr.ini ✓
- services/terms-extraction/v1/teeft/with-numbers/en.ini ✓
- services/terms-extraction/v1/teeft/with-numbers/fr.ini ✓
```

## publish

Usage: `npm run publish`
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"generate:example-tests": "node bin/generate-example-tests.mjs",
"generate:service": "./bin/create-service-from-template.sh",
"help": "bat SCRIPTS.md || cat SCRIPTS.md",
"insert:description": "./bin/insert-description.sh",
"publish": "./bin/publish.sh",
"update:images": "./bin/update-images.sh",
"test": "echo \"Error: no test specified\" && exit 1",
Expand Down Expand Up @@ -51,4 +52,4 @@
"devDependencies": {
"@types/node": "20.11.16"
}
}
}

0 comments on commit 6aceeb1

Please sign in to comment.