lumburjack

Tiny utility to convert boilerplate to your own package names.

Installation

npm install lumburjack --save-dev

Example

Check out lumbur to see this in action. Should be pretty straightforward! It includes a script that will automatically run lumburjack after npm install, and you'll be prompted for information about your package similarly to npm init but specific to the boilerplate. :)

Usage

1. Install as a dev dependency.

2. Create lumburjack.js, which should look something like:

module.exports = {
  replacements: [
    {
      files: [
        'package.json'
      ],
      key: 'url',
      replace: 'https://github.com/loggur/lumbur'
    },

    {
      files: [
        'package.json',
        'README.md'
      ],
      key: 'package name',
      replace: /\blumbur\b/g,  // can use regex
      value: 'lumbur'          // replacement value defaults to this
    },

    {
      files: [
        'package.json',
        'webpack.config.development.js',
        'webpack.config.production.js',
        'src/defaultProps.js',
        'test/index.spec.js'
      ],
      key: 'proper name (no spaces)',
      replace: 'Lumbur'
    },

    {
      files: [
        'package.json'
      ],
      key: 'author',
      replace: 'timbur'
    },

    {
      files: [
        'README.md',
        'LICENSE'
      ],
      key: 'owner (i.e., repo user name)',
      replace: 'loggur'
    },

    {
      files: [
        'package.json'
      ],
      // if there's no key, replacement will occur without prompting user
      replace: '    "postinstall": "lumburjack",\n',
      value: ''  // no longer need lumburjack so let's remove from scripts
    },

    {
      files: [
        'package.json'
      ],
      replace: '    "lumburjack": "^1.0.0-0",\n',
      value: ''  // no longer need lumburjack so let's remove from deps as well
    }
  ],

  onCompleted: function(values) {
    // let's delete lumburjack.js now
    require('fs').unlinkSync(process.cwd() + '/lumburjack.js');

    console.log([
      'Good starting points:',
      '1.  npm run start:dev',
      '2.  src/renderApp.js',
      '3.  src/renderAppToString.js',
      '4.  src/defaultProps.js',
      '5.  src/middleware.js',
      '6.  src/components/App.js',
      '7.  Update README.md!'
    ].join('\n'));
  }
};

3. If you're creating some boilerplate and would like to automatically run lumburjack after npm install, just add "postinstall": "lumburjack" to your package.json's scripts. And if you'd like to remove lumburjack, see the end of step 2, above.