npmize

0.0.9 • Public • Published

npmize

This package tries to help you to make npm package without thinking about cjs and mjs module.

Features

  • Zero Config.
  • Very very simple.
  • Very very lightweight.
  • This supports typescript.
  • Enables __dirname and __filename for mjs(EsModule).
npm package

Installation

  • with npm (globally)
npm i -g npmize
  • with npm
npm i -D npmize
  • with yarn
yarn add -D npmize
  • with pnpm
pnpm add -D npmize



Command Line Interface

The interface for command-line usage is fairly simplistic at this stage, as seen in the following usage section.

Usage

npmize <command> [options]

Example:

npmize dev

This starts typescript watch mode.




Commands

Command Description
init Initilize package.json
dev Start typescript watch mode
build Build for prod

Command Options

Option Description
--no-install Not to install required dependencies automatically
--no-ignore Not to add recommended ignore files to .gitignore | .npmignore
--no-src Not to create src/index.ts folder when not exists

Command: init

Option Description
--bin Also add bin field
--legacy Uses .js for fields

Command: dev & build

You can use almost any typescript cli command here by using --tsc. eg: --tsc--jsx=react --> --jsx react

Not allowed list: --project --outDir --module --watch and their aliases

Option Description
--module=cjs This starts dev mode of commonjs module
--module=mjs This starts dev mode of esmodule module

Command: build

Option Description
--node This enables __dirname and __filename in esmodule
--legacy Uses .js files and creates package.json with type



Note:

  • You should use --module=cjs with dev mode when working with packages for node because __dirname and __filename isn't supported in esmodule in dev mode

  • Do not use VGhpcyBuYW1lIGlzIGFscmVhZHkgdXNlZCB0byBlbmFibGUgX19kaXJuYW1lIGFuZCBfX2ZpbGVuYW1lIDop as a variable name in your top level code.

    • If you want to know why! Base64 ... Hope you know.
  • If you don't star our github repo your wife will divorce you, Else if you don't have wife then you will never get her.



Made by Nazmus Sayad with ❤️.

Package Sidebar

Install

npm i npmize

Weekly Downloads

0

Version

0.0.9

License

ISC

Unpacked Size

71.8 kB

Total Files

20

Last publish

Collaborators

  • nazmussayad