Package json name property

Non scoped packages

some-cool-package-name

Scoped packages

@user_name/some-cool-package-name

• Private by default
• Make them public by npm publish -access pubric

Module systems in JS

• CJS
• AMD
• UMD
• ESM

file property

this property instruct npm which file should be included to publish. We can check by running npm publish --dry-run on terminal. We specify 'lib'(artifact folder) to exclude all other foders/files of the repo.

  "files": [
    "lib"
  ],

Sample Output

newuser@MacBook-Pro-3 greeting_package % npm publish --dry-run
npm warn publish npm auto-corrected some errors in your package.json when publishing.  Please run "npm pkg fix" to address these errors.
npm warn publish errors corrected:
npm warn publish "repository.url" was normalized to "git+https://github.com/ytoyodadev/greeting_package.git"
npm notice
npm notice 📦  [email protected]
npm notice Tarball Contents
npm notice 1.1kB LICENSE
npm notice 213B README.md
npm notice 231B lib/index.cjs
npm notice 181B lib/index.esm.js
npm notice 61B lib/types/eveningGreet.d.ts
npm notice 94B lib/types/index.d.ts
npm notice 61B lib/types/morningGreet.d.ts
npm notice 727B package.json
npm notice Tarball Details
npm notice name: greeting_package
npm notice version: 1.0.0
npm notice filename: greeting_package-1.0.0.tgz
npm notice package size: 1.5 kB
npm notice unpacked size: 2.6 kB
npm notice shasum: 4bbb9f3c8b47437a30548ac1ab37aa0795dd4f80
npm notice integrity: sha512-Cce4KaghoLStk[...]cNUBbic0ygxdg==
npm notice total files: 8
npm notice
npm notice Publishing to https://registry.npmjs.org/ with tag latest and default access (dry-run)

• Notice src folder is not in the output.
• Note: LICENSE, README.md and package.json are alwauys included regardless of the file property value.

Semantic Versioning