Error "npm WARN package.json: No repository field"

Question

I installed Express.js with the following command:

sudo npm install -g express

I get the following warnings:

npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No readme data.
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No repository field.

Why do I have the above warnings? Should I be worried?

By seeing this question one year later, I realize that I mentally erase all these warnings every time I install npm packages. This is something package developers should maybe be a bit more careful about. — nha
– nha, Commented Sep 27, 2014 at 11:53
@nha yeah, I usually see those warnings when doing some npm operation and fix them if it's in the package I'm developing. — gustavohenke
– gustavohenke, Commented Oct 17, 2014 at 3:40
for private repos, just add "private": true to package.json — chovy
– chovy, Commented Nov 29, 2015 at 10:05

KyleMit · Accepted Answer · 2021-11-27 14:30:27Z

1403

It's just a check as of NPM v1.2.20, they report this as a warning.

However, don't worry, there are sooooooo many packages which still don't have the repository field in their package.json. The field is used for informational purposes.

In the case you're a package author, put the repository in your package.json, like this:

"repository": {
  "type": "git",
  "url": "git://github.com/username/repository.git"
}

Read more about the repository field, and see the logged bug for further details.

Additionally, as originally reported by @dan_nl, you can set private key in your package.json.
This will not only stop you from accidentally running npm publish in your app, but will also stop NPM from printing warnings regarding package.json problems.

{
  "name": "my-super-amazing-app",
  "version": "1.0.0",
  "private": true
}

edited Nov 27, 2021 at 14:30

KyleMit♦

31.4k74 gold badges517 silver badges712 bronze badges

answered May 30, 2013 at 4:33

gustavohenke

41.5k14 gold badges125 silver badges133 bronze badges

Sign up to request clarification or add additional context in comments.

8 Comments

gustavohenke Over a year ago

A few months after my answer and I haven't seem any problems so far :)

Blaise Over a year ago

NPM 2.14 now does print an error when repository is empty and private is set to true.

gustavohenke Over a year ago

@Blaise, I don't get any warnings in NPM 3.3.3 by using private: true

Felype Over a year ago

Question, why isnt "private" the default, I mean how many npm projects are created versus how many are actually published, is there really more library code than user code?

Aluan Haddad Over a year ago

The documentation you linked does not explain why the field is required just that it is useful. Technically, it isn't required (warning vs. error) but I am sure someone is going to wonder why the tool cares at all.

|

Samuel RIGAUD · Accepted Answer · 2024-03-04 18:51:22Z

410

You can also mark the application as private if you don’t plan to put it in an actual repository.

{
  "name": "my-application",
  "version": "0.0.1",
  "private": true
}

edited Mar 4, 2024 at 18:51

Samuel RIGAUD

1,6981 gold badge19 silver badges28 bronze badges

answered Apr 29, 2014 at 3:38

dan_nl

4,4461 gold badge18 silver badges7 bronze badges

Comments

wortwart · Accepted Answer · 2018-09-03 19:22:07Z

56

As dan_nl stated, you can add a private fake repository in package.json. You don't even need name and version for it:

{
  ...,
  "repository": {
    "private": true
  }
}

Update: This feature is undocumented and might not work. Choose the following option.

Better still: Set the private flag directly. This way npm doesn't ask for a README file either:

{
  "name": ...,
  "description": ...,
  "version": ...,
  "private": true
}

edited Sep 3, 2018 at 19:22

answered Sep 15, 2014 at 21:11

wortwart

3,39831 silver badges34 bronze badges

4 Comments

gustavohenke Over a year ago

Got notified about another user about this answer. Looks like repository.private is not documented behaviour (or it is no longer accepted), according to docs.npmjs.com/files/package.json.

wortwart Over a year ago

@gustavohenke: Thank you, it seems you're right - private as top-level property is the better option anyway. Updated my answer.

rayzinnz Over a year ago

"Set the private flag directly" - this doesn't work for me, I had to specify the private flag inside a "repository" section. Npm version 9.6.7

wortwart Over a year ago

