add readme badges

dmno-dev · Aug 19, 2024 · 0ba81f7 · 0ba81f7
1 parent 93bf6f5
commit 0ba81f7
Show file tree

Hide file tree

Showing 26 changed files with 163 additions and 61 deletions.
diff --git a/.changeset/odd-chefs-live.md b/.changeset/odd-chefs-live.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# DMNO
+# DMNO [![npm](https://img.shields.io/npm/v/dmno?label=dmno)](https://www.npmjs.com/package/dmno)
 
 >Full-stack configuration & secrets.
 >Batteries included.

diff --git a/example-repo/.dmno/config.mts b/example-repo/.dmno/config.mts
@@ -28,8 +28,6 @@ const EncryptedVaultSecrets = new EncryptedVaultDmnoPlugin('vault/prod', {
 //   name: 'dev',
 // });
 
-
-
 export default defineDmnoService({
   name: 'root',
   isRoot: true,

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -1,6 +1,6 @@
-# DMNO Core
+# DMNO Core [![npm](https://img.shields.io/npm/v/dmno?label=dmno)](https://www.npmjs.com/package/dmno)
 
-Welcome to `dmno-core` which powers `dmno`, and currently includes the config engine, CLI, and associated tools. 
+Welcome to `dmno` (core) which powers `dmno`, and currently includes the config engine, CLI, and associated tools. 
 
 Check out the [docs](https://dmno.dev/docs) for more information on how to use DMNO.
 

diff --git a/packages/docs-site/astro.config.ts b/packages/docs-site/astro.config.ts
@@ -63,6 +63,7 @@ export default defineConfig({
         ThemeProvider: './src/components/CustomStarlightThemeProvider.astro',
         MobileMenuFooter: './src/components/CustomStarlightMobileMenuFooter.astro',
         Banner: './src/components/CustomStarlightBanner.astro',
+        PageTitle: './src/components/CustomStarlightPageTitle.astro',
       },
       head: [
         {

diff --git a/packages/docs-site/src/components/CustomStarlightPageTitle.astro b/packages/docs-site/src/components/CustomStarlightPageTitle.astro
@@ -0,0 +1,35 @@
+---
+// import { PAGE_TITLE_ID } from  "@astrojs/starlight/constants";
+import type { Props } from "@astrojs/starlight/props";
+
+// not acutally exported...?
+const PAGE_TITLE_ID = '_top';
+
+---
+
+<div>
+  <h1 id={PAGE_TITLE_ID}>
+    {Astro.props.entry.data.title}
+    {Astro.props.entry.data.npmPackage && <div class="page-title-badges">
+      <a href=`https://www.npmjs.com/package/${Astro.props.entry.data.npmPackage}`>
+        <img src=`https://img.shields.io/npm/v/${Astro.props.entry.data.npmPackage}?label=${encodeURIComponent(Astro.props.entry.data.npmPackage)}&color=9B55F5` />
+      </a>
+    </div>}
+  </h1>
+</div>
+
+<style>
+	h1 {
+		margin-top: 1rem;
+		font-size: var(--sl-text-h1);
+		line-height: var(--sl-line-height-headings);
+		font-weight: 600;
+		color: var(--sl-color-white);
+	}
+  .page-title-badges {
+    margin-top: 8px;
+    &:empty {
+      display: none;
+    }
+  }
+</style>
diff --git a/packages/docs-site/src/content/config.ts b/packages/docs-site/src/content/config.ts
@@ -1,9 +1,15 @@
-import { defineCollection } from 'astro:content';
+import { defineCollection, z } from 'astro:content';
 import { docsSchema } from '@astrojs/starlight/schema';
 import { blogSchema } from 'starlight-blog/schema';
 
 export const collections = {
   docs: defineCollection({
-    schema: docsSchema({ extend: (context) => blogSchema(context) }),
+    schema: docsSchema({
+      extend: (context) => (
+        blogSchema(context).merge(z.object({
+          npmPackage: z.string().optional(),
+        }))
+      ),
+    }),
   }),
 };
diff --git a/packages/docs-site/src/content/docs/docs/integrations/astro.mdx b/packages/docs-site/src/content/docs/docs/integrations/astro.mdx
@@ -1,6 +1,7 @@
 --- 
 title: Astro Integration
 description: Use DMNO to manage your Astro app's environment variables for static, hybrid, and server-side rendering.
+npmPackage: "@dmno/astro-integration"
 ---
 
 import AstroLogo from "~icons/logos/astro";

diff --git a/packages/docs-site/src/content/docs/docs/integrations/nextjs.mdx b/packages/docs-site/src/content/docs/docs/integrations/nextjs.mdx
@@ -1,6 +1,7 @@
 ---
 title: Next.js
 description: Use DMNO to manage your Next.js app's environment variables for static, hybrid, and server-side rendering.
+npmPackage: "@dmno/nextjs-integration"
 ---
 
 import { Tabs, TabItem } from '@astrojs/starlight/components'

diff --git a/packages/docs-site/src/content/docs/docs/integrations/node.mdx b/packages/docs-site/src/content/docs/docs/integrations/node.mdx
@@ -9,7 +9,7 @@ While Node.js recently added [native support for loading dotenv files](https://n
 
 
 ## Setup
-To get started, install `dmno` and then set up your config schema according to the [schema guide](/docs/guides/schema/). 
+To get started, install `dmno` and then set up your config schema according to the [schema guide](/docs/guides/schema/). **No additional integration-specific package is needed!**
 
 <TabbedCode packageName="dmno" />
 

diff --git a/packages/docs-site/src/content/docs/docs/integrations/remix.mdx b/packages/docs-site/src/content/docs/docs/integrations/remix.mdx
@@ -1,6 +1,7 @@
 ---
 title: Remix
 description: Use DMNO to manage your Remix app's environment variables for static, hybrid, and server-side rendering.
+npmPackage: "@dmno/remix-integration"
 ---
 
 import { Tabs, TabItem } from '@astrojs/starlight/components'

diff --git a/packages/docs-site/src/content/docs/docs/integrations/vite.mdx b/packages/docs-site/src/content/docs/docs/integrations/vite.mdx
@@ -1,6 +1,7 @@
 ---
 title: Vite
 description: Use DMNO to add type safety and validation to your Vite project's configuration. 
+npmPackage: "@dmno/vite-integration"
 ---
 
 import TabbedCode from '@/components/TabbedCode.astro';

diff --git a/packages/docs-site/src/content/docs/docs/platforms/netlify.mdx b/packages/docs-site/src/content/docs/docs/platforms/netlify.mdx
@@ -1,6 +1,7 @@
 --- 
 title: Using DMNO with Netlify
 description: Use DMNO while deploying on Netlify
+npmPackage: "@dmno/netlify-platform"
 ---
 
 import AstroLogo from "~icons/logos/astro";

diff --git a/packages/docs-site/src/content/docs/docs/platforms/vercel.mdx b/packages/docs-site/src/content/docs/docs/platforms/vercel.mdx
@@ -1,6 +1,7 @@
 --- 
 title: Using DMNO with Vercel
 description: Use DMNO while deploying on Vercel
+npmPackage: "@dmno/vercel-platform"
 ---
 
 import VercelLogo from "~icons/logos/vercel";

diff --git a/packages/docs-site/src/content/docs/docs/plugins/1password.mdx b/packages/docs-site/src/content/docs/docs/plugins/1password.mdx
@@ -1,6 +1,7 @@
 ---
 title: 1Password plugin
 description: DMNO's 1Password plugin allows you to securely access your stored secrets in 1Password.
+npmPackage: "@dmno/1password-plugin"
 ---
 
 import { Steps, Icon } from '@astrojs/starlight/components';
@@ -158,14 +159,27 @@ export default defineDmnoService({
     OP_TOKEN: {
       extends: OnePasswordTypes.serviceAccountToken,
     },
-+    SOME_SECRET_ITEM: {
++    SOME_API_KEY: {
 +      sensitive: true,
 +      value: OnePassBackend.item(),
 +    }
   },
 });
 ```
 
+And your 1password item may look this:
+
+![1Password blob item example](../../../../assets/docs-images/plugins/1password/blob-item-example.png)
+
+<details>
+  <summary>Key lookup details and example</summary>
+
+  Values are looked up within the linked 1Password item using a simple convention. We expect to find a _text field_ within the item with a label set to the current [service name](/docs/guides/schema/#service-names). The contents of that item are parsed as a [`.env` file](https://dotenvx.com/docs/env-file), and we look up items using the config item key. If no match is found, we will also look in an additional field with the label `_default`.
+
+  For example, in the item above, an item with the key `ONE_MORE` would fallback to the value in the `_default` field in any service that wasn't named `root`.
+</details>
+
+
 You can also override the key used to lookup the value in the `.env` blob. This can be useful if you need to save multiple values toggled by some other logic.
 
 ```typescript title=".dmno/config.mts"
@@ -186,14 +200,6 @@ export default defineDmnoService({
 });
 ```
 
-#### Lookup convention example
-Values are looked up within the linked 1Password item using a simple convention. We expect to find a _text field_ within the item with a label set to the current [service name](/docs/guides/schema/#service-names). The contents of that item are parsed as a [`.env` file](https://dotenvx.com/docs/env-file), and we look up items using the config item key. If no match is found, we will also look in an additional field with the label `_default`.
-
-![1Password blob item example](../../../../assets/docs-images/plugins/1password/blob-item-example.png)
-
-For example, in the item above, an item with the key `ONE_MORE` would fallback to the value in the `_default` field in any service that wasn't named `root`.
-
-
 ### Using specific 1Password items
 
 If you already have lots of individual items in 1Password, or you just don't want to use the blob method, we provide several methods to wire up individual config items to specific values in 1Password. Note that while 1Password reference URIs (e.g., `op://vaultname/itemname/path`) are easier to use in some ways, they are based on field labels and are not stable, so the other methods are preferred.

diff --git a/packages/docs-site/src/content/docs/docs/plugins/encrypted-vault.mdx b/packages/docs-site/src/content/docs/docs/plugins/encrypted-vault.mdx
@@ -1,6 +1,7 @@
 ---
 title: DMNO Encrypted Vaults
 description: Store secrets securely in an encrypted vault that you check in to your git repo with DMNO Config.
+npmPackage: "@dmno/encrypted-vault-plugin"
 ---
 
 import TabbedCode from '@/components/TabbedCode.astro';

diff --git a/packages/integrations/astro/README.md b/packages/integrations/astro/README.md
@@ -1,12 +1,12 @@
-Check out the [docs](https://dmno.dev/docs/guides/frameworks/astro/) for more information on how to use DMNO + Astro.
+Check out the [docs](https://dmno.dev/docs/integrations/astro/) for more information on how to use [DMNO](https://dmno.dev) + [Astro](https://astro.build/).
 
 *** THIS IS PREVIEW SOFTWARE AND SUBJECT TO RAPID CHANGE ***
 
 If you have any questions, please reach out to us on [Discord](https://chat.dmno.dev).
 
 ----
 
-# @dmno/astro-integration
+# @dmno/astro-integration [![npm](https://img.shields.io/npm/v/@dmno/astro-integration)](https://www.npmjs.com/package/@dmno/astro-integration)
 
 Provides tooling to integrate dmno into your astro dev/build workflow
 

diff --git a/packages/integrations/nextjs/README.md b/packages/integrations/nextjs/README.md
@@ -1,12 +1,12 @@
-Check out the [docs](https://dmno.dev/docs/guides/frameworks/nextjs/) for more information on how to use DMNO + Next.js.
+Check out the [docs](https://dmno.dev/docs/integrations/nextjs/) for more information on how to use [DMNO](https://dmno.dev) + [Next.js](https://nextjs.org/).
 
 *** THIS IS PREVIEW SOFTWARE AND SUBJECT TO RAPID CHANGE ***
 
 If you have any questions, please reach out to us on [Discord](https://chat.dmno.dev).
 
 ----
 
-# @dmno/nextjs-integration
+# @dmno/nextjs-integration [![npm](https://img.shields.io/npm/v/@dmno/nextjs-integration)](https://www.npmjs.com/package/@dmno/nextjs-integration)
 
 Provides tooling to integrate dmno into your nextjs app
 

diff --git a/packages/integrations/remix/README.md b/packages/integrations/remix/README.md
@@ -1,12 +1,12 @@
-Check out the [docs](https://dmno.dev/docs/guides/frameworks/remix/) for more information on how to use DMNO + [Remix](https://remix.run/).
+Check out the [docs](https://dmno.dev/docs/integrations/remix/) for more information on how to use [DMNO](https://dmno.dev) + [Remix](https://remix.run/).
 
 *** THIS IS PREVIEW SOFTWARE AND SUBJECT TO RAPID CHANGE ***
 
 If you have any questions, please reach out to us on [Discord](https://chat.dmno.dev).
 
 ----
 
-# @dmno/remix-integration
+# @dmno/remix-integration [![npm](https://img.shields.io/npm/v/@dmno/remix-integration)](https://www.npmjs.com/package/@dmno/remix-integration)
 
 Provides tooling to integrate dmno into your Remix dev/build workflow
 

diff --git a/packages/integrations/vite/README.md b/packages/integrations/vite/README.md
@@ -1,12 +1,12 @@
-Check out the [docs](https://dmno.dev/docs/guides/frameworks/vite/) for more information on how to use DMNO + Vite.
+Check out the [docs](https://dmno.dev/docs/integrations/vite/) for more information on how to use [DMNO](https://dmno.dev) + [Vite](https://vitejs.dev/).
 
 *** THIS IS PREVIEW SOFTWARE AND SUBJECT TO RAPID CHANGE ***
 
 If you have any questions, please reach out to us on [Discord](https://chat.dmno.dev).
 
 ----
 
-# @dmno/vite-integration
+# @dmno/vite-integration [![npm](https://img.shields.io/npm/v/@dmno/vite-integration)](https://www.npmjs.com/package/@dmno/vite-integration)
 
 Provides tooling to integrate dmno into your vite dev/build workflow
 

diff --git a/packages/platforms/netlify/README.md b/packages/platforms/netlify/README.md
@@ -0,0 +1,9 @@
+Check out the [docs](https://dmno.dev/docs/platforms/netlify/) for more information on how to use [DMNO](https://dmno.dev) with [Netlify](https://netlify.com/).
+
+*** THIS IS PREVIEW SOFTWARE AND SUBJECT TO RAPID CHANGE ***
+
+If you have any questions, please reach out to us on [Discord](https://chat.dmno.dev).
+
+----
+
+# @dmno/netlify-platform [![npm](https://img.shields.io/npm/v/@dmno/netlify-platform)](https://www.npmjs.com/package/@dmno/netlify-platform)
diff --git a/packages/platforms/vercel/README.md b/packages/platforms/vercel/README.md
@@ -0,0 +1,9 @@
+Check out the [docs](https://dmno.dev/docs/platforms/vercel/) for more information on how to use [DMNO](https://dmno.dev) with [Vercel](https://vercel.com/).
+
+*** THIS IS PREVIEW SOFTWARE AND SUBJECT TO RAPID CHANGE ***
+
+If you have any questions, please reach out to us on [Discord](https://chat.dmno.dev).
+
+----
+
+# @dmno/vercel-platform [![npm](https://img.shields.io/npm/v/@dmno/vercel-platform)](https://www.npmjs.com/package/@dmno/vercel-platform)
diff --git a/packages/plugins/1password/README.md b/packages/plugins/1password/README.md
@@ -1,22 +1,16 @@
-Check out the [docs](https://dmno.dev/docs/guides/plugins/1password) for more information on how to use DMNO + 1Password.
+Check out the [docs](https://dmno.dev/docs/plugins/1password/) for more information on how to use [DMNO](https://dmno.dev) with [1Password](https://1password.com/).
 
 *** THIS IS PREVIEW SOFTWARE AND SUBJECT TO RAPID CHANGE ***
 
 If you have any questions, please reach out to us on [Discord](https://chat.dmno.dev).
 
 ----
 
-# @dmno/1password-plugin
+# @dmno/1password-plugin [![npm](https://img.shields.io/npm/v/@dmno/1password-plugin)](https://www.npmjs.com/package/@dmno/1password-plugin)
 
-Provides 1password integration for the @dmno config engine
-
-!> This plugin uses the 1password CLI to communicate with their systems. It installs the CLI binary (locally) in a post-install hook
-
-### Data Types
-- `OnePasswordServiceAccountToken`
-- `OnePasswordVaultId`
-- `OnePasswordVaultName`
+Securely use your secrets and data from 1password within DMNO Config Engine.
 
+## Plugin
 
 ### Initialization
 
@@ -27,12 +21,23 @@ const onePassVault = new OnePasswordDmnoPlugin('1pass');
 
 ### Value Resolvers
 
-
+### Fetch from `.env` blob
+`onePassVault.item()`
 
 ### Fetch item using unique IDs
-`onePassVault.item()`
+`onePassVault.itemById(vaultId, itemId, fieldId)`
+
+### Fetch item using private link
+`onePassVault.itemByLink(itemLink, fieldId)`
 
+### Fetch item using secret reference URI
+`onePassVault.itemByReference(itemReferenceUri)`
 
-### Fetch item using "reference"
-`onePassVault.itemByReference()`
 
+## Data Types
+- `OnePasswordTypes.serviceAccountToken`
+- `OnePasswordTypes.uuid`
+- `OnePasswordTypes.vaultId`
+- `OnePasswordTypes.itemId`
+- `OnePasswordTypes.secretReferenceUri`
+- `OnePasswordTypes.itemLink`