init-package-json

What is init-package-json?

The init-package-json npm package is a utility that helps in creating a package.json file for a Node.js project. It guides users through a series of prompts to gather necessary information and then generates a package.json file based on the provided inputs.

What are init-package-json's main functionalities?

Interactive Package Initialization

This feature allows users to initialize a package.json file interactively. The script prompts the user for various details like package name, version, description, etc., and then generates the package.json file.

const init = require('init-package-json');
const path = process.cwd();
const initFile = path.resolve(process.env.HOME, '.npm-init');

init(path, initFile, {}, (err, data) => {
  if (err) {
    console.error(err);
  } else {
    console.log('Package initialized:', data);
  }
});

Custom Prompts

This feature allows users to provide custom configuration data for the package.json file. Instead of going through the interactive prompts, users can supply predefined values.

const init = require('init-package-json');
const path = process.cwd();
const initFile = path.resolve(process.env.HOME, '.npm-init');

const configData = {
  'name': 'my-custom-package',
  'version': '1.0.0',
  'description': 'A custom package'
};

init(path, initFile, configData, (err, data) => {
  if (err) {
    console.error(err);
  } else {
    console.log('Custom package initialized:', data);
  }
});

Other packages similar to init-package-json

yeoman-generator

Yeoman Generator is a scaffolding tool that helps in generating complete projects, including package.json files. It offers more extensive functionality compared to init-package-json, such as generating boilerplate code, setting up project structure, and more.

create-package-json

The create-package-json package is a simpler alternative to init-package-json. It focuses solely on generating a package.json file with minimal prompts and configuration options. It is less interactive but quicker for straightforward setups.

npm-init

npm-init is a built-in npm command that initializes a package.json file. It is similar to init-package-json but is more tightly integrated with npm itself. It offers a basic set of prompts and configurations.

README

init-package-json

A node module to get your node module started.

Usage

var init = require('init-package-json')
var path = require('path')

// a path to a promzard module.  In the event that this file is
// not found, one will be provided for you.
var initFile = path.resolve(process.env.HOME, '.npm-init')

// the dir where we're doin stuff.
var dir = process.cwd()

// extra stuff that gets put into the PromZard module's context.
// In npm, this is the resolved config object.  Exposed as 'config'
// Optional.
var configData = { some: 'extra stuff' }

// Any existing stuff from the package.json file is also exposed in the
// PromZard module as the `package` object.  There will also be three
// vars for:
// * `filename` path to the package.json file
// * `basename` the tip of the package dir
// * `dirname` the parent of the package dir

init(dir, initFile, configData, function (er, data) {
  // the data's already been written to {dir}/package.json
  // now you can do stuff with it
})

Or from the command line:

$ npm-init

See PromZard for details about what can go in the config file.

Changelog

3.0.0 (2022-02-16)

⚠ BREAKING CHANGES

• this drops support for node10 and non-LTS versions of node12 and node14

Dependencies

• @npmcli/template-oss@2.7.1 (257ba39)
• npm-package-arg@9.0.0, @npmcli/config@4.0.0 (5e744c8)
• update read requirement from ~1.0.1 to ^1.0.7 (4425b9a)