Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 2.95 KB

modify.md

File metadata and controls

69 lines (50 loc) · 2.95 KB

flub modify

Modify commands are used to modify projects to add or remove dependencies, update Fluid imports, etc.

flub modify fluid-imports

Rewrite imports for Fluid Framework APIs to use the correct subpath import (/beta, /legacy, etc.)

USAGE
  $ flub modify fluid-imports [-v | --quiet] [--tsconfigs <value>...] [--packageRegex <value>] [--data <value>]
    [--onlyInternal]

FLAGS
  --data=<value>          Optional path to a data file containing raw API level data. Overrides API levels extracted
                          from package data.
  --onlyInternal          Use /internal for all non-public APIs instead of /beta or /legacy.
  --packageRegex=<value>  Regular expression filtering import packages to adjust
  --tsconfigs=<value>...  [default: ./tsconfig.json] Tsconfig file paths that will be used to load project files. When
                          multiple are given all must depend on the same version of packages; otherwise results are
                          unstable.

LOGGING FLAGS
  -v, --verbose  Enable verbose logging.
      --quiet    Disable all logging.

DESCRIPTION
  Rewrite imports for Fluid Framework APIs to use the correct subpath import (/beta, /legacy, etc.)

See code: src/commands/modify/fluid-imports.ts

flub modify lockfile PACKAGE_OR_RELEASE_GROUP

Updates a dependency in the pnpm lockfile to the latest version of a specified semver range.

USAGE
  $ flub modify lockfile PACKAGE_OR_RELEASE_GROUP --dependencyName <value> --version <value> [--json] [-v | --quiet]

ARGUMENTS
  PACKAGE_OR_RELEASE_GROUP  [default: client] The name of a package or a release group. Defaults to the client release
                            group if not specified.

FLAGS
  --dependencyName=<value>  (required) Name of the dependency (npm package) to update.
  --version=<value>         (required) A semver version or range specifier (e.g. ^1.2.3) to use when updating the
                            dependency.

LOGGING FLAGS
  -v, --verbose  Enable verbose logging.
      --quiet    Disable all logging.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Updates a dependency in the pnpm lockfile to the latest version of a specified semver range.

  Note that if the version passed in to the command is not within the range of versions naturally accepted by the
  packages that depend on it, after this command runs the lockfile might not reflect the version that was passed in, but
  the latest version that complies with the semver range declared by the dependent packages.

See code: src/commands/modify/lockfile.ts