With the introduction of manifest file support, the CLI is now capable of handling both lockfiles and manifests. Agreement was reached on using the term "dependency file" to represent either a lockfile or a manifest (e.g., generically or before the distinction is clear). Further, depfile may be used in situations were the abbreviation is warranted.
The language in this repository needs to change to reflect this...in arguments, interfaces, documentation, code, comments, help output, etc.
This will likely cause breaking changes so it should be done all at one time and in coordination with consumers of the CLI and it's crates. Here is a sampling of the expected changes that are likely to be breaking (but not necessarily a complete list):
find-lockable-files command
--lockfile-type arguments
--lockfile optional arguments (e.g., init)
lockfiles key in .phylum_project
lockfiles key in phylum status --json output
Extension API
parseLockfile
types and members of types
Care should be taken to ensure a global search and replace is not attempted since there are still instances where it makes sense to talk specifically about lockfiles or specifically about manifests.
Creating a release of the CLI with these changes should be done in coordination with documentation updates and releases of the tools that depend on the CLI.
With the introduction of manifest file support, the CLI is now capable of handling both lockfiles and manifests. Agreement was reached on using the term "dependency file" to represent either a lockfile or a manifest (e.g., generically or before the distinction is clear). Further,
depfilemay be used in situations were the abbreviation is warranted.The language in this repository needs to change to reflect this...in arguments, interfaces, documentation, code, comments, help output, etc.
This will likely cause breaking changes so it should be done all at one time and in coordination with consumers of the CLI and it's crates. Here is a sampling of the expected changes that are likely to be breaking (but not necessarily a complete list):
find-lockable-filescommand--lockfile-typearguments--lockfileoptional arguments (e.g.,init)lockfileskey in.phylum_projectlockfileskey inphylum status --jsonoutputparseLockfileCare should be taken to ensure a global search and replace is not attempted since there are still instances where it makes sense to talk specifically about lockfiles or specifically about manifests.
Creating a release of the CLI with these changes should be done in coordination with documentation updates and releases of the tools that depend on the CLI.