walston / package-postage Goto Github PK

5.0 1.0 0.0 154 KB

$ cat package.json > remove-useless-parts > ./dist/package.json

Home Page: https://www.npmjs.com/package/package-postage

JavaScript 78.94% HTML 21.06%

package-postage's Introduction

Description

Package Postage helps ship utility libraries. It is designed to work with np as a low-level utility to copy the important parts of package.json into a sub-directory for publishing. I personally hook into npm postversion

Why would you do this?

🗜Ship smaller packages: only publish the transpiled code.
💁‍‍Pretty pathing: import "your-package/utils" works. No more your-package/src/utils
👯‍Avoid managing 2 package.json: encode your deployment stream.

npm publish will allow you to publish a sub-directory, but does not copy package-json into that sub-directory. It is reasonable to want to publish that sub-directory but to ensure consistency of a ./dist/package.json with ./package.json would require some level of scripting. Enter Package Postage

Installation

$ npm install --save-dev package-postage

⚙️ API

indent: ["tab", "4", "2"] - Specify the indentation of the resultant package.json
use-file: Use an arbitrary file as package.json
omit: Some tags are included by default, you may want to manually exclude them: "author", "bin", "bugs", "contributors", "dependencies", "description", "keywords", "license", "main", "module", "peerDependencies", "repository".
include: If you'd like to ensure some non-standard keys are shipped pass the key to this.

note omit & include can be combined to only include some child keys while stripping the rest: e.g.

{
  "postage": {
    "omit": ["peerDependencies"],
    "include": ["peerDependencies.react"]
  }
}

📦 Configure in package.json

{
  "name": "my-awesome-package",
  "version": "0.1.1",
  "postage": {
    "omit": ["omit", "any", "top-level", "keys", "included", "by", "default"],
    "include": ["include", "any.top-level.or.sub.keys"],
    "indent": "tab"
  }
}

👾 Call from Gulp

const postage = require("package-postage");
// ...
postage("path_to_dest", {
  omit: ["peerDependencies"],
  include: ["peerDependencies.react"],
  indent: "tab"
});

💻 Execute from terminal

# Copy package.json from your working-directory into `./dist`
$ postage

# Copy package.json from your working directory into `./any-folder-name`
$ postage any-folder-name/

# Use an arbitrary file: `./package.dist.json`
$ postage build/ --use-file package.dist.json

# Indent with tabs
$ postage --indent tab

# Include a few extra top-level keys
$ postage --include eslint,babel,prettier

# Omit a few top-level keys
$ postage --omit repository,bugs,homepage

# Include some sub-keys
$ postage \
  --omit devDependencies,optionalDependencies \
  --include devDependencies.prettier,devDependencies.eslint;

package-postage's People

Contributors

Stargazers

Watchers

package-postage's Issues

Add install instructions for people who are to lazy to type it in

There's no way to specify my `./build` folder

My other project is using ./build as the build folder, and I want to publish that folder.
Why can't i specify that in the "postage" section of my package.json?

provide node api

It would be nice to be able to leverage this in gulp or something like that.

Omit & Include flags don't work

Include should accept top-level keys or "top-level"."sub-key" in the form of -i=top-level.sub-key,top-level.key-2
Omit should accept the same format, and run after include, so you can include a top-level key and omit a sub-key of that top level

$ package-shipit --copy-files README.md,CHANGELOG.md

use a flag rather than command-line-arg for non-standard package.json

get rid of the command line arg for package.dist.json or whatever random thing you might want to call your alternative package.json. it's weird.

if, for whatever reason, the developer needs this, use a flag instead.

package-shipit --use-this-package package.dist.json