Skip to content
This repository has been archived by the owner on Nov 13, 2023. It is now read-only.

[next] Update config schema to improve IntelliSense #751

Merged
merged 7 commits into from
Mar 23, 2022
Merged

Conversation

t1m0thyj
Copy link
Member

@t1m0thyj t1m0thyj commented Mar 9, 2022

⚠️ Publish #748 to @next tag before merging this PR

  • Fix Add Intellisense to secure array in zowe.config.json zowe-cli#1187
    • Breaking change because prefixItems property parsed by loadSchema for the secure array was renamed to items
  • Fix Hover over zowe V2 profile in VSCode is incorrect zowe-cli#1303
    • Breaking change because if.properties.type parsed by loadSchema can now be false rather than an object
  • Add enum to schema for profiles.XXX.type so that IntelliSense suggests known profile types
  • Improve description for config JSON properties so that IntelliSense shows more helpful tooltips
  • Get engineering review of schema changes (see comment below)
    • Remove duplicate values from IntelliSense suggestions for secure array
    • Fix VS Code not underlining unknown value for type property
  • Add optional autoStore boolean property to schema? Yes
  • Add experimental plugins array property to schema? No
  • Get docs review of new descriptions (IntelliSense tooltips)
  • Update old ($version < 4) schemas used in tests
  • Update changelog

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
@t1m0thyj
Copy link
Member Author

Investigated the following comments from engineering review:

  • Remove duplicate values from IntelliSense suggestions for secure array

    This seems like a VS Code limitation, since we are defining enough info for jsonschemavalidator.net to detect this:
    image

  • Fix VS Code not underlining unknown value for type property

    This also seems like a VS Code limitation, since we are defining enough info for IntelliJ to provide tips about this:
    image

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
@t1m0thyj t1m0thyj marked this pull request as ready for review March 16, 2022 14:52
@codecov
Copy link

codecov bot commented Mar 16, 2022

Codecov Report

Merging #751 (e6d2fcb) into next (364a586) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             next     #751   +/-   ##
=======================================
  Coverage   88.85%   88.85%           
=======================================
  Files         197      197           
  Lines       10301    10302    +1     
  Branches     1978     1979    +1     
=======================================
+ Hits         9153     9154    +1     
  Misses       1144     1144           
  Partials        4        4           
Impacted Files Coverage Δ
packages/config/src/ProfileInfo.ts 96.33% <ø> (ø)
packages/config/src/ConfigSchema.ts 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d5cc707...e6d2fcb. Read the comment docs.

Copy link
Member

@awharn awharn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@t1m0thyj t1m0thyj mentioned this pull request Mar 18, 2022
9 tasks
@t1m0thyj t1m0thyj changed the title Update config schema to improve IntelliSense [next] Update config schema to improve IntelliSense Mar 21, 2022
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
@sonarcloud
Copy link

sonarcloud bot commented Mar 23, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

95.8% 95.8% Coverage
0.0% 0.0% Duplication

Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the newly introduced schemas.
Much appreciated! 😋

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants