Module documentation for 1.1.2
The Haskell Tool Stack
Stack is a cross-platform program for developing Haskell projects. It is intended for Haskellers both new and experienced.
See haskellstack.org or the
doc directory for more
- Extensible custom snapshots implemented. These allow you to define snapshots which extend other snapshots. See #863. Local file custom snapshots can now be safely updated without changing their name. Remote custom snapshots should still be treated as immutable.
stack path --compilerwas added in the last release, to yield a path to the compiler. Unfortunately,
--compileris a global option that is useful to use with
stack path. The same functionality is now provided by
stack path --compiler-exe. See #2123
- For packages specified in terms of a git or hg repo, the hash used in the location has changed. This means that existing downloads from older stack versions won’t be used. This is a side-effect of the fix to #2133
stack upgradeno longer pays attention to local stack.yaml files, just the global config and CLI options. #1392
stack ghcinow uses
:load, making it potentially work better with user scripts. See #1888
- Grab Cabal files via Git SHA to avoid regressions from Hackage revisions #2070
- Custom snapshots now support
- Package git repos are now re-used rather than re-cloned. See #1620
DESTDIRis filtered from environment when installing GHC. See #1460
stack haddocknow supports
--hadock-arguments. See #2144
- Signing: warn if GPG_TTY is not set as per
- Now ignore project config when doing
stack new. See #2110
- Packages specified by git repo can now have submodules. See #2133
- Fix of hackage index fetch retry. See re-opening of #1418
- HPack now picks up changes to filesystem other than package.yaml. See #2051
- “stack solver” no longer suggests –omit-packages. See #2031
- Fixed an issue with building Cabal’s Setup.hs. See #1356
- Package dirtiness now pays attention to deleted files. See #1841
stack ghcinow uses
extra-include-dirs. See #1656
- Relative paths outside of source dir added via
qAddDependentFileare now checked for dirtiness. See #1982
- Signing: always use
- Added Ubuntu 16.04 LTS (xenial) Apt repo.
- No longer uploading new versions to Fedora 21 repo.
- Snapshot packages are no longer built with executable profiling. See #1179.
stack initnow ignores symlinks when searching for cabal files. It also now ignores any directory that begins with
.(as well as
distdirs) - before it would only ignore
- The stack executable is no longer built with
-rtsopts. Before, when
-rtsoptswas enabled, stack would process
+RTSoptions even when intended for some other program, such as when used with
stack exec -- prog +RTS. See #2022.
stack path --ghc-pathsoption is deprecated and renamed to
--compileris added, which points directly at the compiler used in the current project.
--compiler-binpoints to the compiler’s bin dir.
- For consistency with the
$STACK_ROOTenvironment variable, the
stack path --global-stack-rootflag and the
global-stack-rootfield in the output of
stack pathare being deprecated and replaced with the
stack-rootflag and output field. Additionally, the stack root can now be specified via the
--stack-rootcommand-line flag. See #1148.
stack sigGPG-related sub-commands were removed (folded into
- GPG signing of packages while uploading to Hackage is now the default. Use
upload --no-signatureif you would rather not contribute your package signature. If you don’t yet have a GPG keyset, read this blog post on GPG keys. We can add a stack.yaml config setting to disable signing if some people desire it. We hope that people will sign. Later we will be adding GPG signature verification options.
stack build pkg-1.2.3will now build even if the snapshot has a different package version - it is treated as an extra-dep.
stack build local-pkg-1.2.3is an error even if the version number matches the local package #2028.
- Having a
nix:section no longer implies enabling nix build. This allows the user to globally configure whether nix is used (unless the project overrides the default explicitly). See #1924.
- Remove deprecated valid-wanted field.
- Docker: mount home directory in container #1949.
stack image: allow absolute source paths for
stack haddock --open [PACKAGE]opens the local haddocks in the browser.
- Fix too much rebuilding when enabling/disabling profiling flags.
stack build pkg-1.0will now build
pkg-1.0even if the snapshot specifies a different version (it introduces a temporary extra-dep)
- Experimental support for
gitpackages with submodules are supported by passing the
- When using hpack, only regenerate cabal files when hpack files change.
- hpack files can now be used in templates
stack ghcinow runs ghci as a separate process #1306
- Retry when downloading snapshots and package indices
- Many build options are configurable now in
build: library-profiling: true executable-profiling: true haddock: true haddock-deps: true copy-bins: true prefetch: true force-dirty: true keep-going: true test: true test-arguments: rerun-tests: true additional-args: ['-fprof'] coverage: true no-run-tests: true bench: true benchmark-opts: benchmark-arguments: -O2 no-run-benchmarks: true reconfigure: true cabal-verbose: true
- A number of URLs are now configurable, useful for firewalls. See #1794.
- Suggest causes when executables are missing.
- Improve the generated stack.yaml.
- Improve ghci results after :load Main module collision with main file path.
- Only load the hackage index if necessary #1883, #1892.
- init: allow local packages to be deps of deps #1965.
- Always use full fingerprints from GPG #1952.
- Default to using
gpg2and fall back to
- Add a flag for –verbosity silent.
haddock --openflag #1396.
- Package tarballs would fail to unpack. #1884.
- Fixed errant warnings about missing modules, after deleted and removed from cabal file #921 #1805.
- Now considers a package to dirty when the hpack file is changed #1819.
- Nix: cancelling a stack build now exits properly rather than dropping into a nix-shell #1778.
allow-newer: truenow causes
--exact-configurationto be passed to Cabal. See #1579.
stack solverno longer fails with
InvalidRelFilefor relative package paths including
... See #1954.
- Ignore emacs lock files when finding .cabal #1897.
- Use lenient UTF-8 decode for build output #1945.
- Clear index cache whenever index updated #1962.
- Fix: Building a container image drops a .stack-work dir in the current working (sub)directory #1975.
- Fix: Rebuilding when disabling profiling #2023.
- Don’t delete contents of ~/.ssh when using
stack clean --fullwith Docker enabled #2000
Build with path-io-1.0.0. There are no changes in behaviour from 1.0.4, so no binaries are released for this version.
Fixes build with aeson-0.11.0.0. There are no changes in behaviour from 1.0.4, so no binaries are released for this version.
- Some notable changes in
- Overall it should now be able to initialize almost all existing cabal packages out of the box as long as the package itself is consistently defined.
- Choose the best possible snapshot and add extra dependencies on top of a snapshot resolver rather than a compiler resolver - #1583
- Automatically omit a package (
--omit-packages) when it is compiler incompatible or when there are packages with conflicting dependency requirements - #1674.
- Some more changes for a better user experience. Please refer to the doc guide for details.
- Add support for hpack, alternative package description format #1679
- Docker: pass ~/.ssh and SSH auth socket into container, so that git repos work #1358.
- Docker: strip suffix from docker –version. #1653
- Docker: pass USER and PWD environment variables into container.
- On each run, stack will test the stack root directory (~/.stack), and the
project and package work directories (.stack-work) for whether they are
owned by the current user and abort if they are not. This precaution can
be disabled with the
allow-different-useroption in the global config (~/.stack/config.yaml). #471
stack clean --fulloption for full working dir cleanup.
- YAML config: support Zip archives.
- Redownload build plan if parsing fails #1702.
- Give mustache templates access to a ‘year’ tag #1716.
- Have “stack ghci” warn about module name aliasing.
- Add “stack ghci –load-local-deps”.
- Build Setup.hs with -rtsopts #1687.
stack initaccepts a list of directories.
- Add flag infos to DependencyPlanFailures (for better error output in case of flags) #713
stack new --barecomplains for overwrites, and add
stack ghciwould fail with
cannot satisfy -package-idwhen the implicit build step changes the package key of some dependency.
- Fix: Building with ghcjs: “ghc-pkg: Prelude.chr: bad argument: 2980338” #1665.
- Fix running test / bench with
- Fix: build progress counter is no longer visible #1685.
- Use “-RTS” w/ profiling to allow extra args #1772.
- Fix withUnpackedTarball7z to find name of srcDir after unpacking
stack setupfails for ghcjs project on windows) #1774.
- Add space before auto-generated bench opts (makes profiling options work uniformly for applications and benchmark suites) #1771.
- Don’t try to find plugin if it resembles flag.
- Setup.hs changes cause package dirtiness #1711.
- Send “stack templates” output to stdout #1792.
- Arch Linux: Stack has been adopted into the official community repository, so we will no longer be updating the AUR with new versions. See the install/upgrade guide for current download instructions.
- Disable locale/codepage hacks when GHC >=7.10.3 #1552
- Specify multiple images to build for
stack image containerdocs
- Specify which executables to include in images for
stack image containerdocs
- Docker: pass supplemantary groups and umask into container
- If git fetch fails wipe the directory and try again from scratch #1418
- Warn if newly installed executables won’t be available on the PATH #1362
- stack.yaml: for
stack image container, specify multiple images to generate, and which executables should be added to those images
- GHCI: add interactive Main selection #1068
- Care less about the particular name of a GHCJS sdist folder #1622
- Unified Enable/disable help messaging #1613
- Don’t share precompiled packages between GHC/platform variants and Docker #1551
- Properly redownload corrupted downloads with the correct file size. Mailing list discussion
- Gracefully handle invalid paths in error/warning messages #1561
- Nix: select the correct GHC version corresponding to the snapshot
even when an abstract resolver is passed via
--resolveron the command-line. #1641
- Fix: Stack does not allow using an external package from ghci #1557
- Disable ambiguous global ‘–resolver’ option for ‘stack init’ #1531
- Fix: GHCJS Execute.hs: Non-exhaustive patterns in lambda #1591
- Send file-watch and sticky logger messages to stderr #1302 #1635
- Use globaldb path for querying Cabal version #1647
- We’re calling this version 1.0.0 in preparation for Stackage LTS 4. Note, however, that this does not mean the code’s API will be stable as this is primarily an end-user tool.
- Added flag
--profileflag: passed with
stack build, it will enable profiling, and for
--testit will generate a profiling report by passing
+RTS -pto the executable(s). Great for using like
stack build --bench --profile(remember that enabling profile will slow down your benchmarks by >4x). Run
stack build --benchagain to disable the profiling and get proper speeds
- Added flag
--traceflag: just like
--profile, it enables profiling, but instead of generating a report for
--test, prints out a stack trace on exception. Great for using like
stack build --test --trace
- Nix: all options can be overriden on command line #1483
- Nix: build environments (shells) are now pure by default.
- Make verbosity silent by default in script interpreter mode #1472
- Show a message when resetting git commit fails #1453
- Improve Unicode handling in project/package names #1337
- Fix ambiguity between a stack command and a filename to execute (prefer
- Support multi line interpreter directive comments #1394
- Handle space separated pids in ghc-pkg dump (for GHC HEAD) #1509
- Add ghci –no-package-hiding option #1517
stack newcan download templates from URL #1466
- Nix: stack exec options are passed properly to the stack sub process #1538
- Nix: specifying a shell-file works in any current working directory #1547
- Nix: use
- Docker: fix missing image message and ‘–docker-auto-pull’
- No HTML escaping for “stack new” template params #1475
- Set permissions for generated .ghci script #1480
- Restrict commands allowed in interpreter mode #1504
- stack ghci doesn’t see preprocessed files for executables #1347
- All test suites run even when only one is requested #1550
- Edge cases in broken templates give odd errors #1535
- Fix test coverage bug on windows
stack image containerdid not actually build an image #1473
- The Stack home page is now at haskellstack.org, which shows the documentation rendered by readthedocs.org. Note: this has necessitated some changes to the links in the documentation’s markdown source code, so please check the links on the website before submitting a PR to fix them.
- The locations of the
package repositories have changed to have correct URL semantics according to
#1378. The old
locations will continue to work for some months, but we suggest that you
/etc/apt/sources.list.d/fpco.listto the new location to avoid future disruption.
- openSUSE and SUSE Linux Enterprise packages are now available, thanks to @mimi1vx. Note: there will be some lag before these pick up new versions, as they are based on Stackage LTS.
- Support for building inside a Nix-shell providing system dependencies #1285
- Add optional GPG signing on
stack upload --signor with
stack sig sign ...
- Print latest applicable version of packages on conflicts #508
- Support for packages located in Mercurial repositories #1397
- Only run benchmarks specified as build targets #1412
- Support git-style executable fall-through (
stack-somethingif present) #1433
- GHCi now loads intermediate dependencies #584
--work-diroption for overriding
- Docker: improved POSIX signal proxying to containers #547
- Show absolute paths in error messages in multi-package builds #1348
- Docker-built binaries and libraries in different path #911 #1367
--resolverargument didn’t effect selected image tag
- GHCi: Spaces in filepaths caused module loading issues #1401
- GHCi: cpp-options in cabal files weren’t used #1419
- Benchmarks couldn’t be run independently of eachother #1412
- Send output of building setup to stderr #1410
- GHCJS can now be used with stackage snapshots via the new
- Windows installers are now available: download them here #613
- Docker integration works with non-FPComplete generated images #531
- Added an
allow-newerconfig option #922 #770
- When a Hackage revision invalidates a build plan in a snapshot, trust the snapshot #770
- Added a
stack config set resolver RESOLVERcommand. Part of work on #115
stack setupcan now install GHCJS on windows. See #1145 and #749
stack hpc reportcommand added, which generates reports for HPC tix files
stack ghcinow accepts all the flags accepted by
stack build. See #1186
stack ghcibuilds the project before launching GHCi. If the build fails, optimistically launch GHCi anyway. Use
stack ghci --no-buildoption to disable #1065
stack ghcinow detects and warns about various circumstances where it is liable to fail. See #1270
- Packages will now usually be built along with their tests and benchmarks. See #1166
local-bin-pathpaths will be relative to the project’s root directory, not the current working directory. #1340
stack cleannow takes an optional
[PACKAGE]argument for use in multi-package projects. See #583
- Ignore cabal_macros.h as a dependency #1195
- Pad timestamps and show local time in –verbose output #1226
- GHCi: Import all modules after loading them #995
- Add subcommand aliases:
- Add typo recommendations for unknown package identifiers #158
stack path --local-hpc-rootoption
- Overhaul dependencies’ haddocks copying #1231
- Support for extra-package-dbs in ‘stack ghci’ #1229
stack newdisallows package names with “words” consisting solely of numbers #1336
stack build --fastturns off optimizations
- Show progress while downloading package index #1223.
- Fix: Haddocks not copied for dependencies #1105
- Fix: Global options did not work consistently after subcommand #519
- Fix: ‘stack ghci’ doesn’t notice that a module got deleted #1180
- Rebuild when cabal file is changed
- Fix: Paths in GHC warnings not canonicalized, nor those for packages in subdirectories or outside the project root #1259
- Fix: unlisted files in tests and benchmarks trigger extraneous second build #838
stack setupnow supports building and booting GHCJS from source tarball.
- On Windows, build directories no longer display “pretty” information (like x86_64-windows/Cabal-184.108.40.206), but rather a hash of that content. The reason is to avoid the 260 character path limitation on Windows. See #1027
- Rename config files and clarify their purposes #969
- Old locations still supported, with deprecation warnings
- New command “stack eval CODE”, which evaluates to “stack exec ghc – -e CODE”.
- No longer install
giton Windows #1046. You can still get this behavior by running the following yourself:
stack exec -- pacman -Sy --noconfirm git.
- Typing enter during –file-watch triggers a rebuild #1023
- Use Haddock’s
--hyperlinked-source(crosslinked source), if available #1070
- Use Stack-installed GHCs for
stack init --solver#1072
- New experimental
stack querycommand #1087
- By default, stack no longer rebuilds a package due to GHC options changes. This behavior can be tweaked with the
- By default, ghc-options are applied to all local packages, not just targets. This behavior can be tweaked with the
- Docker: download or override location of stack executable to re-run in container #974
- Docker: when Docker Engine is remote, don’t run containerized processes as host’s UID/GID #194
set-useroption to enable/disable running containerized processes as host’s UID/GID #194
- Custom Setup.hs files are now precompiled instead of interpreted. This should be a major performance win for certain edge cases (biggest example: building Cabal itself) while being either neutral or a minor slowdown for more common cases.
stack test --coveragenow also generates a unified coverage report for multiple test-suites / packages. In the unified report, test-suites can contribute to the coverage of other packages.
- Ignore stack-built executables named
- Fix quoting of output failed command line arguments
- Mark executable-only packages as installed when copied from cache #1043
- Canonicalize temporary directory paths #1047
- Put code page fix inside the build function itself #1066
explicit-setup-depsoption #1110, and change the default to the old behavior of using any package in the global and snapshot database #1025
- Precompiled cache checks full package IDs on Cabal < 1.22 #1103
- Pass -package-id to ghci #867
- Ignore global packages when copying precompiled packages #1146
- On Windows, we now use a full MSYS2 installation in place of the previous PortableGit. This gives you access to the pacman package manager for more easily installing libraries.
- Support for custom GHC binary distributions #530
ghc-variantoption in stack.yaml to specify the variant (also
setup-infoin stack.yaml, to specify where to download custom binary distributions (also
- Note: On systems with libgmp4 (aka
libgmp.so.3), such as CentOS 6, you may need to re-run
stack setupdue to the centos6 GHC bindist being treated like a variant
- A new
--pvp-boundsflag to the sdist and upload commands allows automatic adding of PVP upper and/or lower bounds to your dependencies
- Adapt to upcoming Cabal installed package identifier format change #851
stack setuptakes a
--file-watchis more discerning about which files to rebuild for #912
stack pathnow supports
--reconfigureflag #914 #946
- Cached data is written with a checksum of its structure #889
- Fully removed
--file-watch-pollflag for polling instead of using filesystem events (useful for running tests in a Docker container while modifying code in the host environment. When code is injected into the container via a volume, the container won’t propagate filesystem events).
- Give a preemptive error message when
-profis given as a GHC option #1015
- Locking is now optional, and will be turned on by setting the
STACK_LOCKenvironment variable to
- Create default stack.yaml with documentation comments and commented out options #226
- Out of memory warning if Cabal exits with -9 #947
- Hacky workaround for optparse-applicative issue with
stack exec --help#806
- Build executables for local extra deps #920
- copyFile can’t handle directories #942
- Support for spaces in Haddock interface files fpco/minghc#85
- Temporarily building against a “shadowing” local package? #992
- Fix Setup.exe name for –upgrade-cabal on Windows #1002
- Unlisted dependencies no longer trigger extraneous second build #838
Fix stack’s own Haddocks. No changes to functionality (only comments updated).
- You now have more control over how GHC versions are matched, e.g. “use exactly this version,” “use the specified minor version, but allow patches,” or “use the given minor version or any later minor in the given major release.” The default has switched from allowing newer later minor versions to a specific minor version allowing patches. For more information, see #736 and #784.
- Support added for compiling with GHCJS
- stack can now reuse prebuilt binaries between snapshots. That means that, if you build package foo in LTS-3.1, that binary version can be reused in LTS-3.2, assuming it uses the same dependencies and flags. #878
- Added the
--docker-envargument, to set environment variables in Docker container.
- Set locale environment variables to UTF-8 encoding for builds to avoid “commitBuffer: invalid argument” errors from GHC #793
- Enable translitation for encoding on stdout and stderr #824
- By default,
stack upgradeautomatically installs GHC as necessary #797
- Added the
ghc-optionsfield to stack.yaml #796
- Added the
extra-pathfield to stack.yaml
- Code page changes on Windows only apply to the build command (and its synonyms), and can be controlled via a command line flag (still defaults to on) #757
- Implicitly add packages to extra-deps when a flag for them is set #807
- Use a precompiled Setup.hs for simple build types #801
- Set –enable-tests and –enable-benchmarks optimistically #805
--only-configureoption added #820
- Check for duplicate local package names
- Stop nagging people that call
--file-watchwill ignore files that are in your VCS boring/ignore files #703
stack init --solverfails if
GHC_PACKAGE_PATHis present #860
stack init --solvercheck for test suite and benchmark dependencies #862
- More intelligent logic for setting UTF-8 locale environment variables #856
- Create missing directories for
- Don’t ignore .cabal files with extra periods #895
- Deprecate unused
- Truncated output on slow terminals #413
- Ignore disabled executables #763
- Detect when a module is compiled but not listed in the cabal file (#32)
- A warning is displayed for any modules that should be added to
other-modulesin the .cabal file
- These modules are taken into account when determining whether a package needs to be built
- A warning is displayed for any modules that should be added to
- Respect TemplateHaskell addDependentFile dependency changes (#105)
- TH dependent files are taken into account when determining whether a package needs to be built.
- Overhauled target parsing, added
- For details, see Build commands documentation
- Set the
HASKELL_DIST_DIRenvironment variable #524
- Track build status of tests and benchmarks #525
- Targets outside of root dir don’t build #366
- Upper limit on number of flag combinations to test #543
- Fuzzy matching support to give better error messages for close version numbers #504
--local-bin-pathglobal option. Use to change where binaries get placed on a
- Custom snapshots #111
- –force-dirty flag: Force treating all local packages as having dirty files (useful for cases where stack can’t detect a file change)
- GHC error messages: display file paths as absolute instead of relative for better editor integration
- Add the
- Give warnings on unexpected config keys #48
- Remove Docker
- Don’t require cabal-install to upload #313
- Generate indexes for all deps and all installed snapshot packages #143
--resolver globaloption #645
- Also supports
--resolver lts, and
- Also supports
stack build --flagerror when flag or package is unknown #617
- Preserve file permissions when unpacking sources #666
stack buildetc work outside of a project
--only-dependenciesimplemented correctly #387
- Extensions from the
other-extensionsfield no longer enabled by default #449
- Fix: haddock forces rebuild of empty packages #452
- Don’t copy over executables excluded by component selection #605
- Fix: stack fails on Windows with git package in stack.yaml and no git binary on path #712
- Fixed GHCi issue: Specifying explicit package versions (#678)
- Fixed GHCi issue: Specifying -odir and -hidir as .stack-work/odir (#529)
- Fixed GHCi issue: Specifying A instead of A.ext for modules (#498)
--ignore-subdirsflag to init command #435
- Handle attempt to use non-existing resolver #436
- exec style commands accept the
--packageoption (see Reddit discussion)
stack uploadwithout arguments doesn’t do anything #439
- Print latest version of packages on conflicts #450
- Flag to avoid rerunning tests that haven’t changed #451
- stack can act as a script interpreter (see [Script interpreter] (https://github.com/commercialhaskell/stack/wiki/Script-interpreter) and Reddit discussion)
- Add the
--file-watchflag to auto-rebuild on file changes #113
stack docker execto
stack exec --plain
- Add the
--keep-going, turned on by default for tests and benchmarks #478
- Use hashes to check file dirtiness #502
- Install correct GHC build on systems with libgmp.so.3 #465
stack upgradechecks version before upgrading #447
- Remove GHC uncompressed tar file after installation #376
- Put stackage snapshots JSON on S3 #380
- Specifying flags for multiple packages #335
- single test suite failure should show entire log #388
- valid-wanted is a confusing option name #386
- stack init in multi-package project should use local packages for dependency checking #384
- Display information on why a snapshot was rejected #381
- Give a reason for unregistering packages #389
stack execaccepts the
- Don’t require build plan to upload #400
- Specifying test components only builds/runs those tests #398
- Add the
stack upgradeadded #237
--stack-yamlcommand line flag #378
--skip-ghc-checkcommand line flag #423
- Haddock links to global packages no longer broken on Windows #375
- Make flags case-insensitive #397
- Mark packages uninstalled before rebuilding #365
- Fall back to cabal dependency solver when a snapshot can’t be found
- Basic implementation of
stack solvercommand #364
stack pathcommand #95
- Haddocks #143:
- Build for dependencies
- Use relative links
- Generate module contents and index for all packages in project
uploadcommand ported from stackage-upload #225
- Specify intra-package target #201
- Fix some Windows specific bugs #216
- Improve output for package index updates #227
- Automatically update indices as necessary #227
- –verbose flag #217
- Remove packages (HTTPS and Git) #199
- Config values for system-ghc and install-ghc
stack depsfunctionality into
installcommand #153 and #272
- overriding architecture value (useful to force 64-bit GHC on Windows, for example)
- Overhauled test running (allows cycles, avoids unnecessary recompilation, etc)
- First public release, beta quality