Finalizing package

Author: vanska

.changeset/young-trainers-cheer.md

@@ -0,0 +1,5 @@
+---
+"typed-string-interpolation": patch
+---
+
+Finalizing package

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 Mikko Vänskä
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-# Typed string interpolation
+# `typed-string-interpolation`
 
 [String interpolation](https://en.wikipedia.org/wiki/String_interpolation) utility that returns the correct type based on passed in variable substitutions.
 
@@ -8,15 +8,26 @@
 - Sanity checks that correct variables were passed in
 - Returns the correct type based on passed in variable substitutions
 - Options to customize return, pattern matching and sanity checking
-- Both `.cjs` and `mjs` distributions available. Use anywhere!
+- Both ES Module `.mjs` and CommonJS `.cjs` distributions available. Use anywhere!
+- Tiny footprint:
+  - ES Module: `0.462kB` (`773B` unpacked)
+  - CommonJS: `0.833B` (`1.75kB` unpacked)
 
-## Install
+## Motivation
+
+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 thing like proper TypeScript infer support for the interpolation operation.
+
+This package aims to provide a high quality string interpolation "primitive" to use as is or within other localization frameworks and tooling.
+
+## Getting started
+
+### Install
 
 ```bash
 npm i typed-string-interpolation
 ```
 
-## Usage
+### Usage
 
 ```ts
 // ES module
@@ -59,14 +70,14 @@ If the string can be joined you'll get back a string. Otherwise a union type wit
 stringInterpolation("hello {{world}} with number {{number}}", {
   world: "world",
   number: 1,
-}) // => Returns type: string
+}) // : string
 ```
 
 ```tsx
 stringInterpolation("hello {{world}} with number {{number}}", {
   world: <span className="bold">world</span>,
   number: 1,
-}) // => Returns type: (string | JSX.Element | number)[]
+}) // : (string | JSX.Element | number)[]
 ```
 
 ## Options
@@ -97,7 +108,7 @@ stringInterpolation(
     number: 1,
   },
   { raw: true }
-) // => Returns type: (string | number)[]
+) // : (string | number)[]
 ```
 
 `pattern`
@@ -126,13 +137,20 @@ Turning of sanity checking removes `throw` from:
 
 ## Contributing
 
-API suggestions are welcome and greatly appreciated.
+Easiest way to contribute is to open new issues for API suggestions and fixes.
+
+### Contributing for a release
 
 Basic steps for contributing for a release:
 
-- Fork `main`
-- `npm ci`
-- Run tests `npm run test`
-- Create a changeset with `npx changeset`
+- Fork `main` on Github and clone fork locally
+- `npm ci` to install dependencies
+- Make changes while running tests
+  - Unit test in watch mode:
+    - `npm run test:unit:watch`
+  - Unit test for types in watch mode:
+    - `npm run test:unit:types:watch`
+- Once all changes are complete create a new release with changeset
+  - `npm run changeset`
 - Commit and push changes
-- Open a pull request
+- Open a pull request for the fork

package.json

@@ -1,6 +1,7 @@
 {
   "name": "typed-string-interpolation",
   "description": "String interpolation with correct return type based on passed variable substitutions",
+  "author": "Mikko Vänskä",
   "license": "MIT",
   "version": "0.0.2",
   "main": "dist/index.js",
@@ -10,13 +11,22 @@
   "keywords": [
     "string",
     "interpolation",
+    "substitution",
+    "injection",
     "replace",
+    "inject",
+    "substitute",
+    "interpolate",
     "variable",
     "variables",
     "type",
     "typed",
     "infer",
-    "type-safe"
+    "type-safe",
+    "i18n",
+    "l10n",
+    "i18next",
+    "formatjs"
   ],
   "scripts": {
     "lint": "tsc",
@@ -26,7 +36,8 @@
     "test:unit:types:watch": "jest -c jest.config.tsd.js --watch",
     "test": "npm run test:unit && npm run test:unit:types",
     "build": "tsup src/index.ts --format cjs,esm --dts",
-    "release": "npm run build && changeset publish"
+    "release": "npm run build && changeset publish",
+    "changeset": "changeset"
   },
   "devDependencies": {
     "@babel/core": "^7.20.12",

tsconfig.json

@@ -1,13 +1,11 @@
 {
   "compilerOptions": {
-    "target": "es2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "target": "ES2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
     "module": "commonjs" /* Specify what module code is generated. */,
-    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing 
+    "noEmit": true /* Disable emitting files from a compilation. */,
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
     "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-    "strict": true /* Enable all strict type-checking options. */,
-    /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true /* Skip type checking all .d.ts files. */,
-    "noUncheckedIndexedAccess": true,
-    "noEmit": true
-  }
+    "strict": true /* Enable all strict type-checking options. */
+  },
+  "exclude": ["dist", "node_modules"]
 }