sapphiredev / documentation-plugins

Plugins for the Sapphire documentation

Sapphire Dev

GitHub app for Sapphire

Description

The GitHub app that we use in Sapphire for automating various tasks.

Usage

Setup

# Install dependencies
yarn install

You will need to configure the Wrangler secrets for Cloudflare Workers environment. You will need the following secrets:

• APP_ID

• WEBHOOK_SECRET

• PRIVATE_KEY

The private-key.pem file from GitHub needs to be transformed from the PKCS#1 format to PKCS#8, as the crypto APIs do not support PKCS#1:

openssl pkcs8 -topk8 -inform PEM -outform PEM -nocrypt -in private-key.pem -out private-key-pkcs8.pem

Then set the private key

cat private-key-pkcs8.pem | wrangler secret put PRIVATE_KEY

For information on what these values are and how to get them see this guide

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With	Address
Open Collective	Click Here
Ko-fi	Click Here
Patreon	Click Here
PayPal	Click Here

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!

documentation-plugins's Issues

bug: `npm2yarn2pnpm` conversion to `pnpm` has some small errors with flags

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

Two related issues regarding the conversion of the npm command to pnpm:

1. Missing spaces
2. Mis-translated flags

1. Missing space

When converting commands such as npm install prisma, everything works fine.

However, when passing flags, like npm install --save-dev prisma, the pnpm conversion is missing a space.

i.e. this:

Turns into:

Examples:

1. Cypress Tutorial Page

• Page: https://next-auth.js.org/tutorials/testing-with-cypress
• Code: https://github.com/nextauthjs/next-auth/blob/main/docs/docs/tutorials/testing-with-cypress.md

2. Prisma Adapter Page

• Page: https://next-auth.js.org/adapters/prisma
• Code: https://github.com/nextauthjs/next-auth/blob/main/docs/docs/adapters/prisma.md

2. Mis-translated flag

` ``bash
npm install --save-dev prisma
` ``

Will render, in the pnpm tab, to:

pnpm add prisma--save-prod-dev

When it should be pnpm add --save-dev prisma

Steps To Reproduce

Create a bash code block with an npm install command using a double dashed flag, i.e. --save-dev.

For example:

` ``bash npm2yarn2pnpm
npm install --save-dev prisma
` ``

Will render, in the pnpm tab, to:

pnpm add prisma--save-prod-dev

Notice the flag being mistranslated from --save-dev to --save-prod-dev, as well as the missing space between prisma and --save....

Expected behavior

npm install --save-dev prisma should be translated to pnpm add --save-dev prisma

Screenshots

See above.

Additional context

No response

bug: npm2yarn2pnpm not working with [email protected]

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

The meta tag npm2yarn2pnpm has no affect on bash code blocks. Where I'd previously used npm2yarn, I've installed @sapphire/docusaurus-plugin-npm2yarn2pnpm and added:

  ```bash npm2yarn2pnpm
  npm install react
  ` ``

However, this has no affect, and the codeblock is printed as a normal bash syntaxhighlighted codeblock.

Steps To Reproduce

1. Install @sapphire/docusaurus-plugin-npm2yarn2pnpm
2. Add to your docusaurus.config.js

remarkPlugins: [ 
  require("@sapphire/docusaurus-plugin-npm2yarn2pnpm"),
]

3. Add to your docs files (i.e. index.md)

  ```bash npm2yarn2pnpm
  npm install react
  ` ``

Watch it get rendered as such:

Expected behavior

Expect npm, yarn, and pnpm tab component to be rendered

Screenshots

Additional context

See for example, this draft PR in my docusaurus project:

1. Preview Deploy: https://next-auth-2caln0sb0-nextauthjs.vercel.app/getting-started/upgrade-v4
   1a. The very first bash codeblock on this page, npm install next-auth, is supposed to be rendered with the various package manager tabs. But as you can see, it is not.
2. PR: nextauthjs/next-auth#4805

bug: `npm i` is not translated 🤷🏻‍♂️

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

When abbreviating npm install to npm i:

  npm i keystone-6-oauth

the result is:

With npm install ..., however, all works as expected.

Just thought i'll leave this here, in case this is an oversight :)

Steps To Reproduce

Use

  npm i keystone-6-oauth

instead of

  npm install keystone-6-oauth

Expected behavior

docusaurus.config.js:

{
// ...
  docs: {
    remarkPlugins: [npm2yarn2pnpm],
  },
// ...

"@sapphire/docusaurus-plugin-npm2yarn2pnpm": "^1.1.3",
"@docusaurus/core": "2.1.0",
"@docusaurus/preset-classic": "2.1.0",

Screenshots

No response

Additional context

No response

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): update all non-major dependencies (@favware/cliff-jumper, @types/node, tsup, vite, vitest)

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency ansi-regex to v6
• chore(deps): update dependency eslint to v9

Detected dependencies

github-actions

.github/workflows/auto-deprecate.yml

• actions/checkout v4
• actions/setup-node v4

.github/workflows/codeql-analysis.yml

• actions/checkout v4
• github/codeql-action v3
• github/codeql-action v3
• github/codeql-action v3

.github/workflows/continuous-delivery.yml

• actions/checkout v4
• actions/setup-node v4

.github/workflows/continuous-integration.yml

• actions/checkout v4
• actions/setup-node v4
• actions/checkout v4
• actions/setup-node v4

.github/workflows/deprecate-on-merge.yml

• actions/checkout v4
• actions/setup-node v4

.github/workflows/labelsync.yml

• actions/checkout v4
• crazy-max/ghaction-github-labeler v5

.github/workflows/publish.yml

• actions/checkout v4
• actions/setup-node v4

.github/workflows/release-crosspost.yml

• kludge-cs/gitcord-release-changelogger v3.0.0@5592170408dc081d7cb6a74ce025911bd1fcb7c3

npm

package.json

• @commitlint/cli ^19.3.0
• @commitlint/config-conventional ^19.2.2
• @favware/cliff-jumper ^4.0.2
• @favware/npm-deprecate ^1.0.7
• @sapphire/eslint-config ^5.0.5
• @sapphire/prettier-config ^2.0.0
• @sapphire/ts-config ^5.0.1
• @types/mdast ^4.0.4
• @types/node ^20.14.11
• @types/unist ^3.0.2
• cz-conventional-changelog ^3.3.0
• eslint ^8.57.0
• eslint-config-prettier ^9.1.0
• eslint-plugin-prettier ^5.2.1
• lint-staged ^15.2.7
• prettier ^3.3.3
• rimraf ^6.0.1
• tsup ^8.2.1
• turbo ^2.0.9
• vite ^5.3.4
• vitest ^2.0.3
• acorn ^8.12.1
• ansi-regex ^5.0.1
• minimist ^1.2.8
• yarn 4.3.1

packages/npm2yarn2pnpm/package.json

• mdast-util-mdx ^3.0.0
• unified ^11.0.5
• @favware/cliff-jumper ^4.0.2
• tsup ^8.2.1
• vitest ^2.0.3

packages/ts2esm2cjs/package.json

• @prettier/sync ^0.5.2
• esm-to-cjs ^1.2.1
• mdast-util-mdx ^3.0.0
• unified ^11.0.5
• @favware/cliff-jumper ^4.0.2
• @sapphire/framework ^5.2.1
• tsup ^8.2.1
• vitest ^2.0.3

packages/typedoc-djs-links/package.json

• @favware/cliff-jumper ^4.0.2
• discord.js ^14.15.3
• tsup ^8.2.1
• vitest ^2.0.3

---

• Check this box to trigger a request for Renovate to run again on this repository

bug: app.showPage is not a function

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

When generating typedoc documentation with the typedoc-plugin-djs-links plugin loaded, an empty page is served with the following error in the console:

app.showPage is not a function

typedoc: ^0.25.13
typedoc-plugin-djs-links: ^2.2.1

Steps To Reproduce

Generate any typedoc documentation using the typedoc-plugin-djs-links plugin on the following (latest) versions:
typedoc: ^0.25.13
typedoc-plugin-djs-links: ^2.2.1

Remove the plugin from the typedoc config, and the documentation works as expected.

Expected behavior

The documentation is served as normally, without the error being thrown :)

Screenshots

Additional context

npm is being used as the package manager for this project.

System Info

System:
    OS: Linux 5.15 Ubuntu 20.04.6 LTS (Focal Fossa)
    CPU: (12) x64 AMD Ryzen 5 3600X 6-Core Processor
    Memory: 8.38 GB / 15.59 GB
    Container: Yes
    Shell: 5.0.17 - /bin/bash
  Binaries:
    Node: 20.11.1 - ~/.nvm/versions/node/v20.11.1/bin/node
    npm: 10.2.4 - ~/.nvm/versions/node/v20.11.1/bin/npm
    pnpm: 8.10.2 - ~/.local/share/pnpm/pnpm
    bun: 1.0.3 - ~/.bun/bin/bun