Skip to content

--project-name and --project-version being overridden by package.json #845

Closed
@sripberger

Description

@sripberger

Using v4.0.0-rc.1, I'm completely unable to use either of these CLI options when a package.json is present.

Documentation is installed locally and I am running with an npm script:

"scripts": {
    "docs": "documentation build --project-name whatever --project-version 0.0.2 -f html -o docs"
}

The result always comes out with the project name and version taken from my package.json. Based on the CLI help, though, I'd expect the CLI options to take prioity.

I did some further investigation and found that if I remove either the name or version property from package.json, the corresponding value becomes an empty string, continuing to ignore the CLI options. The only way I seemed to be able to get it to respect the CLI options is by removing package.json altogether and running like this:

./node_modules/.bin/documentation build lib/index.js --project-name whatever --project-version 0.02 -f html -o docs

Of course, removing package.json is hardly ideal. I suppose if it's there, there isn't much reason to need the CLI options, so I wouldn't exactly call this a high priority. It just doesn't quite work like the help says.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions