feat!: remove deprecated CLI switches --schema-version and --outfile, use --spec-version and --output-file instead (#892)

Closes #873.

---------

Signed-off-by: virgo-o <[email protected]>

Author: virgo-o

cyclonedx_py/_internal/cli.py

@@ -68,13 +68,6 @@ def make_argument_parser(cls, sco: ArgumentParser, **kwargs: Any) -> ArgumentPar
                         action='store_true',
                         dest='short_purls',
                         default=False)
-        op.add_argument('--schema-version',  # DEPRECATED
-                        metavar='<version>',
-                        help='DEPRECATED alias for option "--spec-version".',
-                        dest='spec_version',
-                        choices=SchemaVersion,
-                        type=SchemaVersion.from_version,
-                        default=SchemaVersion.V1_6.to_version())
         op.add_argument('--sv', '--spec-version',
                         metavar='<version>',
                         help='Which version of CycloneDX to use.'
@@ -99,12 +92,6 @@ def make_argument_parser(cls, sco: ArgumentParser, **kwargs: Any) -> ArgumentPar
                         choices=OutputFormat,
                         type=argparse_type4enum(OutputFormat),
                         default=OutputFormat.JSON.name)
-        op.add_argument('--outfile',  # DEPRECATED
-                        metavar='<file>',
-                        help='DEPRECATED alias for "--output-file".',
-                        type=FileType('wt', encoding='utf8'),
-                        dest='output_file',
-                        default=OPTION_OUTPUT_STDOUT)
         op.add_argument('-o', '--output-file',
                         metavar='<file>',
                         help='Path to the output file.'

docs/usage.rst

@@ -79,8 +79,6 @@ The full documentation can be issued by running with ``environment --help``:
                             (default: application)
       --short-PURLs         Omit all qualifiers from PackageURLs.
                             This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings.
-      --schema-version <version>
-                            DEPRECATED alias for "--spec-version"
       --sv <version>, --spec-version <version>
                             Which version of CycloneDX to use.
                             {choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
@@ -92,7 +90,6 @@ The full documentation can be issued by running with ``environment --help``:
                             Which output format to use.
                             {choices: JSON, XML}
                             (default: JSON)
-      --outfile <file>      DEPRECATED alias for "--output-file".
       -o <file>, --output-file <file>
                             Path to the output file.
                             (set to "-" to output to STDOUT)
@@ -253,8 +250,6 @@ The full documentation can be issued by running with ``pipenv --help``:
                             (default: application)
       --short-PURLs         Omit all qualifiers from PackageURLs.
                             This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings.
-      --schema-version <version>
-                            DEPRECATED alias for "--spec-version"
       --sv <version>, --spec-version <version>
                             Which version of CycloneDX to use.
                             {choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
@@ -266,7 +261,6 @@ The full documentation can be issued by running with ``pipenv --help``:
                             Which output format to use.
                             {choices: JSON, XML}
                             (default: JSON)
-      --outfile <file>      DEPRECATED alias for "--output-file".
       -o <file>, --output-file <file>
                             Path to the output file.
                             (set to "-" to output to STDOUT)
@@ -331,8 +325,6 @@ The full documentation can be issued by running with ``poetry --help``:
                             (default: application)
       --short-PURLs         Omit all qualifiers from PackageURLs.
                             This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings.
-      --schema-version <version>
-                            DEPRECATED alias for "--spec-version"
       --sv <version>, --spec-version <version>
                             Which version of CycloneDX to use.
                             {choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
@@ -344,7 +336,6 @@ The full documentation can be issued by running with ``poetry --help``:
                             Which output format to use.
                             {choices: JSON, XML}
                             (default: JSON)
-      --outfile <file>      DEPRECATED alias for "--output-file".
       -o <file>, --output-file <file>
                             Path to the output file.
                             (set to "-" to output to STDOUT)
@@ -405,8 +396,6 @@ The full documentation can be issued by running with ``requirements --help``:
                             (default: application)
       --short-PURLs         Omit all qualifiers from PackageURLs.
                             This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings.
-      --schema-version <version>
-                            DEPRECATED alias for "--spec-version"
       --sv <version>, --spec-version <version>
                             Which version of CycloneDX to use.
                             {choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
@@ -418,7 +407,6 @@ The full documentation can be issued by running with ``requirements --help``:
                             Which output format to use.
                             {choices: JSON, XML}
                             (default: JSON)
-      --outfile <file>      DEPRECATED alias for "--output-file".
       -o <file>, --output-file <file>
                             Path to the output file.
                             (set to "-" to output to STDOUT)