stack.yaml versus package.yaml versus a Cabal file¶
What is the difference between a
stack.yaml file, a
package.yaml file and a
Cabal file (named
<package_name>.cabal)? This page aims to make that clear.
stack.yamlcontains project-level configuration for Stack, and may contain project-specific options and non-project-specific options.
package.yamlcontains a description of a package in the Hpack format. Hpack, including Stack's built-in version, uses the file to create a Cabal file.
a Cabal file also contains a description of a package, but in the format used by Cabal.
package.yaml versus a Cabal file¶
Why two different formats to describe packages? Hpack is considered to have some
advantages over the underlying Cabal format, which are explained its project
repository. They include that the Hpack format supports YAML syntax and the
automatic generation of the lists of
exposed-modules used in the Cabal format.
The remainder of this page will focus on the difference between a
file and a package description file.
Package versus project¶
Stack is a build tool and it uses Cabal, a build system. Cabal defines the concept of a package. A package has:
- A name and version
- optionally, one library
- optionally, one or more executables
- A Cabal file (or, as mentioned above, an Hpack
package.yamlfile that generates a Cabal file)
- And a bunch more
There is a one-to-one correspondence between a package and a Cabal file.
Stack defines a new concept called a project. A project has:
- A resolver, which tells it about a snapshot (more on this later)
- Extra dependencies on top of the snapshot
- Optionally, one or more local Cabal packages
- Flag and GHC options configurations
- And a bunch more Stack configuration
Often you will have a project that defines only one local Cabal package that you
are working on. If you need to specify an extra dependency, a source of
confusion can be why you need to specify it both in the
stack.yaml file and
in the Cabal file. To explain, let's take a quick detour to talk about snapshots
and how Stack resolves dependencies.
Resolvers and snapshots¶
Stack follows a rule that says, for any projects, there is precisely one version
of each package available. Obviously, for many packages there are many
versions available in the world. But when resolving a
stack.yaml file, Stack
requires that you have chosen a specific version for each package available.
The most common means by which this set of packages is defined is via a
snapshot provided by Stackage. For example, if you go to the page
https://www.stackage.org/lts-20.19, you will see a list of 3,051 packages at
specific version numbers. When you then specify
resolver: lts-20.19, you're
telling Stack to use those package versions in resolving dependencies down to
specific versions of packages.
Sometimes a snapshot doesn't have all of the packages that you want. Or you want
a different version of a package. Or you want to work on a local modification of
a package. In all of those cases, you can add more configuration data to your
stack.yaml file to override the values it received from your
setting. At the end of the day, each of your projects will end up with some way
of resolving a package name into a specific version of that package.
Why specify dependencies twice?¶
acme-missiles is not included in any Stackage snapshots. When you
add something like this to your
what you're saying to Stack is: "if at any point you find that you need to build
acme-missiles package, please use version
0.3". You are not saying
acme-missiles now." You are also not saying "my package depends
acme-missiles." You are simply making it available should the need arise.
When you add to your
or, alternatively, you add directly to your Cabal file:
you're saying "this package requires that
acme-missiles be available." Since
acme-missiles doesn't appear in your snapshot, without also modifying your
stack.yaml to mention it via
extra-deps, Stack will complain about the
dependency being unavailable.
You may challenge: but why go through all of that annoyance? Stack knows what
package I want, why not just go grab it? The answer is that, if Stack just
acme-missiles for you without it being specified in the
somehow, you'd lose reproducibility. How would Stack know which version to use?
It may elect to use the newest version, but if a new version is available in
the future, will it automatically switch to that?
Stack's core philosophy is that build plans are always reproducible. The
purpose of the
stack.yaml file is to define an immutable set of packages. No
matter when in time you use it, and no matter how many new release happen in
the interim, the build plan generated should be the same.
(There is, however, at least one hole in this theory today, which is Hackage
revisions. When you specify
extra-deps: [acme-missiles-0.3], it doesn't
specify which revision of the Cabal file to use, and Stack will just choose the
latest. Stack has the ability to specify exact revisions of Cabal files, but
this isn't enforced as a requirement, because it is so different from the way
most people work with packages.)
And now, how about the other side: why doesn't Stack automatically add
build-depends in your Cabal file if you add it as an
extra-dep? There are a surprising number reasons for this:
- The Cabal specification doesn't support anything like that
- There can be multiple packages in a project, and how do we know which package actually needs the dependency?
- There can be multiple components (libraries, executable, etc) in a package, and how do we know which of those actually needs the dependency?
- The dependency may only be conditionally needed, based on flags, operating system, or architecture. As an extreme example, we wouldn't want a Linux-only package to be built by force on Windows.
While for simple use cases it seems like automatically adding dependencies from
the Cabal file to the
stack.yaml file or vice-versa would be a good thing, it
breaks down immediately for any semi-difficult case. Therefore, Stack requires
you to add it to both places.
And a final note, in case it wasn't clear. The example above used
acme-missiles, which is not in Stackage snapshots. If, however, you want to
depend on a package already present in the snapshot you've selected, there's no
need to add it explicitly to your
stack.yaml file: it's already there
implicitly via the
resolver setting. This is what you do the majority of the
time, such as when you add
mtl as a
Should I check-in automatically generated Cabal files?¶
Yes, you should. This recommendation was changed in issue #5210. Please see the discussion there.