Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐞SPFx - Update serve.json's schema to include serveConfigurations for IntelliSense #8309

Closed
1 of 9 tasks
andrewconnell opened this issue Jul 15, 2022 · 4 comments
Closed
1 of 9 tasks
Assignees
Labels
area:spfx Category: SharePoint Framework (not extensions related) type:bug-suspected Suspected bug (not working as designed/expected). See “type:bug-confirmed” for confirmed bugs.
Milestone

Comments

@andrewconnell
Copy link
Collaborator

Target SharePoint environment

other (enter in the "Additional environment details" area below)

What SharePoint development model, framework, SDK or API is this about?

💥 SharePoint Framework

Developer environment

macOS

What browser(s) / client(s) have you tested

  • 💥 Internet Explorer
  • 💥 Microsoft Edge
  • 💥 Google Chrome
  • 💥 FireFox
  • 💥 Safari
  • mobile (iOS/iPadOS)
  • mobile (Android)
  • not applicable
  • other (enter in the "Additional environment details" area below)

Additional environment details

All SPFx projects, but mostly an issue with SPFx extensions

Describe the bug / error

The schema for ./config/serve.json, https://developer.microsoft.com/json-schemas/core-build/serve.schema.json, is missing the section serveConfigurations.

This means developers won't get IntelliSense with included docs when editing this file. Can be resolved by fixed by updating the schema to include & doc up all the options for serveConfigurations.

Screen Shot 2022-07-15 at 8 04 44 AM

Steps to reproduce

  1. Create new project
  2. Use any type of component when prompted
  3. Open said project in VSCode
  4. Open ./config/serve.json
  5. Move mouse over serveConfigurations property and observe tooltip warning "Property serveConfigurations is not allowed"
  6. Developer curses at VSCode and 😭 in solitude... kittens rush for safety to avoid being kicked by said developer

Expected behavior

  1. Create new project
  2. Use any type of component when prompted
  3. Open said project in VSCode
  4. Open ./config/serve.json
  5. Observe IntelliSense when modifying values under the included serveConfigurations
  6. The Microsoft engineer who took the time to update this file, on their way home from work to enjoy a good streaming movie, when picking up their take-out tacos 🌮, comes to find out someone paid it forward as thanks and now they enjoy free 🌮 for their contribution to developers across the globe.
@andrewconnell andrewconnell added the type:bug-suspected Suspected bug (not working as designed/expected). See “type:bug-confirmed” for confirmed bugs. label Jul 15, 2022
@ghost
Copy link

ghost commented Jul 15, 2022

Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible.

@ghost ghost added the Needs: Triage 🔍 Awaiting categorization and initial review. label Jul 15, 2022
@andrewconnell andrewconnell changed the title 🐞SFPx - Update serve.json's schema to include serveConfigurations for IntelliSense 🐞SPFx - Update serve.json's schema to include serveConfigurations for IntelliSense Jul 15, 2022
@AJIXuMuK AJIXuMuK added area:spfx Category: SharePoint Framework (not extensions related) and removed Needs: Triage 🔍 Awaiting categorization and initial review. labels Jul 15, 2022
@AJIXuMuK AJIXuMuK self-assigned this Jul 20, 2022
@AJIXuMuK
Copy link
Collaborator

Thanks @andrewconnell - this will be fixed in the next release

@AJIXuMuK AJIXuMuK added this to the 1.15.0-next milestone Jul 21, 2022
@AJIXuMuK
Copy link
Collaborator

AJIXuMuK commented Aug 2, 2022

1.15.2 is out - this should be fixed

@AJIXuMuK AJIXuMuK closed this as completed Aug 2, 2022
@ghost
Copy link

ghost commented Aug 9, 2022

Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: Issue List: Our approach to locked issues

@ghost ghost locked as resolved and limited conversation to collaborators Aug 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area:spfx Category: SharePoint Framework (not extensions related) type:bug-suspected Suspected bug (not working as designed/expected). See “type:bug-confirmed” for confirmed bugs.
Projects
None yet
Development

No branches or pull requests

2 participants