ghcide/bench/README.md


# Benchmarks

This folder contains two Haskell programs that work together to simplify the
performance analysis of ghcide:

- `exe/Main.hs` - a standalone benchmark suite. Run with `stack bench`
- `hist/Main.hs` - a Shake script for running the benchmark suite over a set of commits.
  - Run with `stack exec benchHist`,
  - Requires a `ghcide-bench` binary in the PATH,
  - Calls `stack` internally to build the project,
  - Driven by the `hist.yaml` configuration file. By default it compares HEAD with upstream

Further details available in the module header comments.
Performance analysis over time (#629) * benchmark history script * if HEAD no need to rebuild worktree * add bench/README.md * Enable all experiments * Fix dependency tracking for git branches * hlints * Add stack84 extra-deps * Identify failed experiments in graphs * Filter our failed benchmarks from aggregate graphs Otherwise they tend to distort the axis * Improve graphs (more and easier to see colors) * update cradles * customizable output folder * Cache the config for the duration of the script Otherwise the script is vulnerable to config edits * Allow omitting the git: field * Ignore bench-hist intermediate artifacts Handy for including bench-hist results in a branch while avoiding the intermediate artifacts 2020-06-15 14:56:24 +03:00
			`# Benchmarks`

			`This folder contains two Haskell programs that work together to simplify the`
			`performance analysis of ghcide:`

Send WorkDoneProgressEnd only when work is done (#649) * send WorkDoneProgressEnd only when work done * Progress reporting now spans over multiple overlapping kicks * Repurpose benchmark experiments as tests Fixes #650 * use stack to fetch from Hackage * benchmark tests run with the same lsp-test config as other tests * Fix stack cradle in benchmark * Make stack unpack --silent * Fix issues in "code actions after edit" experiment - Repeated breaking edits make ghc run out of suggestions - Diagnostics seem to come and go in-between edits, which leads to a timing issue when asking for code actions. The fix is to wait for diagnostics to be present before asking for code actions * Fix stack.yaml generation in example project * Fix getDefinition in GHC 8.4 Did it break before 0.2.0 or after? * better naming for the progress event TVar * stop progress reporting in shakeShut https://github.com/digital-asset/ghcide/pull/649#discussion_r443408884 * hlint 2020-06-22 13:47:45 +03:00			- `exe/Main.hs` - a standalone benchmark suite. Run with `stack bench`
Performance analysis over time (#629) * benchmark history script * if HEAD no need to rebuild worktree * add bench/README.md * Enable all experiments * Fix dependency tracking for git branches * hlints * Add stack84 extra-deps * Identify failed experiments in graphs * Filter our failed benchmarks from aggregate graphs Otherwise they tend to distort the axis * Improve graphs (more and easier to see colors) * update cradles * customizable output folder * Cache the config for the duration of the script Otherwise the script is vulnerable to config edits * Allow omitting the git: field * Ignore bench-hist intermediate artifacts Handy for including bench-hist results in a branch while avoiding the intermediate artifacts 2020-06-15 14:56:24 +03:00			- `hist/Main.hs` - a Shake script for running the benchmark suite over a set of commits.
			- Run with `stack exec benchHist`,
			- Requires a `ghcide-bench` binary in the PATH,
			- Calls `stack` internally to build the project,
			- Driven by the `hist.yaml` configuration file. By default it compares HEAD with upstream

			`Further details available in the module header comments.`