Skip to content

plugins and 1pass docs #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: plugins
Choose a base branch
from
Open

plugins and 1pass docs #175

wants to merge 4 commits into from
+742 −250

Conversation

@theoephraim
Copy link
Member

  • Adds new plugins guide that explains plugins in general
  • Adds new plugins section with overview page
  • Adds 1Password plugin docs
  • covers the change from @envFlag to @currentEnv
  • adjust schema guide to cover general info about decorator functions and value resolution
  • Some style updates

@changeset-bot
Copy link

changeset-bot bot commented Oct 21, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 0546ef0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 21, 2025 •
edited
Loading

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs		 varlock-website 0546ef0 Commit Preview URL

Branch Preview URL		 Oct 28 2025, 07:31 PM

philmillman
philmillman approved these changes Oct 21, 2025
View reviewed changes
Copy link
Member

@philmillman philmillman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mostly copy edits and a few tweaks and questions

ready to go once we decide on the final name for initOp etc

nice job!

packages/varlock-website/src/snippets/decorator-notes.mdx Outdated
Comment on lines 1 to 23
:::note[Decorator values are resolved]
Values passed to decorators will be resolved, meaning if a decorator is expecting a boolean, either a static `true`/`false` or a [resolver function](/reference/functions) that resolves to a boolean may be used.

```env-spec
# @required=false
NEVER_REQUIRED=
# @required=forEnv(prod)
REQUIRED_FOR_PROD=
```
:::


:::note[Decorator function calls]
Most decorators take a single value (e.g., `@sensitive`) and may be used only once per item, but some are function calls (e.g., `@docs()`) and may be called multiple times.

```env-spec
# @sensitive=true
# @docs(https://xyzapi.com/docs/auth)
# @docs(https://xyzapi.com/manage-api-keys)
XYZ_API_KEY=
```
:::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete?

theoephraim
theoephraim commented Oct 21, 2025
View reviewed changes
theoephraim
theoephraim commented Oct 21, 2025
View reviewed changes
theoephraim
theoephraim commented Oct 21, 2025
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@philmillman philmillman philmillman approved these changes

Assignees

No one assigned

Labels

docs maintainer

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@theoephraim @philmillman