Add .npmrc button to project presenter file options
Problem to solve
Make it easier and encourage users to create .npmrc
files via the Project Presenter quick file add UI, e.g.
The goal is to make the creation of this file as quick and easy as possible to help guide the user through smoother usage and adoption of the package registry.
Intended users
Proposal
Add a new .npmrc
button to this location only when we can detect that the project contains a package.json
file at the top level. Clicking this will work like the other buttons, opening the editor with a correctly named .npmrc
file at the root level. We can also pre-fill the contents of the file with placeholders, ready for the user to change to work with their registry of choice.
Here's a gif of a possible implementation:
Here's the text of the .npmrc
file:
# Add this line for each package scope you want to use GitLab as a registry for, changing <package-scope> to suit your package
@<package-scope>:registry=http://0.0.0.0:3000/api/v4/packages/npm/
# Uncomment the below line if you wish to upload NPM packages to the package registry
# Replace <your_project_id> with the project id of your registry and <your_auth_token> with your auth token
# http://0.0.0.0:3000/api/v4/projects/<your_project_id>/packages/npm/:_authToken=<your_auth_token>
# Replace <your-auth-token> with a user or ci auth token
http://0.0.0.0:3000/api/v4/packages/npm/:_authToken=<your-auth-token>
Edited by Nick Kipling