README

pkgify

Pkgify is a browserify transform that allows you to rewrite module/package-style require calls to local files. It is built using the browserify-transform-tools.

Clean up your require calls!
Supports individual files and entire directories
Supports nested packages (priorities deepest match)
Simple configuration
File-type indifferent
Efficient

But we already have aliasify and remapify?

Aliasify is designed for mapping individual files to new names. Remapify actually uses aliasify internally for it's mapping process which means it has to generate a list of all possible files that might be mapped from the source directory, and then compare them when processing files. This gives remapify less control since it isn't doing the transform itself.

Purpose

Say, for example, your project has the following tree structure:

myproject
  - /app
    - /views
      - /home
        - index.js
      - /about
        - index.js
    - /models
      - cars.js
    - log.js

Normally, if you wanted to access log.js and models/cars.js from either of the two view files, you would have to do it like so:

var log = require("../../log");
var Cars = require("../../models/cars");

With pkgify, however, you can save yourself time and clean up your code so it looks like this:

var log = require("log");
var Cars = require("models/cars");

Installation

npm install --save-dev pkgify

Usage

Usage is identical to any other browserify-transform-tools transforms:

package.json

Directly in package.json:

{
  "pkgify": {
    "packages": {
      "views": "./app/views",
      "log": "./app/log.js"
    }
  }
}

or using referencing a separate JS file in package.json:

{
  "pkgify": "./pkgifyConfig.js"
}

Browserify API

var pkgify = require("pkgify");

b.transform(pkgify, {
  packages: {
    views: "./app/views",
    log: "./app/log.js"
  },
  relativeTo: __dirname
});

Configuration options

`packages`

Type: object
Required: yes
Description: A mapping of package names to their source. The source is resolved in relation to the relativeTo option and can reference either a file or directory. If a file is specified it's extension must be included.

`relativeTo`

Type: string
Required: no
Description: Path to resolve package sources against. If using package.json for configuration, this value will default to the location of the package.json file. If you are using the API, it will default to the location you are configuring from. It is advisable to always explicitly set this option when using the API using __dirname.

`appliesTo`

Type: object
Required: no
Description: Control what files are processed by the transform. This is an option provided by browserify-transform-tools.

Contributing

Setup

make bootstrap

Running tests

make test

Commit messages

Use the present tense ("Add feature" not "Added feature")
Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
Limit the first line to 72 characters or less
Reference issues and pull requests liberally
Consider starting the commit message with an applicable emoji:
- :lipstick: :lipstick: when improving the format/structure of the code
- :racehorse: :racehorse: when improving performance
- :non-potable_water: :non-potable_water: when plugging memory leaks
- :memo: :memo: when writing docs
- :penguin: :penguin: when fixing something on Linux
- :apple: :apple: when fixing something on Mac OS
- :checkered_flag: :checkered_flag: when fixing something on Windows
- :bug: :bug: when fixing a bug
- :fire: :fire: when removing code or files
- :green_heart: :green_heart: when fixing the CI build
- :white_check_mark: :white_check_mark: when adding tests
- :lock: :lock: when dealing with security
- :arrow_up: :arrow_up: when upgrading dependencies
- :arrow_down: :arrow_down: when downgrading dependencies

(From atom)

Usage no npm install needed!