walston / package-postage Goto Github PK

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

• 🗜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

$ npm install --save-dev package-postage

• 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"]
  }
}

{
  "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"
  }
}

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

# 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;