@cryptotaxi247 / documentation
Code Commits Issues Pulls Sessions CI/CD
reggi/dev-engines
@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 201 lines 8.1 KB
Raw
1 ---
2 title: developers
3 section: 7
4 description: Developer Guide
5 github_repo: npm/cli
6 github_branch: latest
7 github_path: docs/lib/content/using-npm/developers.md
8 redirect_from:
9 - /cli-documentation/misc/developers
10 - /cli-documentation/using-npm/developers
11 - /cli-documentation/v10/misc/developers
12 - /cli-documentation/v10/using-npm/developers
13 - /cli/misc/developers
14 - /cli/using-npm/developers
15 - /cli/v10/misc/developers
16 - /misc/developers
17 - /using-npm/developers
18 ---
19
20 ### Description
21
22 So, you've decided to use npm to develop (and maybe publish/deploy) your project.
23
24 Fantastic!
25
26 There are a few things that you need to do above the simple steps that your users will do to install your program.
27
28 ### About These Documents
29
30 These are man pages. If you install npm, you should be able to then do `man npm-thing` to get the documentation on a particular topic, or `npm help thing` to see the same information.
31
32 ### What is a Package
33
34 A package is:
35
36 - a) a folder containing a program described by a package.json file
37 - b) a gzipped tarball containing (a)
38 - c) a url that resolves to (b)
39 - d) a `<name>@<version>` that is published on the registry with (c)
40 - e) a `<name>@<tag>` that points to (d)
41 - f) a `<name>` that has a "latest" tag satisfying (e)
42 - g) a `git` url that, when cloned, results in (a).
43
44 Even if you never publish your package, you can still get a lot of benefits of using npm if you just want to write a node program (a), and perhaps if you also want to be able to easily install it elsewhere after packing it up into a tarball (b).
45
46 Git urls can be of the form:
47
48 ```bash
49 git://github.com/user/project.git#commit-ish
50 git+ssh://user@hostname:project.git#commit-ish
51 git+http://user@hostname/project/blah.git#commit-ish
52 git+https://user@hostname/project/blah.git#commit-ish
53 ```
54
55 The `commit-ish` can be any tag, sha, or branch which can be supplied as an argument to `git checkout`. The default is whatever the repository uses as its default branch.
56
57 ### The package.json File
58
59 You need to have a `package.json` file in the root of your project to do much of anything with npm. That is basically the whole interface.
60
61 See [`package.json`](/cli/v10/configuring-npm/package-json) for details about what goes in that file. At the very least, you need:
62
63 - name: This should be a string that identifies your project. Please do not use the name to specify that it runs on node, or is in JavaScript. You can use the "engines" field to explicitly state the versions of node (or whatever else) that your program requires, and it's pretty well assumed that it's JavaScript.
64
65 It does not necessarily need to match your github repository name.
66
67 So, `node-foo` and `bar-js` are bad names. `foo` or `bar` are better.
68
69 - version: A semver-compatible version.
70
71 - engines: Specify the versions of node (or whatever else) that your program runs on. The node API changes a lot, and there may be bugs or new functionality that you depend on. Be explicit.
72
73 - author: Take some credit.
74
75 - scripts: If you have a special compilation or installation script, then you should put it in the `scripts` object. You should definitely have at least a basic smoke-test command as the "scripts.test" field. See [scripts](/cli/v10/using-npm/scripts).
76
77 - main: If you have a single module that serves as the entry point to your program (like what the "foo" package gives you at require("foo")), then you need to specify that in the "main" field.
78
79 - directories: This is an object mapping names to folders. The best ones to include are "lib" and "doc", but if you use "man" to specify a folder full of man pages, they'll get installed just like these ones.
80
81 You can use `npm init` in the root of your package in order to get you started with a pretty basic package.json file. See [`npm init`](/cli/v10/commands/npm-init) for more info.
82
83 ### Keeping files _out_ of your Package
84
85 Use a `.npmignore` file to keep stuff out of your package. If there's no `.npmignore` file, but there _is_ a `.gitignore` file, then npm will ignore the stuff matched by the `.gitignore` file. If you _want_ to include something that is excluded by your `.gitignore` file, you can create an empty `.npmignore` file to override it. Like `git`, `npm` looks for `.npmignore` and `.gitignore` files in all subdirectories of your package, not only the root directory.
86
87 `.npmignore` files follow the [same pattern rules](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) as `.gitignore` files:
88
89 - Blank lines or lines starting with `#` are ignored.
90 - Standard glob patterns work.
91 - You can end patterns with a forward slash `/` to specify a directory.
92 - You can negate a pattern by starting it with an exclamation point `!`.
93
94 By default, the following paths and files are ignored, so there's no need to add them to `.npmignore` explicitly:
95
96 - `.*.swp`
97 - `._*`
98 - `.DS_Store`
99 - `.git`
100 - `.gitignore`
101 - `.hg`
102 - `.npmignore`
103 - `.npmrc`
104 - `.lock-wscript`
105 - `.svn`
106 - `.wafpickle-*`
107 - `config.gypi`
108 - `CVS`
109 - `npm-debug.log`
110
111 Additionally, everything in `node_modules` is ignored, except for bundled dependencies. npm automatically handles this for you, so don't bother adding `node_modules` to `.npmignore`.
112
113 The following paths and files are never ignored, so adding them to `.npmignore` is pointless:
114
115 - `package.json`
116 - `README` (and its variants)
117 - `CHANGELOG` (and its variants)
118 - `LICENSE` / `LICENCE`
119
120 If, given the structure of your project, you find `.npmignore` to be a maintenance headache, you might instead try populating the `files` property of `package.json`, which is an array of file or directory names that should be included in your package. Sometimes manually picking which items to allow is easier to manage than building a block list.
121
122 #### Testing whether your `.npmignore` or `files` config works
123
124 If you want to double check that your package will include only the files you intend it to when published, you can run the `npm pack` command locally which will generate a tarball in the working directory, the same way it does for publishing.
125
126 ### Link Packages
127
128 `npm link` is designed to install a development package and see the changes in real time without having to keep re-installing it. (You do need to either re-link or `npm rebuild -g` to update compiled packages, of course.)
129
130 More info at [`npm link`](/cli/v10/commands/npm-link).
131
132 ### Before Publishing: Make Sure Your Package Installs and Works
133
134 **This is important.**
135
136 If you can not install it locally, you'll have problems trying to publish it. Or, worse yet, you'll be able to publish it, but you'll be publishing a broken or pointless package. So don't do that.
137
138 In the root of your package, do this:
139
140 ```bash
141 npm install . -g
142 ```
143
144 That'll show you that it's working. If you'd rather just create a symlink package that points to your working directory, then do this:
145
146 ```bash
147 npm link
148 ```
149
150 Use `npm ls -g` to see if it's there.
151
152 To test a local install, go into some other folder, and then do:
153
154 ```bash
155 cd ../some-other-folder
156 npm install ../my-package
157 ```
158
159 to install it locally into the node_modules folder in that other place.
160
161 Then go into the node-repl, and try using require("my-thing") to bring in your module's main module.
162
163 ### Create a User Account
164
165 Create a user with the adduser command. It works like this:
166
167 ```bash
168 npm adduser
169 ```
170
171 and then follow the prompts.
172
173 This is documented better in [npm adduser](/cli/v10/commands/npm-adduser).
174
175 ### Publish your Package
176
177 This part's easy. In the root of your folder, do this:
178
179 ```bash
180 npm publish
181 ```
182
183 You can give publish a url to a tarball, or a filename of a tarball, or a path to a folder.
184
185 Note that pretty much **everything in that folder will be exposed** by default. So, if you have secret stuff in there, use a `.npmignore` file to list out the globs to ignore, or publish from a fresh checkout.
186
187 ### Brag about it
188
189 Send emails, write blogs, blab in IRC.
190
191 Tell the world how easy it is to install your program!
192
193 ### See also
194
195 - [npm](/cli/v10/commands/npm)
196 - [npm init](/cli/v10/commands/npm-init)
197 - [package.json](/cli/v10/configuring-npm/package-json)
198 - [npm scripts](/cli/v10/using-npm/scripts)
199 - [npm publish](/cli/v10/commands/npm-publish)
200 - [npm adduser](/cli/v10/commands/npm-adduser)
201 - [npm registry](/cli/v10/using-npm/registry)