Remote Templates #329
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,40 @@ | ||
| import fs from 'fs.promised'; | ||
| import { resolve } from 'path'; | ||
| import ora from 'ora'; | ||
| import glob from 'glob'; | ||
| import gittar from 'gittar'; | ||
| import { green } from 'chalk'; | ||
| import { prompt } from 'inquirer'; | ||
| import asyncCommand from '../lib/async-command'; | ||
| import { install, initGit, addScripts } from './../lib/setup'; | ||
| import { isDir, hasCommand, error, trim, warn } from '../util'; | ||
|
|
||
| const TEMPLATES = { | ||
| full: 'preactjs-templates/default', | ||
| default: 'preactjs-templates/default', | ||
| // simple: 'examples/simple', | ||
| // empty: 'examples/empty', | ||
| // root: 'examples/root', | ||
| }; | ||
|
|
||
| export default asyncCommand({ | ||
| command: 'create <template> <dest>', | ||
|
|
||
| desc: 'Create a new application.', | ||
|
|
||
| builder: { | ||
| name: { | ||
| description: 'The application\'s name' | ||
| }, | ||
| force: { | ||
| description: 'Force option to create the directory for the new app', | ||
| default: false | ||
| }, | ||
| yarn: { | ||
| description: "Use 'yarn' instead of 'npm'", | ||
| type: 'boolean', | ||
| default: false | ||
| }, | ||
| git: { | ||
| description: 'Initialize version control using git', | ||
| type: 'boolean', | ||
|
|
@@ -76,153 +48,121 @@ export default asyncCommand({ | |
| }, | ||
|
|
||
| async handler(argv) { | ||
| let isYarn = argv.yarn && hasCommand('yarn'); | ||
| let cwd = argv.cwd ? resolve(argv.cwd) : process.cwd(); | ||
| let target = argv.dest && resolve(cwd, argv.dest); | ||
| let exists = target && isDir(target); | ||
|
|
||
| if (target) { | ||
| if (exists && !argv.force) { | ||
| return error('Refusing to overwrite current directory! Please specify a different destination or use the `--force` flag', 1); | ||
| } | ||
|
|
||
| if (exists && argv.force) { | ||
| let { enableForce } = await prompt({ | ||
| type: 'confirm', | ||
| name: 'enableForce', | ||
| message: `You are using '--force'. Do you wish to continue?`, | ||
| default: false | ||
| }); | ||
|
|
||
| if (enableForce) { | ||
| process.stdout.write('Initializing project in the current directory...\n'); | ||
| } else { | ||
| return error('Refusing to overwrite current directory!', 1); | ||
| } | ||
| } | ||
| } else { | ||
| // TODO: interactive | ||
|
Member
There was a problem hiding this comment. @developit Should we really do this? This make it more complex for us to handle.
Member
Author
There was a problem hiding this comment. Let's save this discussion for a future PR. I want to break it up instead of making this (even more) massive. |
||
| } | ||
|
|
||
| let repo = TEMPLATES[argv.template] || argv.template; | ||
|
|
||
|
Member
There was a problem hiding this comment. Would it be reasonable here to do something like: "if
Member
Author
There was a problem hiding this comment. Sure. Or just include new official templates (should not be often!) as patch releases. |
||
| // Attempt to fetch the `template` | ||
| let archive = await gittar.fetch(repo).catch(err => { | ||
| err = err || { message:'An error occured while fetching template.' }; | ||
| return error(err.code === 404 ? `Could not find repostory: ${repo}` : err.message, 1); | ||
| }); | ||
|
|
||
| let spinner = ora({ | ||
| text: 'Creating project', | ||
| color: 'magenta' | ||
| }).start(); | ||
|
|
||
| // Extract files from `archive` to `target` | ||
| await gittar.extract(archive, target, { | ||
| strip: 2, | ||
| filter(path) { | ||
| // TODO: remove `/build/` ?? | ||
| // TODO: read & respond to meta/hooks | ||
| return path.includes('/template/') && !path.includes('/build/'); | ||
|
Member
There was a problem hiding this comment. If we don't find
Member
Author
There was a problem hiding this comment. Good point. Let's do that in another PR. return error(`No \`template\` directory found within ${ repo }!`);
Member
There was a problem hiding this comment. Could even detect
Member
Author
There was a problem hiding this comment. I think we need to force a template structure. When things become too flexible they become less clear and harder to debug. |
||
| } | ||
| }); | ||
|
|
||
| spinner.text = 'Parsing `package.json` file'; | ||
|
|
||
| // Validate user's `package.json` file | ||
| let pkgData; | ||
| let pkgFile = resolve(target, 'package.json'); | ||
|
|
||
| if (pkgFile) { | ||
| pkgData = JSON.parse(await fs.readFile(pkgFile)); | ||
| // Write default "scripts" if none found | ||
| pkgData.scripts = pkgData.scripts || (await addScripts(pkgData, target, isYarn)); | ||
|
Member
There was a problem hiding this comment. Maybe instead of making pkgData.scripts = {
...(pkgData.scripts || {}),
...(await addScripts(pkgData, target, isYarn))
};
Member
There was a problem hiding this comment.
I don't think there is a necessary for that since templates will have scripts defined in the package.json file (includes our scripts too)
Member
There was a problem hiding this comment. Just sucks if the cli wants to change script down the line 😋 |
||
| } else { | ||
| warn('Could not locate `package.json` file!'); | ||
| } | ||
|
|
||
| if (argv.name) { | ||
| spinner.text = 'Updating `name` within `package.json` file'; | ||
| // Update `package.json` key | ||
| pkgData && (pkgData.name = argv.name); | ||
| // Find a `manifest.json`; use the first match, if any | ||
| let files = await Promise.promisify(glob)(target + '/**/manifest.json'); | ||
| let manifest = files[0] && JSON.parse(await fs.readFile(files[0])); | ||
| if (manifest) { | ||
| spinner.text = 'Updating `name` within `manifest.json` file'; | ||
| manifest.name = manifest.short_name = argv.name; | ||
| // Write changes to `manifest.json` | ||
| await fs.writeFile(files[0], JSON.stringify(manifest, null, 2)); | ||
| if (argv.name.length > 12) { | ||
| // @see https://developer.chrome.com/extensions/manifest/name#short_name | ||
| process.stdout.write('\n'); | ||
| warn('Your `short_name` should be fewer than 12 characters.'); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (pkgData) { | ||
| // Assume changes were made ¯\_(ツ)_/¯ | ||
| await fs.writeFile(pkgFile, JSON.stringify(pkgData, null, 2)); | ||
| } | ||
|
|
||
| if (argv.install) { | ||
| spinner.text = 'Installing dependencies'; | ||
| await install(target, isYarn); | ||
| } | ||
|
|
||
| spinner.succeed('Done!\n'); | ||
|
|
||
| if (argv.git) { | ||
| await initGit(target); | ||
| } | ||
|
|
||
| let pfx = isYarn ? 'yarn' : 'npm run'; | ||
|
|
||
| return trim(` | ||
| To get started, cd into the new directory: | ||
| ${ green('cd ' + argv.dest) } | ||
|
|
||
| To start a development live-reload server: | ||
| ${ green(pfx + ' start') } | ||
|
|
||
| To create a production build (in ./build): | ||
| ${ green(pfx + ' build') } | ||
|
|
||
| To start a production HTTP/2 server: | ||
| ${ green(pfx + ' serve') } | ||
| `) + '\n'; | ||
| } | ||
| }); | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why both
full&default? Since they do the same thing.Instead we can just add
default&simplefrom templates.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add
simple. @developit requested in Slack that we make default an alias offullThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was just thinking "principle of least surprise" here, this makes it work quite similarly to how it does in 1.0.