Skip to content
This repository has been archived by the owner on May 17, 2021. It is now read-only.

Commit

Permalink
note about npmjs build metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
whatatripp committed May 4, 2020
1 parent 8a09aa2 commit d240879
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions ProGet/feeds/npm.md
Expand Up @@ -7,12 +7,18 @@ show-headings-in-nav: true

A ProGet npm feed is a repository compatible with the npm client for NodeJS. ProGet npm feeds support both scoped and unscoped npm packages.

## npm Feed Specifics {#npm data-title="npm Feed Specifics"}

Connectors to the public repository at npmjs.org will not include [scoped packages](https://docs.npmjs.com/misc/scope) in search results, because the public repository does not have a mechanism for including them. Scoped packages can still be used through this connector; they are only excluded from searches, and this is the same behavior seen from searching at npmjs.org directly.
## npm Feed Limitations {#npm data-title="npm Feed Limitations"}

The npm client does not support using Windows Integrated Authentication, so ProGet attempts to disable its usage for npm API endpoints in favor of basic HTTP authentication. However, disabling Windows Authentication on a per-URL basis does not work in every environment. If you are having trouble getting this working, you may create a second web site in IIS for ProGet with Windows Authentication disabled without acquiring a separate license.

### Build Metadata and npmjs.org

Although the [npm semantic versioning documentation](https://docs.npmjs.com/about-semantic-versioning) mentions support for SemVer2, there is some inconsistency with build metadata (i.e. versions with a "+" symbol in them). The build metadata is not exposed in many npmjs.org queries, where as it is exposed in ProGet queries. When using a connector to npmjs.org, this may present unexpected behavior in the npm client, such as packages not found.

This appears to be limited to a very small number of packages (such as [@hot-loader/react-dom](https://www.npmjs.com/package/@hot-loader/react-dom); we may change this behavior if it's a continued problem, but please contribute to see the discussion at [NPM Connector returns plus "+" in versions](https://forums.inedo.com/topic/2948) on the forums.



## Creating an npm Feed {#creating data-title="Creating an npm Feed"}

Click on the *Feeds* tab in the navigation bar, and you will see a list of feeds in the system.
Expand Down

1 comment on commit d240879

@Maxim-Mazurok
Copy link

Choose a reason for hiding this comment

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

contribute to see the discussion

Probably a typo.

Otherwise, LGTM!

Please sign in to comment.