feat: could load template from npm

resolve #37

Author: Val-istar-Guo

package.json

@@ -55,6 +55,7 @@
     "sanitization": "^0.3.0",
     "semver": "^6.0.0",
     "sha1": "^1.1.1",
-    "simple-git": "^1.110.0"
+    "simple-git": "^1.110.0",
+    "validate-npm-package-name": "^3.0.0"
   }
 }

src/download-template/index.js

@@ -4,13 +4,15 @@ const throwError = require('../utils/throw-error')
 
 const copy = require('./copy')
 const clone = require('./clone')
+const npmInstall = require('./npm-install')
 
 
 module.exports = async (repository, version) => {
   const localStoragePath = getLocalStoragePath(repository, version)
 
   if (repository.type === 'local') await copy(repository, version, localStoragePath)
   else if (repository.type === 'git') await clone(repository, version, localStoragePath)
+  else if (repository.type == 'npm') await npmInstall(repository, version, localStoragePath)
   else {
     throwError([
       'Cannot parse template git repository or local path.',

src/download-template/npm-install.js

@@ -0,0 +1,32 @@
+const fs = require('fs-extra')
+const { join } = require('path')
+const childProcess = require('child_process')
+const { promisify } = require('util')
+const log = require('../utils/log')
+
+
+
+const genIndexFile = name => `
+const { join } = require('path')
+const config = require('${name}')
+config.path = join('./node_modules/${name}', config.path)
+
+module.exports = config
+`
+
+const exec = promisify(childProcess.exec)
+module.exports = async (repository, version, storage) => {
+  await fs.emptyDir(storage)
+  log.info(`install ${repository.name} template from npm...`)
+
+  await fs.writeJSON(join(storage, 'package.json'), {
+    main: 'index.js',
+    description: '',
+    license: 'MIT',
+  })
+  await fs.writeFile(join(storage, 'index.js'), genIndexFile(repository.name))
+  await fs.writeFile(join(storage, '.npmrc'), 'package-lock=false')
+
+  const command = `npm install ${repository.name}@${version.number}`
+  await exec(command, { cwd: storage })
+}

src/get-template-versions.js

@@ -2,8 +2,11 @@ const git = require('simple-git/promise')
 const semver = require('semver')
 const log = require('./utils/log')
 const isRepo = require('./utils/is-repository')
+const childProcess = require('child_process')
+const { promisify } = require('util')
 
 
+const exec = promisify(childProcess.exec)
 const getRepositoryVersions = async (repository) => {
   const result = await git().listRemote(['--tags', repository.url])
   const arr = result.split('\n')
@@ -29,12 +32,20 @@ const getRepositoryVersions = async (repository) => {
   return versions
 }
 
+const getNpmVersion = async repository => {
+  const { stdout, stderr } = await exec(`npm view ${repository.name} versions  --json`)
+  if (stderr) console.error(stderr)
+  return JSON.parse(stdout).reverse().map(number => ({ number }))
+}
+
 module.exports = async (repository) => {
   log.info('check template versions')
   if (repository.type === 'git') {
     return await getRepositoryVersions(repository)
   } else if (repository.type === 'local' && await isRepo(repository.url)) {
     return await getRepositoryVersions(repository)
+  } else if (repository.type === 'npm') {
+    return await getNpmVersion(repository)
   } else {
     return []
   }

src/utils/format-repository.js

@@ -1,6 +1,7 @@
 const throwError = require('./throw-error')
 const fs = require('fs-extra')
 const { join, isAbsolute } = require('path')
+const validateNpmPackageName = require("validate-npm-package-name")
 
 const githubSH = /^(github:)?[-a-zA-Z0-9@:%._\+~#=]+\/[-a-zA-Z0-9@:%._\+~#=]+$/
 const gitUrlRegexp = /((git|ssh|http(s)?)|(git@[\w.]+))(:(\/\/)?)([\w.@:/\-~]+)(\.git)(\/)?$/
@@ -52,6 +53,9 @@ module.exports = (link) => {
     return formatRepository(`https://github.com/${link.replace(/^github:/, '')}.git`)
   } else if (gitUrlRegexp.test(link)) {
     return formatRepository(link)
+  } else if (/^npm:/.test(link) && validateNpmPackageName(link.substring('npm:'.length))) {
+    // npm:xxxx/xxx
+    return { type: 'npm', url: link, owner: '', name: link.substring('npm:'.length), path: link }
   }
 
   throwError(`Invalid repository url: ${link}`)