microsoft / microsoft/BotFramework-WebChat
Discussion: Move Web Chat (and all of Bot Framework!) to scoped packaging
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.8k
- Forks
- 1.6k
- Avg merge
- 22h 58m
- Merged PRs (30d)
- 2
Description
Feature Request
Related to #2025
Is your feature request related to a problem? Please describe.
Right now, Web Chat is not part of scoped packaging on npm, meaning that if a user wants to change to the myget registry, they must change the entire registry in order to do so.
Scoped packaging, (for an arbitrary example: @botframework/webchat), would provide the following benefits:
- Publishing within scope is of course limited to within the Bot Framework team
- It expands our package naming ability under the @ botframework scope
- Switching npm registry can be done via scope
Describe the suggestion or request in detail
To quote my original ask on #2025,
I want to confirm with the team whether or not we want to make Web Chat a scoped package. Doing this would allow our users to point to myget for the Web Chat project without having to change the entire project registry to myget. (For example, without scoped packages, changing the registry means that react-scripts, a non-dependency of Web Chat, would also be pointing to myget).
Taking a look at the other BotBuilder projects, it looks like they are not using scope, meaning that we would be the frontier runners in trying this out.
Describe alternatives you have considered
We could keep our projects as-is. However, keeping our projects non-scoped would mean a higher learning curve for users when trying to use our private registries.
Additional context
If two packages are part of the same scope, it would still be possible [to] specify different registries on a case-by-case basis:
- We can change the registry for a specific scope; a scope can only have ONE active registry
- If we want to install a scoped package from a different registry, we have to use npm i (package) --registry (registryURL)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review this issue and related issue #2025 first; no source files or tests are identified. Determine whether Web Chat and the other Bot Framework packages should move under the @botframework npm scope, and document the registry and package-naming implications. Done requires an explicit team decision and an agreed migration scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100