[VERY WIP, ONLY FOR DIFF VIEW] refactor: switch to json based docs #214
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
favna
force-pushed
the
refactor/switch-to-json-based-docs
branch
from
6704487 to
ce9880d
Compare
favna
force-pushed
the
refactor/switch-to-json-based-docs
branch
from
ce9880d to
3570c30
Compare
favna
force-pushed
the
refactor/switch-to-json-based-docs
branch
from
a89a7c9 to
aca7434
Compare
favna
force-pushed
the
refactor/switch-to-json-based-docs
branch
from
a6a3e53 to
39fb1e5
Compare
favna
force-pushed
the
refactor/switch-to-json-based-docs
branch
from
39fb1e5 to
9317110
Compare
favna
force-pushed
the
refactor/switch-to-json-based-docs
branch
2 times, most recently
from
1e66654 to
a27f902
Compare
RealShadowNova
force-pushed
the
refactor/switch-to-json-based-docs
branch
from
6e13896 to
96a7d81
Compare
favna
force-pushed
the
refactor/switch-to-json-based-docs
branch
from
42b30a9 to
2205bbb
Compare
favna
force-pushed
the
refactor/switch-to-json-based-docs
branch
from
2205bbb to
b8be493
Compare
- feat: start setting up the plugin for parsing
- feat: start parsing classes
- feat: update framework json
- fix: fixed rendering custom files with css
- chore: update framework json to exclude externals
- feat: setup parsing sapphire classes and do a lot of link fixing
- refactor: switch to sapphire result
- fix: remove replaceall for Node 14 compat
- fix: actually remove replaceAll
- fix: fixed css extraction regex
- I thought I did this already
- fix: fixed broken link on welcome page
- chore: temporarily disable reporting broken links
- feat: much stuff
- change `classes` to `class` to match DJS
- add `typedef` and `namespace` linking
- fix linking of non-generic types
- update guide urls to match `class` change
- chore: bump deps
- chore: cleanup types
- feat: add variant to typedefs
- build: make it easier to debug
- fix: partially fix link extraction
- feat(docgen): add renderTypedef()
- Moved parseSee() from /lib/renderer/renderClass.ts to /lib/renderer/utils.ts
- Add /lib/renderer/renderTypedef.ts
Which adds basic functionality in the website with things like title, description and extendedDescription
- chore: sort ts interfaces in docgen output
- chore: update doc types
- refactor: completely refactor how links are resolved
- fix: fixed links for `{@link` tags and propegate change to mdn and djs
- fix: use `replace` instead of `replaceAll`
- feat(docusaurus-discordjs-docgen): add functionality for enum and interface
- style(docusaurus-discordjs-docgen): use Array#flat() for typedef
- feat(docusaurus-discordjs-docgen): add constructor table functionality for classes
- feat(docusaurus-discordjs-docgen): align table content to center
- feat(docusaurus-discordjs-docgen): remove description column if all falsy
- feat(docusaurus-discordjs-docgen): add properties functionality for classes
- ci: add automatic vercel deploys workflow
- chore(docusaurus-typedoc-json-parser): initial commit
- chore(docusaurus-typedoc-json-parser): add doc fetching
- chore(docusaurus-typedoc-json-parser): add sidebar rendering
- fix(deps): update all non-major dependencies
- fix(deps): update dependency typedoc-json-parser to ^5.2.0
- feat(docusaurus-typedoc-json-parser): add basic renderers
- style(docusaurus-typedoc-json-parser): curly brackets and spacing
- style(docusaurus-typedoc-json-parser): template literals
- feat(docusaurus-typedoc-json-parser): add class extends and implements
- feat(docusaurus-typedoc-json-parser): add link parsing for the local project
- chore(docusaurus-typedoc-json-parser): add `start` script to bypass debugger
- feat(docusaurus-typedoc-json-parser): add comment info for classes
- chore: update dev deps
- chore: regen and dedupe lockfile
- fix(docusaurus-typedoc-json-parser): absorb breaking changes and add versioning
- refactor: switch to using typedoc-json-parser plugin
- chore: add `update` script
- fix(deps): update dependency typedoc-json-parser to ^6.0.2
- fix(docusaurus-typedoc-json-parser): proper category yamls
- feat(docusaurus-typedoc-json-parser): first steps to proper type linking
- refactor(docusaurus-typedoc-json-parser): switch from constant to variable
- feat(docusaurus-typedoc-json-parser): render classes
- ci: use tags for actions
- chore: cleanup
- fix(typedoc-parser): fixed no auth requests
- refactor: depluginize the plugin
- chore: fix typecheck
- chore: update to yarn 3.2.4
- chore: remove unnecessary package script
- feat(json-parser): render enums
- chore(json-parser): remove useless script
- feat(json-parser): render functions
- feat(json-parser): add accessibility and static modifiers for class methods
- feat(json-parser): more steps towards proper reference linking
- chore(deps): update dependency typedoc-json-parser to ^7.0.0
- fix(deps): update dependency typedoc-json-parser to ^7.0.1
- feat(json-parser): even more steps to proper reference linking
- chore: update deps
- feat: add ReadOnlyPill code
- feat: add code for other pills
- fix: flex wrap items
- chore: update readme banner
- feat(json-parser): progress!
- refactor(json-parser): rendered file structure
- feat(json-parser): include latest and next version
- feat(json-parser): include all major versions
- fix(json-parser): update `typedoc-json-parser` to ^8.0.0
- feat(json-parser): add functionality to find types in neighbour packages
- chore(scripts): add update
- chore: update dependencies
- build: fix tsconfig for json-parser
favna
force-pushed
the
refactor/switch-to-json-based-docs
branch
from
b8be493 to
8be776a
Compare
|
Error dump of running typedoc-json-parser errorsdocusaurus rendering errorsThe relevant mdx files are: ---
id: "dateequal"
title: "dateEqual"
sidebar_label: "dateEqual"
sidebar_position: 16
custom_edit_url: null
---
### dateEqual(value): [`IConstraint`](..//interface/iconstraint.mdx)<[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| value | [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | No description provided. |
---
id: "dategreaterthan"
title: "dateGreaterThan"
sidebar_label: "dateGreaterThan"
sidebar_position: 17
custom_edit_url: null
---
### dateGreaterThan(value): [`IConstraint`](..//interface/iconstraint.mdx)<[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| value | [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | No description provided. |
---
id: "dategreaterthanorequal"
title: "dateGreaterThanOrEqual"
sidebar_label: "dateGreaterThanOrEqual"
sidebar_position: 18
custom_edit_url: null
---
### dateGreaterThanOrEqual(value): [`IConstraint`](..//interface/iconstraint.mdx)<[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| value | [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | No description provided. |
---
id: "datelessthan"
title: "dateLessThan"
sidebar_label: "dateLessThan"
sidebar_position: 19
custom_edit_url: null
---
### dateLessThan(value): [`IConstraint`](..//interface/iconstraint.mdx)<[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| value | [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | No description provided. |
---
id: "datelessthanorequal"
title: "dateLessThanOrEqual"
sidebar_label: "dateLessThanOrEqual"
sidebar_position: 20
custom_edit_url: null
---
### dateLessThanOrEqual(value): [`IConstraint`](..//interface/iconstraint.mdx)<[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| value | [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | No description provided. |
---
id: "datenotequal"
title: "dateNotEqual"
sidebar_label: "dateNotEqual"
sidebar_position: 21
custom_edit_url: null
---
### dateNotEqual(value): [`IConstraint`](..//interface/iconstraint.mdx)<[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| value | [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | No description provided. |
---
id: "isanyinteraction"
title: "isAnyInteraction"
sidebar_label: "isAnyInteraction"
sidebar_position: 17
custom_edit_url: null
---
### isAnyInteraction(messageOrInteraction): messageOrInteraction is [`BaseInteraction`](https://discord.js.org/#/docs/discord.js/main/search?query=BaseInteraction)<[`CacheType`](https://discord.js.org/#/docs/discord.js/main/search?query=CacheType)\>
Checks whether the input `messageOrInteraction` is one of {@link Message} or one of {@link Interaction}, {@link CommandInteraction}, {@link ContextMenuInteraction}, or {@link SelectMenuInteraction}
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| messageOrInteraction | [`APIMessage`](package::discord-api-types) \| [`BaseInteraction`](https://discord.js.org/#/docs/discord.js/main/search?query=BaseInteraction)<[`CacheType`](https://discord.js.org/#/docs/discord.js/main/search?query=CacheType)\> \| [`Message`](https://discord.js.org/#/docs/discord.js/main/search?query=Message)<boolean\> | The message or interaction that should be checked. |
---
id: "fetch"
title: "fetch"
sidebar_label: "fetch"
sidebar_position: 0
custom_edit_url: null
---
## Signatures
### fetch<R\>(url, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`R`\>
Performs an HTTP(S) fetch
#### Type Parameters
| Name | Type | Default |
| :---: | :---: | :---: |
| R | Not provided. | Not provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | The URL to send the request to. Can be either a `string` or an `URL` object.
`url` should be an absolute url, such as `https://example.com/`. A path-relative URL (`/file/under/root`) or protocol-relative URL (`//can-be-http-or-https.com/`) will result in a rejected `Promise`. |
| type | [`FetchResultTypes.JSON`](package::@sapphire/fetch) | Only needs to be provided if the second parameter are [Request options](https://developer.mozilla.org/en-US/docs/Web/API/Request) ({@link RequestInit} for TypeScript). One of the {@link FetchResultTypes} that will determine how the result is returned. |
### fetch<R\>(url, options, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`R`\>
No description provided.
#### Type Parameters
| Name | Type | Default |
| :---: | :---: | :---: |
| R | Not provided. | Not provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| options | [`RequestOptions`](..//interface/requestoptions.mdx) | No description provided. |
| type | [`FetchResultTypes.JSON`](package::@sapphire/fetch) | No description provided. |
### fetch(url, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`__global.Buffer`](https://nodejs.org/api/buffer.html)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| type | [`FetchResultTypes.Buffer`](package::@sapphire/fetch) | No description provided. |
### fetch(url, options, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`__global.Buffer`](https://nodejs.org/api/buffer.html)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| options | [`RequestOptions`](..//interface/requestoptions.mdx) | No description provided. |
| type | [`FetchResultTypes.Buffer`](package::@sapphire/fetch) | No description provided. |
### fetch(url, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| type | [`FetchResultTypes.Blob`](package::@sapphire/fetch) | No description provided. |
### fetch(url, options, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| options | [`RequestOptions`](..//interface/requestoptions.mdx) | No description provided. |
| type | [`FetchResultTypes.Blob`](package::@sapphire/fetch) | No description provided. |
### fetch(url, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<string\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| type | [`FetchResultTypes.Text`](package::@sapphire/fetch) | No description provided. |
### fetch(url, options, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<string\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| options | [`RequestOptions`](..//interface/requestoptions.mdx) | No description provided. |
| type | [`FetchResultTypes.Text`](package::@sapphire/fetch) | No description provided. |
### fetch(url, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| type | [`FetchResultTypes.Result`](package::@sapphire/fetch) | No description provided. |
### fetch(url, options, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)\>
No description provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| options | [`RequestOptions`](..//interface/requestoptions.mdx) | No description provided. |
| type | [`FetchResultTypes.Result`](package::@sapphire/fetch) | No description provided. |
### fetch<R\>(url, options, type): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | [`__global.Buffer`](https://nodejs.org/api/buffer.html) | string | `R`\>
No description provided.
#### Type Parameters
| Name | Type | Default |
| :---: | :---: | :---: |
| R | Not provided. | Not provided.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| url | string \| [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | No description provided. |
| options | [`RequestOptions`](..//interface/requestoptions.mdx) | No description provided. |
| type | [`FetchResultTypes`](..//enum/fetchresulttypes.mdx) | No description provided. |
---
id: "getdomaininfo"
title: "getDomainInfo"
sidebar_label: "getDomainInfo"
sidebar_position: 1
custom_edit_url: null
---
### getDomainInfo(domain, apiKey): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[`PhishermanInfo`](package::@sapphire/phisherman)\>
Returns information for a domain.
#### Parameters
| Name | Type | Description |
| :---: | :---: | :---: |
| domain | string | The domain to get info about. |
| apiKey | string | optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}. | |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Tasks to not forget:
/docs/guide/utilities/time-utilities: check path toTimeenumtemporary-errors-log-of-broken-links.mdfrom root.github/workflows/automatic-vercel-deploy.yml