CLI

Synopsis

dendron dev <cmd>

commands related to development of Dendron

Positionals:
  cmd  a command to run
      [string] [required] [choices: "generate_json_schema_from_config", "build",
      "bump_version", "publish", "sync_assets", "prep_plugin", "package_plugin",
    "install_plugin", "enable_telemetry", "disable_telemetry", "show_telemetry",
                                             "show_migrations", "run_migration"]

Options:
  --version           Show version number                              [boolean]
  --help              Show help                                        [boolean]
  --wsRoot            root directory of the Dendron workspace
  --vault             name of vault
  --quiet             don't print output to stdout
  --upgradeType       how to do upgrade
                              [choices: "major", "minor", "patch", "prerelease"]
  --publishEndpoint   where to publish              [choices: "local", "remote"]
  --extensionTarget   extension name to publish in the marketplace
                                                 [choices: "dendron", "nightly"]
  --fast              skip some checks
  --migrationVersion  migration version to run

Common Options

upgradeType

  • value: patch|minor

What next semver version to upgrade to

Commands

prep_plugin

Prepare plugin by updating package.json. Performs the following operations:

  • change target name
  • update target license
  • remove testing dependencies

package_plugin

Bundle plugin. Equivalent to the following

yarn install --no-lockfile
yarn build:prod
vsce package --yarn

Options:

  • --fast: when set, skip installing packages, skip uploading to sentry

Env

  • ANALYZE_BUNDLE: if set, create a treemap of dependencies using webpack-bundle-analyzer
  • DETECT_CIRCULAR_DEPS: if set, calculate circular dependencies

build

Build vsix for a given upgradeType upgrade Runs the build from end to run

Options:

  • --fast: when building fast mode, the following is skipped:
    • initial type checking
    • restoring package.json and plugin-core to original state
    • do not rebuild assets when running sync_assets (Private)
    • do not upload source map to sentry


Children
  1. Build
  2. Create Test Vault
  3. Package Plugin