Easily start a npm package from scratch.
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
lib
.gitignore
CONTRIBUTING.md
DOCUMENTATION.md
LICENSE
README.md
package.json

README.md

np-init

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads

Easily start a npm package from scratch.

☁️ Installation

$ npm i --save np-init

💡 ProTip: You can install the cli version of this module by running npm i -g np-init-cli

📋 Example

const init = require("np-init");

init({
    name: "foo"
  , description: "This is a test package"
  , dirname: `${__dirname}/result`
}, (err, data) => {
    console.log(err || data);
});
// $ tree result
// result/
// ├── example
// │   └── index.js
// ├── lib
// │   └── index.js
// └── package.json
// 2 directories, 3 files

Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛
  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

init(options, callback)

Inits a new npm package.

Params

  • Object options: An object containing the following fields:
  • name (String): The package name. This is required.
  • template (String): The template name to be used (check out js-templates). Defaults to function-export.
  • exampleFile (String): The example file path (default: example/index.js).
  • exampleTemplate (String): The example template (default: "example").
  • description (String): The package description.
  • dirname (String): The path to the directory where to create the project (default: the current directory).
  • pack (Object): The package.json information.
  • Function callback: The callback function.

Return

  • EventEmitter An event emitter emitting the following events:
  • repo_created (data): After the repository was created.
  • package_written (data): After the package.json was written.
  • packy_done (data): After the defaults in package.json were set. Note you can do this using packy.
  • after_init_handler (data): After the afterinit handler was executed.
  • git_add (data): After git add . was executed.
  • git_commit (data): After git commit ... was executed.
  • git_remote_add (data): After git remote add ... was executed.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list.

📜 License

MIT © Ionică Bizău