@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
reggi/cache-based-on-version
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 91 lines 3.6 KB
Raw
1 ---
2 title: Creating and publishing unscoped public packages
3 ---
4
5 As an npm user, you can create unscoped packages to use in your own projects and publish them to the npm public registry for others to use in theirs. Unscoped packages are always public and are referred to by the package name only:
6
7 ```
8 package-name
9 ```
10
11 For more information on package scope, access, and visibility, see "[Package scope, access level, and visibility][pkg-viz]".
12
13 <Note>
14
15 **Note:** Before you can publish public unscoped npm packages, you must [sign up](https://www.npmjs.com/signup) for an npm user account.
16
17 </Note>
18
19 ## Creating an unscoped public package
20
21 1. On the command line, create a directory for your package:
22
23 ```
24 mkdir my-test-package
25 ```
26
27 2. Navigate to the root directory of your package:
28
29 ```
30 cd my-test-package
31 ```
32
33 3. If you are using git to manage your package code, in the package root directory, run the following commands, replacing `git-remote-url` with the git remote URL for your package:
34
35 ```
36 git init
37 git remote add origin git://git-remote-url
38 ```
39
40 4. In the package root directory, run the `npm init` command.
41 5. Respond to the prompts to generate a [`package.json`](https://docs.npmjs.com/about-package-json-and-package-lock-json-files) file. For help naming your package, see "[Package name guidelines][pkg-name]".
42 6. Create a [README file][readme-file] that explains what your package code is and how to use it.
43 7. In your preferred text editor, write the code for your package.
44
45 ## Reviewing package contents for sensitive or unnecessary information
46
47 Publishing sensitive information to the registry can harm your users, compromise your development infrastructure, be expensive to fix, and put you at risk of legal action. **We strongly recommend removing sensitive information, such as private keys, passwords, [personally identifiable information][pii] (PII), and credit card data before publishing your package to the registry.**
48
49 For less sensitive information, such as testing data, use a `.npmignore` or `.gitignore` file to prevent publishing to the registry. For more information, see [this article][developers].
50
51 ## Testing your package
52
53 To reduce the chances of publishing bugs, we recommend testing your package before publishing it to the npm registry. To test your package, run `npm install` with the full path to your package directory:
54
55 ```
56 npm install path/to/my-package
57 ```
58
59 ## Publishing unscoped public packages
60
61 1. On the command line, navigate to the root directory of your package.
62
63 ```
64 cd /path/to/package
65 ```
66
67 2. To publish your public package to the npm registry, run:
68
69 ```
70 npm publish
71 ```
72
73 <Note>
74
75 **Note:** If you use GitHub Actions to publish your packages, you can generate provenance information for each package you publish. For more information, see "[Generating provenance statements][provenance-how-to]."
76
77 </Note>
78
79 3. To see your public package page, visit `https://npmjs.com/package/*package-name*`, replacing `*package-name*` with the name of your package. Public packages will say `public` below the package name on the npm website.
80
81 For more information on the `publish` command, see the [CLI documentation][cli-publish].
82
83 [pkg-viz]: package-scope-access-level-and-visibility
84 [user-signup]: https://www.npmjs.com/signup
85 [create-org]: https://www.npmjs.com/signup?next=/org/create
86 [pkg-name]: package-name-guidelines
87 [readme-file]: about-package-readme-files
88 [developers]: /misc/developers#keeping-files-out-of-your-package
89 [cli-publish]: /cli/publish
90 [pii]: https://en.wikipedia.org/wiki/Personally_identifiable_information
91 [provenance-how-to]: /generating-provenance-statements