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:

1module.exports = {
2  replacements: [
3    {
4      files: [
5        'package.json'
6      ],
7      key: 'url',
8      replace: 'https://github.com/loggur/lumbur'
9    },
10
11    {
12      files: [
13        'package.json',
14        'README.md'
15      ],
16      key: 'package name',
17      replace: /\blumbur\b/g,  // can use regex
18      value: 'lumbur'          // replacement value defaults to this
19    },
20
21    {
22      files: [
23        'package.json',
24        'webpack.config.development.js',
25        'webpack.config.production.js',
26        'src/defaultProps.js',
27        'test/index.spec.js'
28      ],
29      key: 'proper name (no spaces)',
30      replace: 'Lumbur'
31    },
32
33    {
34      files: [
35        'package.json'
36      ],
37      key: 'author',
38      replace: 'timbur'
39    },
40
41    {
42      files: [
43        'README.md',
44        'LICENSE'
45      ],
46      key: 'owner (i.e., repo user name)',
47      replace: 'loggur'
48    },
49
50    {
51      files: [
52        'package.json'
53      ],
54      // if there's no key, replacement will occur without prompting user
55      replace: '    "postinstall": "lumburjack",\n',
56      value: ''  // no longer need lumburjack so let's remove from scripts
57    },
58
59    {
60      files: [
61        'package.json'
62      ],
63      replace: '    "lumburjack": "^1.0.0-0",\n',
64      value: ''  // no longer need lumburjack so let's remove from deps as well
65    }
66  ],
67
68  onCompleted: function(values) {
69    // let's delete lumburjack.js now
70    require('fs').unlinkSync(process.cwd() + '/lumburjack.js');
71
72    console.log([
73      'Good starting points:',
74      '1.  npm run start:dev',
75      '2.  src/renderApp.js',
76      '3.  src/renderAppToString.js',
77      '4.  src/defaultProps.js',
78      '5.  src/middleware.js',
79      '6.  src/components/App.js',
80      '7.  Update README.md!'
81    ].join('\n'));
82  }
83};

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.