feat/typescript: add TypeScript examples to the guide #1560
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
omar-sobhy
changed the title
|
Something I was considering is creating an entirely separate TypeScript section in the guide and adding all the guide content there. This has the advantage of keeping the JS portion of the guide clean, but it also essentially duplicates the content |
omar-sobhy
force-pushed
the
feat/typescript
branch
from
9844965
to
70cdde9
Compare
ghost
reviewed
May 23, 2024
| import { REST, Routes } from 'discord.js'; | ||
| import { Config, assertObjectIsConfig } from './types/Config'; | ||
| import fs from 'fs'; | ||
| import path from 'path'; |
There was a problem hiding this comment.
Suggested change
| import path from 'path'; | |
| import path from 'node:path'; |
ghost
reviewed
May 23, 2024
| ```ts | ||
| import { REST, Routes } from 'discord.js'; | ||
| import { Config, assertObjectIsConfig } from './types/Config'; | ||
| import fs from 'fs'; |
There was a problem hiding this comment.
Suggested change
| import fs from 'fs'; | |
| import fs from 'node:fs'; |
ghost
reviewed
May 23, 2024
| ::: | ||
| :::code-group-item ts | ||
| ```ts {1-2} | ||
| import { readFileSync } from 'fs'; |
There was a problem hiding this comment.
Suggested change
| import { readFileSync } from 'fs'; | |
| import { readFileSync } from 'node:fs'; |
ghost
reviewed
May 23, 2024
| :::code-group-item ts | ||
| ```ts {1-2} | ||
| import { readFileSync } from 'fs'; | ||
| import path from 'path'; |
There was a problem hiding this comment.
Suggested change
| import path from 'path'; | |
| import path from 'node:path'; |
ghost
reviewed
May 23, 2024
| ::: code-group-item ts | ||
| ```ts | ||
| import { readFileSync } from 'fs'; | ||
| import path from 'path'; |
There was a problem hiding this comment.
Suggested change
| import path from 'path'; | |
| import path from 'node:path'; |
ghost
reviewed
May 23, 2024
| ::: | ||
| ::: code-group-item ts | ||
| ```ts | ||
| import { readFileSync } from 'fs'; |
There was a problem hiding this comment.
Suggested change
| import { readFileSync } from 'fs'; | |
| import { readFileSync } from 'node:fs'; |
|
Maybe eslint section should also include basic information about |
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.
Please describe the changes this PR makes and why it should be merged:
WIP WIP! I'm only opening the PR to get opinions on the current structure and suggestions on how to improve things. The current examples are slightly opinionated, but could possibly stand to be more opinionated on things like the tsconfig.json.
This PR adds TypeScript examples to the guide.
Pages now have TypeScript markdown containers when TypeScript-specific tips need to be displayed. Additionally, TypeScript examples are added to pages using code groups so that guide readers can switch between JS/TS examples on the fly.
Closes #1121