initial commit

Author: vanska

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/quick-bees-destroy.md

@@ -0,0 +1,5 @@
+---
+"typed-string-interpolation": patch
+---
+
+Initial commit

.github/workflows/main.yml

@@ -0,0 +1,17 @@
+name: CI
+on:
+  push:
+    branches:
+      - "**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: "npm"
+      - run: npm ci
+      - run: npm run lint && npm run test && npm run build

.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - "main"
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          # This expects you to have a script called release which does a build for your packages and calls changeset publish
+          publish: npm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.SCOPED_GH_PAT_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.nvmrc

@@ -0,0 +1 @@
+18

README.md

@@ -0,0 +1,138 @@
+# Typed string interpolation
+
+[String interpolation](https://en.wikipedia.org/wiki/String_interpolation) utility that returns the correct type based on passed in variable substitutions.
+
+## Main features
+
+- Replaces variables within a string with passed in variables
+- 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!
+
+## Install
+
+```bash
+npm i typed-string-interpolation
+```
+
+## Usage
+
+```ts
+// ES module
+import { stringInterpolation } from "typed-string-interpolation"
+// CommonJS
+const { stringInterpolation } = require("typed-string-interpolation")
+```
+
+```ts
+stringInterpolation("hello {{world}}", {
+  world: "world",
+}) // "hello world"
+```
+
+Pass in anything you want an get back sane results when interpolation result shouldn't be turned into a `string`:
+
+```tsx
+stringInterpolation("hello {{world}} with {{anything}}", {
+  world: "world",
+  anything: <span className="bold">anything</span>,
+})
+```
+
+Returns an array for easy use with libraries like `react` or anything else!
+
+```tsx
+const interpolationResult = [
+  "hello ",
+  "world",
+  " with ",
+  <span className="bold">anything</span>,
+]
+```
+
+## TypeScript support
+
+If the string can be joined you'll get back a string. Otherwise a union type within an array is returned based on the passed in variables.
+
+```ts
+stringInterpolation("hello {{world}} with number {{number}}", {
+  world: "world",
+  number: 1,
+}) // => Returns type: string
+```
+
+```tsx
+stringInterpolation("hello {{world}} with number {{number}}", {
+  world: <span className="bold">world</span>,
+  number: 1,
+}) // => Returns type: (string | JSX.Element | number)[]
+```
+
+## Options
+
+Takes in an optional third parameter for options:
+
+```js
+stringInterpolation(str, variables, options)
+```
+
+```ts
+type Options = {
+  raw?: boolean // default: false
+  pattern?: RegExp // default: new RegExp(/\{{([^{]+)}}/g)
+  sanity?: boolean // default: true
+}
+```
+
+`raw`
+
+Return the raw interpolation results without joining to string when you want full control for some reason.
+
+```tsx
+stringInterpolation(
+  "hello {{world}} with number {{number}}",
+  {
+    world: "world",
+    number: 1,
+  },
+  { raw: true }
+) // => Returns type: (string | number)[]
+```
+
+`pattern`
+
+Provide your own `RegExp` pattern for variable matching. Must be defined as:
+
+```ts
+pattern: new RegExp(/\{{([^{]+)}}/g)
+```
+
+`sanity`
+
+If you want to live dangerously, sanity checking can be turned off.
+
+```ts
+{
+  sanity: false
+}
+```
+
+Turning of sanity checking removes `throw` from:
+
+- empty string
+- string variables and passed in variables count mismatch
+- missing variables
+
+## Contributing
+
+API suggestions are welcome and greatly appreciated.
+
+Basic steps for contributing for a release:
+
+- Fork `main`
+- `npm ci`
+- Run tests `npm run test`
+- Create a changeset with `npx changeset`
+- Commit and push changes
+- Open a pull request

babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ["@babel/preset-env", { targets: { node: "current" } }],
+    "@babel/preset-typescript",
+  ],
+}

jest.config.ts

@@ -0,0 +1,8 @@
+import type { Config } from "jest"
+
+const config: Config = {
+  verbose: true,
+  testMatch: ["<rootDir>/src/__tests__/*.ts"],
+}
+
+export default config

jest.config.tsd.js

@@ -0,0 +1,8 @@
+module.exports = {
+  displayName: {
+    color: "blue",
+    name: "types",
+  },
+  runner: "jest-runner-tsd",
+  testMatch: ["**/__typetests__/*.test.ts*"],
+}