Initial commit

Author: zachkirsch

.github/workflows/compile.yml

@@ -0,0 +1,30 @@
+name: Compile
+
+on:
+  push: { branches: ["main"] }
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  compile:
+    name: Compile
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Compile
+        run: pnpm build

.github/workflows/lint.yml

@@ -0,0 +1,36 @@
+name: Lint
+
+on:
+  push: { branches: ["main"] }
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run eslint
+        run: pnpm lint:eslint
+
+      - name: Run prettier
+        run: pnpm lint:prettier
+
+      - name: Ensure no changes to any files
+        run: git diff --exit-code

.github/workflows/publish.yml

@@ -0,0 +1,46 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+
+      - name: Get version
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/}
+          echo Version: $VERSION
+          echo "VERSION=${VERSION}" >> $GITHUB_ENV
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Compile
+        run: pnpm build
+
+      - name: Update package.json version
+        run: |
+          jq --arg version $VERSION '.version = $version' package.json > package.tmp.json
+          mv package.tmp.json package.json
+          git diff package.json
+
+      - name: Publish
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          pnpm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}"
+          pnpm publish --no-git-checks --access public

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+lib/
+.DS_Store

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "printWidth": 80,
+  "trailingComma": "all"
+}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode"]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "editor.formatOnSave": true
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alex Johansson
+
+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

@@ -0,0 +1,71 @@
+<div align="center">
+  <h1>trpc-postman</h1>
+  <a href="https://www.npmjs.com/package/trpc-postman"><img src="https://img.shields.io/npm/v/trpc-postman.svg?style=flat&color=brightgreen" target="_blank" /></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-black" /></a>
+</div>
+
+---
+
+## Generate an Postman spec from your tRPC server, in one line of code
+
+### Step 1: Install `trpc-postman`
+
+```bash
+# npm
+npm install trpc-postman
+
+# yarn
+yarn install trpc-postman
+
+# pnpm
+pnpm install trpc-postman
+```
+
+### Step 2: Generate Postman Collection
+
+```typescript
+import { trpcToPostmanCollection } from "trpc-postman";
+
+// generate Postman Collection JSON
+const postmanCollection = trpcToPostmanCollection({
+  collectionName: "My API",
+  router: trpcRouter,
+});
+```
+
+## Publishing the Postman Collection
+
+You can update your Postman Collection using your Postman API key and Collection ID
+
+### Step 1: Generate a Postman API key
+
+You can generate a Postman API key [here](https://www.postman.com/settings/me/api-keys).
+
+### Step 2: Get your Colllection ID
+
+If you don't already have a collection to publish to, create a collection manually.
+
+Then, you can see your Collection ID by clicking the `i` button on the right-hand side:
+
+![collection id](./collection-id.png)
+
+### Step 3: Publish collection
+
+> WARNING!! This will ERASE your entire collection with the generated Postman Collection.
+
+```typescript
+import { trpcToPostmanCollection } from "trpc-postman";
+
+// generate Postman Collection JSON
+const postmanCollection = trpcToPostmanCollection({
+  collectionName: "My API",
+  router: trpcRouter,
+});
+
+// overwrite collection in postman
+await updateRemotePostmanCollection({
+  apiKey: POSTMAN_API_KEY,
+  collectionId: YOUR_COLLECTION_ID,
+  collection: postmanCollection,
+});
+```