JSON files?

[benthevining]

The docs and examples provide very little info about usage with JSON files. I see how I can require certain keys, but is that all nitpick can do? Can I require that certain keys are set to specific values?

[andreoliwa]

I see how I can require certain keys, but is that all nitpick can do? Can I require that certain keys are set to specific values?

Check out the contains_json example here for commitlint:

nitpick/src/nitpick/resources/any/commitlint.toml

Lines 5 to 12 in d9d5055

	["package.json".contains_json]
	commitlint = """
	{
	"extends": [
	"@commitlint/config-conventional"
	]
	}
	"""

The docs and examples provide very little info about usage with JSON files.

You're right.
I will expand the docs, thanks for the comment.

Originally, package.json had both examples.
But now it only has contains_keys, after I split configs into multiple files:

nitpick/src/nitpick/resources/javascript/package-json.toml

Lines 5 to 6 in d9d5055

	["package.json"]
	contains_keys = ["name", "version", "repository.type", "repository.url", "release.plugins"]

The unwritten plan (no ticket yet) is:

• To make the JSON plugin as flexible as the YAML (which was written recently).
• Deprecate contains_keys in favour of Enforce presence of keys (with any values) #218
• Deprecate contains_json in favour of configuring keys and nested objects like the YAML plugin does

But that is a bit of work, and I don't know what is the demand for it now.

[benthevining]

Awesome, thank you so much!

The current capabilities are enough to achieve what I want, but a syntax more similar to the YAML plugin would certainly be a welcome upgrade.