mikbry / packito

Packito cleans your npm package before publishing it !

📦 Packito

Packito is a cli tool to clean package before publishing it.

Purpose

Before publishing to npm, did you take care of your package.json ?

• devDependencies, some scripts and other entries("husky", ...) could be removed.
• add some new or change entries, like "main" source file name
• use a dist file and copy some extra files/directories in it (README.md, LICENSE, ...).
• and finally publish your package using npm, np or lerna.

Simple using one command:

$ packito

By default it will remove "scripts" and "devDependencies", copy README.md and LICENSE if they exist to './dist' folder.

Install

$ yarn add --dev packito

Or using npm

$ npm add --dev packito

Usage

$ packito [options] [bin-to-publisher]

Options

name	alias	description
--dist	-d	Path to publish from
--nopublish	-n	Skips publishing step
--help	-h	Displays help informations

Bin to publisher

name	description
npm	Publish using npm
lerna	Publish using npm
np	Publish using np

.packito.json

It is the configuration file. This json should be at root of the project, a sample:

{
  "remove": {
    "devDependencies": "*",
    "scripts": "*",
    "type": true,
    "esm": true,
    "husky": true,
    "commitlint": true
  },
  "replace": {
    "main": "index.js",
    "module": "index.mjs"
  },
  "publisher":  "np"
}

name	type	description
remove	object	all keys to remove from packages.json (if =true or ='*' replace all)
replace	object	all keys+values to replace in packages.json
copy	object	all files to copy in dist
output	string	folder to publish to
publisher	string|object	The publisher to use (npm, np, lerna)

Other command examples

Publish to path 'publish'

$ packito -d ./publish

Publish to path 'publish' and use np patchto publish

$ packito -d ./publish np patch

Coded using state of the art and simplicity in mind

• Simple to use
• Modern ES6+ syntax (import instead of require, await/async, ...)
• Follows Node best practices

Requirements

• Node >= 12

Contribution

Read Contributing Guide for development setup instructions.

packito's Issues

chore: update to latest deps

feat : add support for Typescript

Description

Think about supporting typescript extra informations in package.json

[docs] Add usage documentation in readme

Description

From --help commandline display usage documentation in Readme.md

bug: CI Travis failed instead of local

Description

Build error

18 passing (6s)

  3 failing

  1) Packito

       publish not valid publisher command:

     Error: Timeout of 2000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (/home/travis/build/mikbry/packito/test/packito.test.js)

      at listOnTimeout (internal/timers.js:549:17)

      at processTimers (internal/timers.js:492:7)

  2) Packito

       publish valid command using publisherArguments:

     Error: Timeout of 2000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (/home/travis/build/mikbry/packito/test/packito.test.js)

      at listOnTimeout (internal/timers.js:549:17)

      at processTimers (internal/timers.js:492:7)

  3) Packito

       publish valid command using publisher prop:

     Error: Timeout of 2000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (/home/travis/build/mikbry/packito/test/packito.test.js)

      at listOnTimeout (internal/timers.js:549:17)

      at processTimers (internal/timers.js:492:7)

Expected behaviour

Should pass as on my dev machine

[bug] publisher and publisher args are ignored

Description

Running packito without the -n arg, thus with the intention to publish, does not publish packages.

I could have missed something, but it appears that nothing calls the publish function?

Expected behaviour

If a bug, what do you expect ?

Expect packito to publish given the publisher and publisher args.

Actual behaviour

Packito exits after bundling the code.

Steps to reproduce

If a bug, how do you reproduce it :

• run packito without the -n option, and passing in a publisher and args

npx packito -d ./dist npm

Environnement

Node v14.15.1
Npm 6.14.8
OS: Max OS X Catalina

[feat]: Implements publisher

Description

$ packito yarn publish

the command yarn publishshould be run at the end of packito process.

Same from .packito.json:

{
  "publisher": "yarn publish"
} 

feat: Use packages.json file / .npmignore

Description

There is a copy entry in packito.json, but we should be able to use also package.json file entry and .npmignore the same way to copy/exclude files.

See:
https://docs.npmjs.com/files/package.json#files

feat: copy files

Description

Copy some files to dist folder

[feat] default configuration

Description

By default it will remove "scripts" and "devDependencies", copy README.md and LICENSE if they exist to './dist' folder.

feat: migrate to Rust

Description

As an experiment migrate to Rust / WASM

Expected behaviour

Run as previously

feat : dist in .packito.json

Description

{
...
 "dist": "./dist"
}

fix : create outputDir if not exist

feat: update the bin path

Description

In my package, I have

"bin": "dist/cli.mjs",

but when I publish with packtio, it stays the same.

Expected behaviour

I would like this to become just "cli.mjs".

Actual behaviour

In dist/package.json, it still says "bin": "dist/cli.mjs",

Environnement

Node version 16
OS Windows

Further Notes

The package.json "bin" can be a string or a object of type Record<string, string>.