easy-cli-framework/typedoc.json

A framework for building CLI applications that are robust and easy to maintain. Supports theming, configuration files, interactive prompts, and more.

{
  "$schema": "https://typedoc.org/schema.json",
  "out": "./docs",
  "readme": "none",
  "exclude": ["**/node_modules/**/*", "**/dist/**/*"],
  "plugin": ["typedoc-plugin-markdown"],
  "tsconfig": "./tsconfig.build.json",
  // "useCodeBlocks": true,
  "parametersFormat": "table",
  "indexFormat": "table",
  "typeDeclarationFormat": "table",
  "propertyMembersFormat": "table",
  "interfacePropertiesFormat": "table",
  "expandParameters": false,
  "outputFileStrategy": "modules",
  "groupOrder": ["Classes", "Functions", "*"],
  "sort": ["source-order", "alphabetical"],
  "entryPoints": [
    "src/app.ts",
    "src/config-files/index.ts",
    "src/commands/index.ts",
    "src/helpers/index.ts",
    "src/themes/index.ts",
    "src/prompts/index.ts"
  ],
  "name": "Easy CLI",
  "hidePageHeader": true,
  "tableColumnSettings": {
    "hideDefaults": false,
    "hideInherited": true,
    "hideModifiers": false,
    "hideOverrides": true,
    "hideSources": false,
    "hideValues": false,
    "leftAlignHeaders": false
  },
  "gitRevision": "master",
}