File: MIGRATION.md

package info (click to toggle)
golang-github-withfig-autocomplete-tools 0.0~git20241029.747689a%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,456 kB
  • sloc: javascript: 2,543; python: 734; sh: 20; makefile: 13
file content (10 lines) | stat: -rw-r--r-- 720 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
# Migration docs

## @withfig/commander@1 to @fig/complete-commander@2

The first granted thing you can note is that we renamed the package to use the `@fig` namespace and a more significative name.

This is not the only change occurred because we also changed the name, the signature, the options and the effects of the `generateFigSpec` function:
- In v1 the main function was `generateFigSpec` while now it is named `generateCompletionSpec`
- In v1 you had to specify a file as the destination of the spec while in v2 the spec gets returned as a `string` from `generateCompletionSpec`.
- In v1 the name of the default command added to the commander program was `generateFigSpec` while in v2 it is `generate-fig-spec`