script-script's Introduction

script script

A script for your scripts. Politely install config files and package scripts by reading from templates in your home directory, and never overwriting files without asking. Sometimes you want one command that will install dependencies, add config files, and add scripts to package.json.

install

$ npm install -g script-script

recipes

Write recipes in ~/.script-script/index.json.

{
    "travis": {
        "files": [ ["travis.yml", ".travis.yml"] ]
    },

    "husky": {
        "devinstall": ["husky"],
        "scripts": {
            "prepush": "./test/githook/prepush.sh"
        },
        "files": [ ["prepush.sh", "./test/githook/prepush.sh"] ]
    },

    "lint": {
        "devinstall": ["eslint", "eslint-config-minlint"],
        "scripts": {
            "lint": "eslint ."
        },
        "files": [
            ["eslintrc", ".eslintrc"],
            ["eslintignore", ".eslintignore"]
        ]
    },

    "demo": {
        "package.json": {
            "browser": {
              "request": "xhr"
            },
            "aliasify": {
              "aliases": {
                "react": "preact-compat",
                "react-dom": "preact-compat",
                "create-react-class": "preact-compat/lib/create-react-class"
              }
            },
            "engines": {
              "npm": "^5.0.0",
              "node": "^8.0.0"
            }
        }
    }
}

Each key is a recipe name, and sub-keys point to actions to perform.

actions

devinstall

A list of package names that should be installed and added to devDependencies.

scripts

Scripts are added to package.json scripts.

files

An array of files to copy from ~/.script-script to the current directory. The files can be a string, or a pair of [source file, dest file]. If the path conflicts with an existing file, you will be prompted if you want to overwrite it.