@bandress-dumbasses/lame

LAME

Informal notes on working with org-scoped projects in the npm registry.

Table of Contents

• Create a new org-scoped project
• Modify an existing project to have an org scope
• References

Create a new org-scoped project

1. Initialize the project directory:
   1. mkdir lame
2. Create the lame project on github
3. Initialize the git project locally:
   1. git init
4. Associate the local project with github:
   1. git remote add origin https://github.com/brainthinks/lame-test.git
5. Add some stuff to the project
   1. touch README.md
   2. touch .gitignore
   3. touch .npmrc
6. Add the .npmrc file with the following:
   1. scope=bandress-dumbasses
   2. access=public
7. Initialize the node project:
   1. yarn init
   2. Provide the name of the project as @bandress-dumbasses/lame
8. Commit and push all the files:
   1. git add .
   2. git commit -m "message"
   3. git push -u origin master
9. Version the project:
   1. yarn version --new-version 0.0.1
   2. git push --tags
10. Publish the project
    1. npm publish

Observe that the project was published to the org's namespace.

Modify an existing project to have an org scope

1. Add the .npmrc file that contains the scope and access configurations
2. Add the repository property to the package.json file, where the value is the git url
   1. e.g. "repository": "https://github.com/brainthinks/lame-test.git",
3. Find all instances in the project where the name property from the package.json is used
   1. You may need to change them from name to name.split('/').pop()
4. Commit and push all changes
5. Version the project:
   1. yarn version --new-version 0.0.1
6. Publish the project
   1. npm publish

References

• https://docs.npmjs.com/creating-and-publishing-an-org-scoped-package
• https://docs.npmjs.com/configuring-your-npm-client-with-your-org-settings