Skip to content
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.

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

[FEATURE] Add support for a JSON file for storing configuration options instead of only using CLI #379

Closed
Chowarmaan opened this issue Nov 14, 2017 · 4 comments

Comments

@Chowarmaan
Copy link

Overview of the issue

The command line is getting rather large and unwieldly in the package.json for a complex build of documentation. It would be nice to be able to set the configuration using a compodoc.json file (or whatever name specified) similar to the tsconfig.json.

Operating System, Node.js, npm, compodoc version(s)

Windows 10
Node 8.8.1
npm: 5.5.1
Compodoc: 1.0.4

Motivation for or Use Case

Cleanliness of the package.json to have the configuration in a structured json file like a number of other tools, especially as the options continue to grow on the application.

Suggest a Fix

Add an additional option to specify the json configuration file and possibly even default to compodoc.json if a file is not provided or found.

@vogloblinsky
Copy link
Contributor

Yes Steven, this is something we have to do. I had it for 1.1.0 milestone.

@jensschneider
Copy link

That would be a great thing. Too bad that it will be pushed from version to version.

@vogloblinsky
Copy link
Contributor

I will use this npm module for loading configuration file : https://github.com/davidtheclark/cosmiconfig
Find and load a configuration object from

  • a package.json property (anywhere up the directory tree)
  • a JSON or YAML "rc file" (anywhere up the directory tree)

@lock
Copy link

lock bot commented Sep 30, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

@lock lock bot locked as resolved and limited conversation to collaborators Sep 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants