All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Changes:
- Package structure change:
dist/purescript-docs-search.cjs
has been moved todist/purescript-docs-search.cjs
due to NodeJS restrictions fortype: module
packages. - Improve output for data and newtype constuctors (#58)
New features:
- Docs for each CLI option
- New
--source-files
option that allows to specify.purs
sources (see below)
Bugfixes:
- Include modules with only re-exports in the module list (#62)
- Fix
docs.json
parser for some types
Changes:
- Adapt JSON API for use with PureScript v0.14.
New features:
- Add
--package-name
flag to allow passing local package name.
Changes:
- Group modules by default.
- Add local package modules and
Prim*
modules to the sidebar. - UI tests, using purescript-toppokki.
New features:
- Implement sorting by package popularity for declarations.
- Add app version info to the footer.
- Scroll to document top when search bar gets focus.
- Group modules by package in the sidebar (#34)
Bugfixes:
- Fix CLI autocompleter (now works correctly with capital letters).
Skipped due to failed deployment.
Changes:
- Consider something a builtin when there's no
sourceSpan
(#32)
New features:
- Allow using the app as a search engine (show search term in URI hash) (#26)
New features:
- Render docs as markdown (#15)
- Show help for each CLI command (#17)
- Add packages to the search index (#16)
- Sort search results by popularity (based on number of package reverse dependencies).
- Add
--no-patch
flag tobuild-index
command.
Bugfixes:
- Fix decoding of kind annotations in
forall
s (#17) - Fix rendering for variable-parametrized records (e.g.
Record a
) and type-level strings.
New features:
- Reduce the package size by using a minifier.
- Add
version
command to print the app version. - S hotkey now
.select()
s everything in the search field, insetead of just.focus()
ing (#11).
Bugfixes:
- Fix stack safety issue (#8).