Surprising -- the private property is the official way also in v9 (docs.npmjs.com/cli/v9/configuring-npm/package-json#private) while repository.private is undocumented and may or (probably) may not work.

Samuel RIGAUD · Accepted Answer · 2024-03-04 13:40:20Z

48

If you are getting this from your own package.json, just add the repository field to it. (use the link to your actual repository):

"repository" : { 
  "type" : "git",
  "url" : "https://github.com/npm/npm.git"
}

edited Mar 4, 2024 at 13:40

Samuel RIGAUD

1,6981 gold badge19 silver badges28 bronze badges

answered Feb 28, 2014 at 4:03

Brendan Nee

5,4212 gold badges36 silver badges33 bronze badges

1 Comment

twk Over a year ago

Thanks for clarifying to use the full github project file link (including http:// or https://!

BladeBarringer · Accepted Answer · 2015-10-06 16:21:55Z

9

Have you run npm init? That command runs you through everything...

edited Oct 6, 2015 at 16:21

BladeBarringer

8077 silver badges17 bronze badges

answered Aug 8, 2015 at 19:32

achoukah

1,4652 gold badges11 silver badges10 bronze badges

Comments

Sibiraj · Accepted Answer · 2017-07-19 13:56:11Z

8

In Simple word- package.json of your project has not property of repository you must have to add it,

and you have to add repository in your package.json like below

and Let me explain according to your scenario

you must have to add repository field something like below

  "repository" : {     
     "type" : "git",
      "url" : "http://github.com/npm/express.git" 
   }

edited Jul 19, 2017 at 13:56

Sibiraj

4,7868 gold badges37 silver badges59 bronze badges

answered Apr 16, 2017 at 20:47

Shashwat Gupta

5,31845 silver badges33 bronze badges

Comments

zx485 · Accepted Answer · 2018-05-23 17:52:43Z

7

If you don't want to specify a repository you can add the following lines to the package.json file:

"description":"",
"version":"0.0.1",
"private":true,

That worked for me.
By adding private, you don't need to link to a repo.

edited May 23, 2018 at 17:52

zx485

29.1k28 gold badges55 silver badges65 bronze badges

answered May 23, 2018 at 11:37

Rubin bhandari

1,94117 silver badges20 bronze badges

Comments

Łukasz D. Tulikowski · Accepted Answer · 2018-09-24 06:45:36Z

7

To avoid warnings like:

npm WARN [email protected] No repository field.

You must define repository in your project package.json. In the case when you are developing with no publishing to the repository you can set "private": true in package.json

Example:

{
  "name": "test.loc",
  "version": "1.0.0",
  "private": true,
  ...
  "license": "ISC"
}

NPM documentation about this: https://docs.npmjs.com/files/package.json

edited Sep 24, 2018 at 6:45

Łukasz D. Tulikowski

1

answered Sep 23, 2018 at 19:00

Alex

5835 silver badges6 bronze badges

Comments

Ian Croasdell · Accepted Answer · 2016-11-26 10:55:10Z

4

this will help all of you to find your own correct details use

npm ls dist-tag

this will then show the correct info so you don't guess the version file location etc

enjoy :)

answered Nov 26, 2016 at 10:55

Ian Croasdell

912 bronze badges

1 Comment

M.J Over a year ago

I got a response as '--empty

Jsalim · Accepted Answer · 2016-04-27 05:12:20Z

3

Yes, probably you can re/create one by including -f at the end of your command

answered Apr 27, 2016 at 5:12

Jsalim

514 bronze badges

Comments

muli · Accepted Answer · 2022-08-18 06:44:07Z

0

Try: npm install package.json, npm audit fix --force, ncu -u

answered Aug 18, 2022 at 6:44

muli

471 silver badge3 bronze badges

Comments

jimboweb · Accepted Answer · 2019-09-06 20:31:36Z

-1

use npm install -g angular-cli instead of
npm install -g@nagular/cli to install Angular

edited Sep 6, 2019 at 20:31

jimboweb

4,5623 gold badges28 silver badges48 bronze badges

answered Sep 6, 2019 at 18:38

Alnebras Murtada

1352 silver badges11 bronze badges

Collectives™ on Stack Overflow

Error "npm WARN package.json: No repository field"

12 Answers 12

8 Comments

Comments

4 Comments

1 Comment

Comments

Comments

Comments

Comments

1 Comment

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

12 Answers 12

8 Comments

Comments

4 Comments

1 Comment

Comments

Comments

Comments

Comments

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related