rock 0.4.0 → 0.9.0

package/package.json

@@ -1,60 +1,41 @@
 {
   "name": "rock",
-  "version": "0.4.0",
-  "description": "Generate and scaffold file structures or project skeletons from templates.",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/rocktemplates/rock"
+  "version": "0.9.0",
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": null
+    },
+    "./package.json": "./package.json"
   },
-  "keywords": [
-    "rock",
-    "foundation",
-    "skeleton",
-    "generate",
-    "template",
-    "scaffold"
+  "bin": {
+    "rock": "./dist/src/bin.js"
+  },
+  "files": [
+    "dist"
   ],
-  "author": "JP Richardson <jprichardson@gmail.com>",
-  "license": "MIT",
+  "scripts": {
+    "build": "tsc -p tsconfig.lib.json",
+    "dev": "tsc -p tsconfig.lib.json --watch",
+    "publish:npm": "npm publish --access public",
+    "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc"
+  },
   "dependencies": {
-    "autoresolve": "0.0.x",
-    "cl": "0.0.1",
-    "date-tokens": "0.0.x",
-    "fs-promise": "^0.5.0",
-    "github-download": "^0.5.0",
-    "globby": "^6.0.0",
-    "nomnom": "^1.8.1",
-    "osenv": "^0.1.3",
-    "path-exists": "^3.0.0",
-    "readline-prompter": "~0.2.0",
-    "string": "^3.3.1",
-    "superagent": "~0.14.1",
-    "tweezers": "~0.1.0",
-    "walker": "1.0.x"
+    "adm-zip": "^0.5.16",
+    "@react-native-community/cli-config": "^19.1.0",
+    "@rock-js/config": "^0.9.0",
+    "@rock-js/tools": "^0.9.0",
+    "commander": "^12.1.0",
+    "tar": "^7.4.3",
+    "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "mocha": "*",
-    "nock": "^8.0.0",
-    "standard": "^8.0.0",
-    "suppose": "^0.6.1",
-    "terst": "^0.3.0",
-    "testutil": "^0.7.0"
-  },
-  "main": "./lib/rock",
-  "scripts": {
-    "test": "standard && mocha test"
-  },
-  "bin": {
-    "rock": "./bin/rock"
+    "@react-native-community/cli-types": "^19.1.0",
+    "@types/adm-zip": "^0.5.7"
   },
-  "standard": {
-    "globals": [
-      "T",
-      "F",
-      "EQ",
-      "NEQ",
-      "APPROX",
-      "THROWS"
-    ]
+  "publishConfig": {
+    "access": "public"
   }
 }

package/.npmignore

@@ -1 +0,0 @@
-node_modules/

package/.travis.yml

@@ -1,4 +0,0 @@
-language: node_js
-node_js:
-  - "6"
-  - "4"

package/CHANGELOG.md

@@ -1,61 +0,0 @@
-0.3.1 / 2013-10-30
-------------------
-* removed `preferGlobal`
-* added `cl` require to `rock` bin (tayler / #10)
-
-0.3.0 / 2013-05-02
-------------------
-* added `cl` dep
-* updated deps
-* renamed `create()` to `fetchRepo()`
-* added ability to download single files
-* added rudimentary support for other templates
-
-0.2.0 / 2013-01-21
-------------------
-* Updated deps.
-* Removed post-install script.
-* Removed `--update` and `--list` flags.
-* Support installing from Github without Git dependency.
-* Support installing from Github using Github short-hand i.e. username/repo
-* Added default values to skip and prompt.
-* Changed config file name from `rockconf.json` to `rock.conf.json`.
-
-0.1.1 / 2012-09-06
-------------------
-* Dependencies update.
-
-0.1.0 / 2012-08-15
-------------------
-* Git not necessary for Rock located on the local machine. This helps with the programmability aspect.
-* Code cleanup using `BatchFlow` and `readline-prompter`.
-* `rock.create` now can take an input of values so that the the readline prompt doesn't display. Test passing.
-
-0.0.7 / 2012-08-13
-------------------
-* Fixed bug that prevented rocks without `ignoreDirs` to be created.
-
-0.0.6 / 2012-08-13
-------------------
-* Added `--update` command line arg.
-* Now proceeds regardless of whether it can parse `rockconf.json`.
-
-0.0.5 / 2012-08-12
-------------------
-* Fixed crashed on `rock --list`.
-
-0.0.4 / 2012-08-12
-------------------
-* Rocks can now specify to have directories ignored by putting `ignoreDirs` in their `rock.json` file.
-
-0.0.3 / 2012-08-11
-------------------
-* Fixed bug preventing rock from shutting down when using programatically.
-
-0.0.2 / 2012-08-09
-------------------
-* Hopefully fixing early broken release.
-
-0.0.1 / 2012-08-09
-------------------
-* Very early alpha release.

package/LICENSE

@@ -1,15 +0,0 @@
-(The MIT License)
-
-Copyright (c) 2012-2013, JP Richardson
-
-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 the Software without restriction, including without limitation the rights to use, copy, modify,
- merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
-WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
-OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/bin/rock

@@ -1,43 +0,0 @@
-#!/usr/bin/env node
-
-var P = require('autoresolve')
-var rock = require(P('lib/rock.js'))
-var osenv = require('osenv')
-var fs = require('fs-promise')
-var path = require('path')
-var nom = require('nomnom')
-var cl = require('cl')
-
-var opts = nom.script('rock')
-  .option('version',  {help: 'Print version and exit.', flag: true, callback: function() { return require('../package.json').version }})
-  .option('path',     {help: 'Output path of generated directory structure.', position: 0, required: true})
-  .option('rock',     {help: 'The rock path or Github repo.', abbr: 'r', metavar: 'ROCK', required: true})
-  .option('config',   {help: 'The config file. Defaults to ~/.rock/rock.conf.json', abbr: 'c', default: path.join(osenv.home(), '.rock', 'rock.conf.json')})
-  .option('file',     {help: 'If the rock is a single file. Supports http as well.', abbr: 'f', flag: true, default: false} )
-  .option('topen',    {help: 'Opening template value. Defaults to {{', default: '{{'})
-  .option('tclose',   {help: 'Closing template value. Defaults to }}', default: '}}'})
-  .parse()
-
-
-var config = {}
-if (fs.existsSync(opts.config)) {
-  config = fs.readJSONSync(opts.config)
-}
-
-if (opts.rock && !opts.file) {
-  rock.fetchRepo(opts.path, opts.rock, config)
-  .catch(function(err){
-    if (err) cl.exit(1, err)
-  })
-}
-
-if (opts.rock && opts.file) {
-  if (opts.topen && opts.tclose) {
-    config.tokens = {open: opts.topen, close: opts.tclose}
-  }
-
-  rock.fetchFile(opts.path, opts.rock, config)
-  .catch(function(err) {
-    if (err) cl.exit(1, err)
-  })
-}

package/docs/predefined-tokens.md

@@ -1,31 +0,0 @@
-# Predefined tokens
-
-This is the full list of predefined tokens you can use in your rocks. All tokens begin with `-` to avoid collisions.
-
-## File Related
-
-- `-file` - The current filename
-
-## Date Related
-
-Assuming the current date was September 7, 2016; and the time was around 1:05 PM:
-
-| Token                | Value                    |
-| ---                  | ---                      |
-| `-date-year`         | 2016                     |
-| `-date-month`        | 09                       |
-| `-date-day`          | 07                       |
-| `-date-hour`         | 13                       |
-| `-date-hours`        | 13                       |
-| `-date-minute`       | 05                       |
-| `-date-minutes`      | 05                       |
-| `-date-mins`         | 05                       |
-| `-date-secs`         | 33                       |
-| `-date-seconds`      | 33                       |
-| `-date-millis`       | 345                      |
-| `-date-milliseconds` | 345                      |
-| `-date-ymd`          | 2016-09-07               |
-| `-date-hms`          | 13-05-33                 |
-| `-date-ymd`          | 2016-09-07-13-05-33      |
-| `-date-ymd_hms`      | 2016-09-07_13-05-33      |
-| `-date-iso`          | 2016-09-07T18:05:33.345Z |

package/lib/rock.js

@@ -1,213 +0,0 @@
-var fs = require('fs-promise')
-var path = require('path')
-var walker = require('walker')
-var tweezers = require('./tweezers')
-var dt = require('date-tokens')
-var rlp = require('readline-prompter')
-var ghdownload = require('github-download')
-var rutil = require('./util')
-var S = require('string')
-var agent = require('superagent')
-var globby = require('globby')
-var exists = require('path-exists')
-
-S.TMPL_OPEN = '{{'
-S.TMPL_CLOSE = '}}'
-
-function fetchFile (filePath, rock, options) {
-  if (!options) options = {}
-  if (!options.defaultValues) options.defaultValues = {}
-  if (!options.templateValues) options.templateValues = {}
-
-  filePath = path.resolve(filePath)
-
-  var topen = S.TMPL_OPEN
-  var tclose = S.TMPL_CLOSE
-
-  if (options.tokens) {
-    topen = options.tokens.open || S.TMPL_OPEN
-    tclose = options.tokens.close || S.TMPL_CLOSE
-  }
-
-  // Check if rock is local:
-  return exists(rock)
-  .then(function copyOrDownload (itsLocal) {
-    if (itsLocal) { // bug here if dir doesn't exist, TODO: fix
-      return fs.copy(rock, filePath)
-    } else {
-      return new Promise(function (resolve) {
-        agent.get(rock).buffer().end(function (res) {
-          resolve(fs.outputFile(filePath, res.text))
-        })
-      })
-    }
-  })
-  .then(function tweezeFiles () {
-    var files = [filePath]
-    return tweezers.readFilesAndExtract(files, topen, tclose)
-  })
-  .then(function promptUser (tokenObj) {
-    var replacements = {
-      '-file': topen + '-file' + tclose,
-      '-literal': topen
-    }
-
-    replacements = rutil.extend(replacements, dt.eval('-date-'))
-    replacements = rutil.extend(replacements, options.templateValues)
-
-    return new Promise(function (resolve) {
-      rlp(tokenObj.tokens, options.defaultValues, replacements).end(function (results) {
-        resolve(results)
-      })
-    })
-  })
-  .then(function outputFiles (replacements) {
-    return fs.readFile(filePath, 'utf8')
-    .then(function (data) {
-      replacements['-file'] = path.basename(filePath)
-      var newFileData = S(data).template(replacements, topen, tclose).s
-      return fs.writeFile(filePath, newFileData)
-    })
-  })
-}
-
-function fetchRepo (projectPath, repoPath, options) {
-  projectPath = path.resolve(projectPath)
-  var projectRockPath = path.join(projectPath, '.rock')
-  var projectRockConf = path.join(projectRockPath, 'rock.json')
-  var projectRockObj = {} // empty config
-
-  if (!options) options = {}
-  if (!options.defaultValues) options.defaultValues = {}
-  if (!options.templateValues) options.templateValues = {}
-
-  // Check if rock is local:
-  return exists(repoPath)
-  .then(function copyOrDownload (itsLocal) {
-    if (itsLocal) {
-      return fs.copy(repoPath, projectPath, {filter: function (p) {
-        return !/.*\/\.git$/.test(p)
-      }})
-    } else {
-      return new Promise(function (resolve, reject) {
-        ghdownload(repoPath, projectPath)
-        .on('error', reject)
-        .on('end', resolve)
-      })
-    }
-  })
-  .then(function checkRockConf () {
-    return exists(projectRockConf)
-  })
-  .then(function loadRockConf (rockConfExists) {
-    if (rockConfExists) {
-      return fs.readJson(projectRockConf)
-      .then(function (data) {
-        if (data) {
-          projectRockObj = data
-
-          if (projectRockObj.tokens) {
-            S.TMPL_OPEN = projectRockObj.tokens.open || S.TMPL_OPEN
-            S.TMPL_CLOSE = projectRockObj.tokens.close || S.TMPL_CLOSE
-          }
-        }
-      })
-    }
-  })
-  .then(function walkFilesAndLoadTokenSettings (data) {
-    // console.log('walkFiles')
-    var files = []
-    var ignoreDirs = []
-
-    if (projectRockObj) {
-      ignoreDirs = projectRockObj.ignoreDirs || []
-      ignoreDirs = ignoreDirs.map(function (dir) {
-        return path.resolve(projectPath, dir)
-      })
-    }
-
-    return new Promise(function (resolve, reject) {
-      walker(projectPath)
-      .filterDir(function (dir, stat) { // return false if you want to filter
-        // if current dir is the .rock filter, then obviously filter... else filter if it is found in ignoreDirs
-        return (dir === projectRockPath) ? false : !(ignoreDirs.indexOf(dir) >= 0)
-      })
-      .on('file', function (file) { files.push(file) })
-      .on('error', reject)
-      .on('end', function () {
-        resolve(files)
-      })
-    })
-  })
-  .then(function tweezeFiles (files) {
-    // console.log('tweezefiles')
-    return tweezers.readFilesAndExtract(files, S.TMPL_OPEN, S.TMPL_CLOSE)
-  })
-  .then(function promptUser (tokenObj) {
-    var replacements = {
-      '-file': S.TMPL_OPEN + '-file' + S.TMPL_CLOSE,
-      '-literal': S.TMPL_OPEN
-    }
-
-    replacements = rutil.extend(replacements, dt.eval('-date-'))
-    replacements = rutil.extend(replacements, options.templateValues)
-
-    return new Promise(function (resolve) {
-      rlp(tokenObj.tokens, options.defaultValues, replacements).end(function (results) {
-        resolve({
-          tokenObj: tokenObj,
-          replacements: results
-        })
-      })
-    })
-  })
-  .then(function outputFiles (results) {
-    var tokenObj = results.tokenObj
-    var replacements = results.replacements
-    delete tokenObj.tokens // we just want to process the files
-
-    // For each file:
-    return Promise.all(Object.keys(tokenObj).map(function (file) {
-      // Read it:
-      return fs.readFile(file, 'utf8')
-      .then(function renderTemplate (data) {
-        var newFileName = S(file).template(replacements).s
-        replacements['-file'] = path.basename(newFileName)
-
-        var newFileData = S(data).template(replacements).s
-
-        return fs.writeFile(newFileName, newFileData)
-        .then(function () {
-          // Pass newFileName to next function:
-          return newFileName
-        })
-      })
-      .then(function deleteOldFile (newFileName) {
-        if (file !== newFileName) {
-          return fs.remove(file)
-        }
-      })
-    })) // End of Promise.all
-  })
-  .then(function getDeleteFolderList () {
-    var deleteArr = []
-    if (projectRockObj.delete) {
-      deleteArr = globby.sync(projectRockObj.delete, {cwd: projectPath})
-      // Convert to absolute paths:
-      deleteArr = deleteArr.map(function (dir) {
-        return path.join(projectPath, dir)
-      })
-    }
-    // Add .rock to delete array:
-    deleteArr.push(projectRockPath)
-    return deleteArr
-  })
-  .then(function deleteFolders (deleteArr) {
-    return Promise.all(deleteArr.map(function (dir) {
-      return fs.remove(dir)
-    }))
-  })
-}
-
-module.exports.fetchRepo = fetchRepo
-module.exports.fetchFile = fetchFile

package/lib/tweezers.js

@@ -1,37 +0,0 @@
-var fs = require('fs-promise')
-var tweeze = require('tweezers')
-var rutil = require('./util')
-
-var me = module.exports
-me.open = null
-me.close = null
-
-function readFileAndExtract (file, callback) {
-  return fs.readFile(file, 'utf8')
-  .then(function (data) {
-    return tweeze(data, me.open, me.close)
-  })
-}
-
-function readFilesAndExtract (files, open, close) {
-  var fileObj = {}
-  var tokens = {}
-
-  me.open = open || me.open
-  me.close = close || me.open
-
-  return Promise.all(files.map(function (file) {
-    return readFileAndExtract(file)
-    .then(function (obj) {
-      rutil.extend(tokens, obj)
-      fileObj[file] = Object.keys(obj)
-    })
-  }))
-  .then(function () {
-    fileObj.tokens = Object.keys(tokens)
-    fileObj.tokens.sort()
-    return fileObj
-  })
-}
-
-module.exports.readFilesAndExtract = readFilesAndExtract

package/lib/util.js

@@ -1,9 +0,0 @@
-
-var me = module.exports
-
-me.extend = function (o1, o2) {
-  Object.keys(o2).forEach(function (key) {
-    o1[key] = o2[key]
-  })
-  return o1
-}

package/test/mocha.opts

@@ -1,3 +0,0 @@
---reporter spec
---ui bdd
---timeout 5000

package/test/resources/expect/myapp/LICENSE

@@ -1,15 +0,0 @@
-(The MIT License)
-
-Copyright (c) JP Richardson
-
-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 the Software without restriction, including without limitation the rights to use, copy, modify,
- merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
-WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
-OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/test/resources/expect/myapp/README.md

@@ -1,17 +0,0 @@
-Node.js - cool_module
-==========================
-
-A cool test for a sweet library.
-
-
-
-Installation
-------------
-
-    npm install cool_module
-
-
-License
--------
-
-Copyright JP Richardson <jprichardson@gmail.com>

package/test/resources/expect/myapp/ignore_this/READTHIS.md

@@ -1 +0,0 @@
-This should not have {{author}} populated.

package/test/resources/expect/myapp/lib/cool_module.js

@@ -1,4 +0,0 @@
-/*
-    Copyright JP Richardson <jprichardson@gmail.com>
-    File: cool_module.js
-*/

package/test/resources/expect/myapp/test/cool_module.test.js

@@ -1,4 +0,0 @@
-/*
-    Copyright JP Richardson <jprichardson@gmail.com>
-    File: cool_module.test.js
-*/

package/test/resources/rock.conf.json

@@ -1,3 +0,0 @@
-{
-
-}

package/test/resources/rocks/date.txt

@@ -1 +0,0 @@
-{{-date-ymd}}

package/test/resources/rocks/literal-alt.txt

@@ -1 +0,0 @@
-@@-literal@@

package/test/resources/rocks/literal.txt

@@ -1 +0,0 @@
-{{-literal}}

package/test/resources/rocks/node-lib/.rock/rock.json

@@ -1,9 +0,0 @@
-{
-    "name": "test",
-    "description": "Rock for unit testing rock itself.",
-    "scripts": {
-        "before": ["hi.sh"],
-        "after": ["bye.js"]
-    },
-    "ignoreDirs": ["./ignore_this"]
-}

package/test/resources/rocks/node-lib/.rock/scripts/bye.js

@@ -1 +0,0 @@
-console.log('ROCK SCRIPT: bye');

package/test/resources/rocks/node-lib/.rock/scripts/hi.sh

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-
-echo 'ROCK SCRIPT: hi'

package/test/resources/rocks/node-lib/LICENSE

@@ -1,15 +0,0 @@
-(The MIT License)
-
-Copyright (c) {{author}}
-
-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 the Software without restriction, including without limitation the rights to use, copy, modify,
- merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
-WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
-OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/test/resources/rocks/node-lib/README.md

@@ -1,17 +0,0 @@
-Node.js - {{project-name}}
-==========================
-
-{{project-description}}
-
-
-
-Installation
-------------
-
-    npm install {{project-name}}
-
-
-License
--------
-
-Copyright {{author}} <{{email}}>

package/test/resources/rocks/node-lib/ignore_this/READTHIS.md

@@ -1 +0,0 @@
-This should not have {{author}} populated.

package/test/resources/rocks/node-lib/lib/{{project-name}}.js

@@ -1,4 +0,0 @@
-/*
-    Copyright {{author}} <{{email}}>
-    File: {{-file}}
-*/

package/test/resources/rocks/node-lib/test/{{project-name}}.test.js

@@ -1,4 +0,0 @@
-/*
-    Copyright {{author}} <{{email}}>
-    File: {{-file}}
-*/

package/test/resources/rocks/node-lib-tmpl/.rock/rock.json

@@ -1,13 +0,0 @@
-{
-    "name": "node-lib",
-    "description": "Barebones Node.js project.",
-    "scripts": {
-        "before": ["hi.sh"],
-        "after": ["bye.js"]
-    },
-    "ignoreDirs": ["./ignore_this"],
-  "tokens": {
-    "open": "@@",
-    "close": "@@"
-  }
-}