Add automatic bootstrapping script makenew.sh

Author: razor-x

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) yyyy copyright_owner
+Copyright (c) 2015 Evan Sosenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -1,9 +1,7 @@
 # CoffeeScript Package Skeleton
 
-<!--
-[![Bower](https://img.shields.io/bower/v/coffeescript-package.svg)](http://bower.io/search/?q=coffeescript-package)
+[![Bower](https://img.shields.io/bower/v/makenew-coffeescript-package.svg)](http://bower.io/search/?q=makenew-coffeescript-package)
 [![npm](https://img.shields.io/npm/v/makenew-coffeescript-package.svg)](https://www.npmjs.com/package/makenew-coffeescript-package)
--->
 [![GitHub license](https://img.shields.io/github/license/makenew/coffeescript-package.svg)](./LICENSE.txt)
 [![Dependency Status](https://img.shields.io/gemnasium/makenew/coffeescript-package.svg)](https://gemnasium.com/makenew/coffeescript-package)
 [![Build Status](https://img.shields.io/travis/makenew/coffeescript-package.svg)](https://travis-ci.org/makenew/coffeescript-package)
@@ -27,38 +25,23 @@ Bootstrap a new [CoffeeScript] package in less than five minutes.
 [Shields.io]: http://shields.io/
 [Travis CI]: https://travis-ci.org/
 
-### Usage
-
-This software can be used freely, see [The Unlicense].
-The MIT License text appearing in this software is for
-demonstration purposes only and does not apply to this software.
+### Bootstrapping a New Project
 
 1. Clone this repository or download a [release][Releases].
 
-2. Customize this README.
-   - Set the title and summary text.
-   - Replace the Description section.
-   - Update the Source section.
-   - Update the Contributing section.
-   - Remove or update the badges.
-
-3. Set the copyright year and owner in `LICENSE.txt`.
-
-4. Customize `package.json and `bower.json`.
+2. Run `./makenew.sh` and follow the prompts.
+   This will replace the boilerplate, delete itself,
+   and stage changes for commit.
+   This script assumes the project repository will be hosted on GitHub.
+   For an alternative location, you must update the URLs manually.
 
-5. Replace any remaining instances of the placeholder package name.
-   You can replace the placeholder package name and GitHub username
-   with your own using
+3. Fill in the README Description section.
 
-   ```
-   $ git ls-files -z | xargs -0 sed -i 's/coffeescript-package/your-package/g'
-   $ git ls-files -z | xargs -0 sed -i 's/makenew/your_username/g'
-   ```
-
-Note that `CHANGELOG.md` is just a template for this skeleton.
-The actual changes for this project are documented in the commit history
-and summarized under [Releases].
+4. If [choosing a license][Choose a license] other than the one provided:
+   update `LICENSE.txt`, the README License section,
+   `package.json`, and `bower.json` with your chosen license.
 
+[Choose a license]: http://choosealicense.com/
 [Releases]: https://github.com/makenew/coffeescript-package/releases
 [The Unlicense]: http://unlicense.org/UNLICENSE
 
@@ -89,19 +72,25 @@ $ git fetch upstream
 $ git merge upstream/master
 ```
 
+#### Changelog
+
+Note that `CHANGELOG.md` is just a template for this skeleton.
+The actual changes for this project are documented in the commit history
+and summarized under [Releases].
+
 ## Installation
 
 The recommended method is to add this as a dependency
 to your project using [npm] with
 
 ```
-$ npm Install --save coffeescript-package
+$ npm Install --save makenew-coffeescript-package
 ```
 
 or [Bower] with
 
 ```
-$ bower install --save coffeescript-package
+$ bower install --save makenew-coffeescript-package
 ```
 
 Alternatively, you can download a [release][Releases]
@@ -115,14 +104,14 @@ or clone the repository directly.
 
 ### Source Code
 
-The [coffeescript-package source] is hosted on GitHub.
+The [makenew-coffeescript-package source] is hosted on GitHub.
 To clone the project run
 
 ```
 $ git clone https://github.com/makenew/coffeescript-package.git
 ```
 
-[coffeescript-package source]: https://github.com/makenew/coffeescript-package
+[makenew-coffeescript-package source]: https://github.com/makenew/coffeescript-package
 
 ### Requirements
 
@@ -172,6 +161,10 @@ To submit a patch:
 
 ## License
 
+This software can be used freely, see [The Unlicense].
+The copyright text appearing below and elsewhere in this repository
+is for demonstration purposes only and does not apply to this software.
+
 This CoffeeScript package is licensed under the MIT license.
 
 ## Warranty

bower.json

@@ -1,10 +1,10 @@
 {
-  "name": "coffeescript-package",
+  "name": "makenew-coffeescript-package",
   "version": "0.0.0",
-  "description": "Package description.",
+  "description": "CoffeeScript package skeleton.",
   "main": "javascripts/main.coffee",
   "authors": [
-    "Your Name <you@example.com>"
+    "Evan Sosenko <razorx@evansosenko.com>"
   ],
   "keywords": [
     "coffeescript",

makenew.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env sh
+
+set -e
+set -u
+
+find_replace () {
+  git ls-files -z | xargs -0 sed -i "$1"
+}
+
+check_env () {
+  test -d .git || (echo 'This is not a Git repository. Exiting.' && exit 1)
+  for cmd in ${1}; do
+    command -v ${cmd} >/dev/null 2>&1 || \
+      (echo "Could not find '$cmd' which is required to continue." && exit 2)
+  done
+  echo
+  echo 'Ready to bootstrap your new project!'
+  echo
+}
+
+stage_env () {
+  echo
+  git rm -f makenew.sh
+  echo
+  echo 'Staging changes.'
+  git add --all
+  echo
+  echo 'Done!'
+  echo
+}
+
+makenew () {
+  read -p '> Package title: ' mk_title
+  read -p '> Package name (slug): ' mk_slug
+  read -p '> Short package description: ' mk_description
+  read -p '> Author name: ' mk_author
+  read -p '> Author email: ' mk_email
+  read -p '> Copyright owner: ' mk_owner
+  read -p '> Copyright year: ' mk_year
+  read -p '> GitHub user or organization name: ' mk_user
+  read -p '> GitHub repository name: ' mk_project
+
+  sed -i -e '11,79d;164,167d' README.md
+  sed -i -e "11i ${mk_description}" README.md
+
+  find_replace "s/CoffeeScript Package Skeleton/${mk_title}/g"
+  find_replace "s/CoffeeScript package skeleton\./${mk_description}/g"
+  find_replace "s/2015 Evan Sosenko/${mk_year} ${mk_owner}/g"
+  find_replace "s/Evan Sosenko/${mk_author}/g"
+  find_replace "s/razorx@evansosenko\.com/${mk_email}/g"
+  find_replace "s/makenew\/coffeescript-package/${mk_user}\/${mk_project}/g"
+  find_replace "s/makenew-coffeescript-package/${mk_slug}/g"
+
+  echo
+  echo 'Replacing boilerplate.'
+}
+
+check_env 'git read sed xargs'
+makenew
+stage_env
+exit

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "coffeescript-package",
+  "name": "makenew-coffeescript-package",
   "version": "0.0.0",
-  "description": "Package description.",
+  "description": "CoffeeScript package skeleton.",
   "main": "javascripts/main.coffee",
   "keywords": [
     "coffeescript",
@@ -12,7 +12,7 @@
   "repository": "makenew/coffeescript-package",
   "license": "MIT",
   "authors": [
-    "Your Name <you@example.com>"
+    "Evan Sosenko <razorx@evansosenko.com>"
   ],
   "scripts": {
     "install": "bower install",