How to disable Haddock for all the packages in the flake?

[khazaddum]

Using settings.<package>.haddock = false does not seem to prevent the haddockPhase of the package to be run.

Also, I would like to turn off the haddockPhases of all the needed dependencies. Is there a way to turn it off globally?

[srid]

It is not documented yet (#171 (comment)), but you can use defaults.settings.{all,local,defined} for this.

See

haskell-flake/nix/modules/project/defaults.nix

Lines 80 to 208 in 4a675e7

	settings.local = mkOption {
	type = types.deferredModule;
	description = ''
	Default settings for packages local to the current project.
	'';
	apply = settings:
	if config.defaults.enable then
	{ package, ... }:
	lib.optionalAttrs (package.local.toCurrentProject or false) {
	imports = [
	settings
	];
	}
	else { };
	default = { };
	};
	settings.defined = mkOption {
	type = types.deferredModule;
	description = ''
	Default settings for all the packages defined using haskell-flake.
	For example,
	```nix
	{
	# Inside haskellProjects.<name>
	imports = [
	inputs.moo.haskellFlakeProjectModules.output
	];
	packages = {
	foo.source = "0.1";
	bar.source = inputs.bar;
	};
	settings = {
	baz.check = false;
	};
	}
	```
	and
	```cabal
	...
	build-depends:
	moo
	, foo
	, bar
	, baz
	, qux
	...
	```
	This will apply the settings to `moo` and packages in current project. But not to `foo`, `bar`, `baz` and `qux`.
	'';
	apply = settings:
	if config.defaults.enable then
	{ package, ... }:
	lib.optionalAttrs (package.local.toDefinedProject or false) {
	imports = [
	settings
	];
	}
	else { };
	defaultText = ''
	Speed up builds by disabling haddock and library profiling. Also ensures
	release-worthiness.
	This uses `local.toDefinedProject` option to determine which packages to
	override. Thus, it applies to both local packages as well as
	transitively imported packags that are local to that flake (managed by
	haskell-flake). The goal being to use the same configuration
	consistently for all packages using haskell-flake.
	'';
	default = {
	# Disabling haddock and profiling is mainly to speed up Nix builds.
	haddock = lib.mkDefault false; # Because, this is end-user software. No need for library docs.
	libraryProfiling = lib.mkDefault false; # Avoid double-compilation.
	buildFromSdist = lib.mkDefault true; # Ensure release-worthiness
	};
	};
	settings.all = mkOption {
	type = types.deferredModule;
	description = ''
	Default settings for all packages whose derivations are produced by haskell-flake.
	For example,
	```nix
	{
	# Inside haskellProjects.<name>
	imports = [
	inputs.moo.haskellFlakeProjectModules.output
	];
	packages = {
	foo.source = "0.1";
	bar.source = inputs.bar;
	};
	settings = {
	baz.check = false;
	};
	}
	```
	and
	```cabal
	...
	build-depends:
	moo
	, foo
	, bar
	, baz
	, qux
	...
	```
	This will apply the settings to `moo`, `foo`, `bar`, `baz`. But not to `qux`.
	'';
	apply = settings:
	if config.defaults.enable then
	{
	imports = [
	settings
	];
	}
	else { };
	defaultText = ''
	Nothing is changed by default.
	'';
	default = { };
	};

[srid]

haddock should already be disabled for packages managed by haskell-flake

See

haskell-flake/nix/modules/project/defaults.nix

Lines 153 to 155 in 4a675e7

	default = {
	# Disabling haddock and profiling is mainly to speed up Nix builds.
	haddock = lib.mkDefault false; # Because, this is end-user software. No need for library docs.

[khazaddum]

Haddock doesn't run for my flake, but I saw that it does run when building dependencies.

The settings.all worked!