Skip to content

docs: clarify config file name in example #81

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

Merged
mjfaga merged 1 commit into from
Nov 25, 2025
Merged

docs: clarify config file name in example #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ GLOBAL FLAGS
DESCRIPTION
Generate type definitions for your Reforge configuration

You can use the default type-generation configuration, or by provide your own:
You can use the default type-generation configuration, or by provide your own via a reforge.config.json file:

Format:
{
Expand All @@ -163,7 +163,7 @@ DESCRIPTION
​ }
};

Example:
Example reforge.config.json:
```json
{
​ "outputDirectory": "path/to/your/directory",
Expand Down
4 changes: 2 additions & 2 deletions src/commands/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ const DEFAULT_CONFIG: {

export default class Generate extends APICommand {
/* eslint-disable no-irregular-whitespace */
static description = `You can use the default type-generation configuration, or by provide your own:
static description = `You can use the default type-generation configuration, or by provide your own via a reforge.config.json file:

Format:
{
Expand All @@ -95,7 +95,7 @@ Format:
​ }
};

Example:
Example reforge.config.json:
\`\`\`json
{
​ "outputDirectory": "path/to/your/directory",
Expand Down