Skip to content

Zowe V3: Considered Changes

Adam Wolfe edited this page Aug 1, 2024 · 4 revisions

This is a list of the possible changes that the CLI squad has considered for the Zowe V3 release.

  • Migrate the imperative into the zowe/cli monorepo
    • Rename it - "framework-for-zowe-sdk"
      • Renaming won't be done for V3
    • OR merge it into the @zowe/core-for-zowe-sdk package
      • Merging with core won't be done for V3
  • Remove deprecated zowe profiles commands.
    • Keep zowe-v1-profile.READ for conversion purposes
      • Possibly add a Conformance criteria item around this
    • Replace the use of zowe profiles commands in automated tests.
  • Remove deprecated constants, options and methods
  • Imp & CLI: Remove dual-logic for ZOWE_V3_ERR_FORMAT
  • Update versions of dependencies to remain current - typescript, eslint, etc
  • CLI: Deprecate @zowe/perf-timing now and remove for V3.
  • ZE: Use FileSystemProvider class to access remote files (In progress)
  • ZE: Add madge in CI to check for circular dependencies
  • ZE: Migrate from CLI package to Zowe SDKs
  • CLI: Change default error message behavior to colorized, condensed form. Create debug mode that shows larger error message. Relocate pertinent error details to top or bottom of screen in debug mode
  • Deprecate Base profiles.
    • If time permits, deprecate in V2 AND decouple from future APIML profile types in V3.
  • Deprecate the settings/imperative.json file AND Move those settings into the Team Config file
    • If CLI squad confirms that it can be implemented cleanly in the CredentialManager-related APIs.
  • Add property validation (on by default?) for zowe config set based on schema
  • ZE: Migrate settings from workspace config to localStorage (In progress)
  • CLI: deprecate getDataSet from ZosFiles.utils in the @zowe/cli package and move it to the files SDK. Should we deprecate in V2 and remove in V3?
  • Consider merging tokenType and tokenValue into tokens: { [key: string]: string }
    { 
       "apimlToken": "some-long-token-value",
       "zosmfToken": "some-long-token-value",
       "myServiceToken": "some-long-token-value"
    } 
    
  • CLI: Conformance criteria for offline installability zowe-cli#1698
  • CLI: Provide sample Jenkinsfiles
  • Imp: Remove unused code that attempts to place the daemon on user's PATH
  • Imp: add REST client methods that accept key-value object of query parameters
  • ZE: ZoweDatasetNode should receive an options object for its constructor
  • Imp: reorder (alphabetically) all command options in ICommandDefinition. (May affect plug-in developers)
  • V4?: Imp: Rename ISession.hostname to host
  • V4?: Refactor our collection of confusing auth handler APIs - IAuthHandlerApi, BaseAuthHandler, AbstractAuthHandler, ApimlAuthHandler, etc. Consider extenders like VSCEs and plugins.