Skip to content

Commit 0c76def

Browse files
committed
chore: add concurrently and refine readme
1 parent 0802c69 commit 0c76def

File tree

4 files changed

+321
-29
lines changed

4 files changed

+321
-29
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"typed-string-interpolation": patch
3+
---
4+
5+
Add concurrently and refined README

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# [`typed-string-interpolation`](https://www.npmjs.com/package/typed-string-interpolation)
1+
# `typed-string-interpolation`
22

3-
[String interpolation](https://en.wikipedia.org/wiki/String_interpolation) utility that returns the correct type based on passed in variable substitutions.
3+
[String interpolation](https://en.wikipedia.org/wiki/String_interpolation) utility that returns the correct `TypeScript` type based on passed in variables.
44

55
## Main features
66

@@ -15,9 +15,9 @@
1515

1616
## Motivation
1717

18-
String interpolation/variable substitution (i.e. injecting variables within text) is a really common operation when building single and multilingual applications. Existing string interpolation utilities within the most used `i18n` / `l10n` packages like `i18next` and `formatjs` come with massive overhead while lacking proper TypeScript infer support for the interpolation operation.
18+
String interpolation/variable substitution (i.e. injecting variables within text) is a really common operation when building single and multilingual applications alike. Existing string interpolation utilities within the most used `i18n` / `l10n` packages like `i18next` and `formatjs` come with massive overhead while lacking proper TypeScript infer support for the interpolation operation.
1919

20-
This package aims to provide a high quality string interpolation "primitive" to use as is or within other localization frameworks and tooling.
20+
This utility aims to provide a high quality string interpolation "primitive" to use as is or within other localization frameworks and tooling.
2121

2222
## Getting started
2323

@@ -59,7 +59,7 @@ stringInterpolation("hello {{world}} with {{anything}}", {
5959

6060
## TypeScript support
6161

62-
If the string can be joined you'll get back a `string` type. Otherwise a ` type within an array is returned based on the passed in variables.
62+
If the string can be joined you'll get back a `string` type. Otherwise a `union` type within an array is returned based on the passed in variables.
6363

6464
```ts
6565
stringInterpolation("hello {{world}} with number {{number}}", {
@@ -136,16 +136,15 @@ Easiest way to contribute is to open new issues for API suggestions and bugs.
136136
137137
### Contributing for a release
138138
139-
Steps for contributing through a PR:
139+
Steps for contributing through a pull request:
140140
141141
- Fork `main` on Github and clone fork locally
142-
- `npm ci` to install dependencies
143-
- Make changes while running tests
144-
- Unit test in watch mode:
145-
- `npm run test:unit:watch`
146-
- Unit test for types in watch mode:
147-
- `npm run test:unit:types:watch`
148-
- Once all changes are complete create a new release with [changesets](https://github.com/changesets/changesets)
142+
- Install dependencies
143+
- `npm ci`
144+
- Make changes while running tests in watch mode
145+
- `npm run test:unit:all:watch`
146+
- Once all changes are complete, create a new release with [changesets](https://github.com/changesets/changesets)
149147
- `npm run changeset`
150148
- Commit and push changes to fork
151149
- Open a pull request against the fork
150+
- If the PR needs changes before a merge to `main` can be made, push more changes to the fork until the PR is approved

0 commit comments

Comments
 (0)