deep-foundation / deep-foundation/npm-automation

Do not generate specific docs if not required by user

Open
#36 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
8
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Right if we want to disable some functionality, for example disable docs generating for cli apps, we need to pass null as options:
```
await generateDocumentation({
generateCliAppsHelpInReadmeOptions: null,
generateUsageWaysOfNpmCliAppsInMarkdownFormatOptions: null,
})
```

I propose to make it another way: by default they are not generated and if you want to enable them with default options you will use specific options class and its static method default (example is taken from rust often-used concept)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.