Update code to ESM, rewrite readme

hum-n · hum-n · commit b83b7a68ecf1 · 2021-01-27T22:42:20.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 node_modules
 npm-debug.log
 yarn.lock
+package-lock.json
 .DS_Store
diff --git a/.prettierrc b/.prettierrc
@@ -1,5 +1,6 @@
 {
 	"singleQuote": true,
 	"trailingComma": "none",
-	"printWidth": 100
+	"arrowParens": "avoid",
+	"printWidth": 90
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,21 +1,23 @@
 {
 	"name": "create-nativeweb",
 	"version": "0.1.1",
-	"description": "🎨 Command-line tool for Native Web.",
+	"description": "🧶 Command-line tool for Native Web.",
 	"repository": "nativew/create",
 	"author": "Antoine Boulanger (https://github.com/antoineboulanger)",
 	"license": "ISC",
+	"exports": "./src/index.js",
 	"main": "src/index.js",
+	"type": "module",
 	"bin": {
 		"nativeweb": "src/index.js"
 	},
 	"scripts": {
-		"format": "prettier --write 'src/**/*.js'"
-	},
-	"devDependencies": {
-		"prettier": "^2.0.5"
+		"format": "prettier --write --ignore-unknown '**/*'"
 	},
 	"files": [
 		"src"
-	]
+	],
+	"devDependencies": {
+		"prettier": "^2.2.1"
+	}
 }
diff --git a/readme.md b/readme.md
@@ -1,30 +1,31 @@
-# Create 🎨
+# Create 🧶
+
 Command-line tool for [Native Web](https://github.com/nativew/nativeweb).
 
-## ✨ Features
-- **Init**. Start a project with [Start](https://github.com/nativew/start) 🧨.
+<br>
+
+### Initialize your project
+
+### Right from the terminal
+
+<br>
+
+### One command to [start](https://github.com/nativew/start)
 
-## 🚀 Start
 ```zsh
-# Create a new project
 npm init nativeweb
-
-# And run it 👟
-npm start
 ```
 
-## 🚨 Requirements
-| Name | Version |
-| ---- | ------- |
-| [Git](https://git-scm.com) | Any |
-| [Node](https://nodejs.org) | Recent |
+<br>
+
+### Includes
+
+[Start 🧨](https://github.com/nativew/start) &nbsp; → &nbsp; Starter boilerplate for Native Web.
+
+<br><br>
 
-## 🤝 License 
-[ISC](https://github.com/nativew/build/blob/master/license)
+<a href="https://github.com/nativew/nativeweb">
+    <img src="https://raw.githubusercontent.com/nativew/nativeweb/1e9405c629e3a6491bb59df726044eb3823967bb/logo-square_nativeweb.svg" alt="Native Web" width="80px">
+</a>
 
-<p>
 <br>
-    <a href="https://github.com/nativew/create">
-        <img src="https://raw.githubusercontent.com/nativew/nativeweb/53d4fe591d5992c81b3faeb656fd1aea7aabb413/logo-square.svg?sanitize=true" alt="Native Web" width="50px">
-    </a>
-</p>
diff --git a/src/data.js b/src/data.js
@@ -1,13 +1,11 @@
-const url = 'https://github.com/nativew/start';
+export const url = 'https://github.com/nativew/start';
 
-const msgs = {
+export const msgs = {
 	one: '👋 What’s the name of your project? ',
 	twoStart: '👌 Let’s start ',
-	twoEnd: '.',
-	three: '🤙 Ready to go! ',
+	twoEnd: '',
+	three: '🤙 Ready to go! Run ',
 	cmdStart: ' cd ',
 	cmdEnd: ' && npm start ',
 	error: '👎 Try another name?'
 };
-
-module.exports = { url, msgs };
diff --git a/src/index.js b/src/index.js
@@ -1,38 +1,36 @@
 #!/usr/bin/env node
-const { msgs } = require('./data');
-const log = require('./modules/log');
-const color = require('./modules/color');
-const highlight = require('./modules/highlight');
-const clone = require('./modules/clone');
-const install = require('./modules/install');
+import clone from './modules/clone.js';
+import install from './modules/install.js';
+import log from './modules/log.js';
+import highlight from './modules/highlight.js';
+import rl from './modules/rl.js';
+import color from './modules/color.js';
+import { msgs } from './data.js';
 
-// Get argument for name
 let name = process.argv[2];
 
-if (name) {
-	// Has name, start cloning
-	log(msgs.twoStart + name + msgs.twoEnd);
-	start();
-} else {
-	// Doesn't have name, ask question
-	const rl = require('./modules/rl');
+const start = () => {
+	if (clone(name)) {
+		install(name);
+		log(msgs.three + highlight(msgs.cmdStart + name + msgs.cmdEnd));
+	} else {
+		log(msgs.error);
+	}
+
+	process.exit();
+};
 
-	rl.question(color(msgs.one), (answer) => {
-		// Set answer as name & start cloning
+const askName = () =>
+	rl.question(color(msgs.one), answer => {
 		name = answer;
 		log(msgs.twoStart + answer + msgs.twoEnd);
 		rl.close();
 		start();
 	});
-}
 
-function start() {
-	if (clone(name)) {
-		// Clone sucess, install packages
-		install(name);
-		log(msgs.three + highlight(msgs.cmdStart + name + msgs.cmdEnd));
-	} else {
-		// Clone fail, log error message
-		log(msgs.error);
-	}
+if (name) {
+	log(msgs.twoStart + name + msgs.twoEnd);
+	start();
+} else {
+	askName();
 }
diff --git a/src/modules/clone.js b/src/modules/clone.js
@@ -1,16 +1,15 @@
-const { url } = require('../data');
-const run = require('./run');
+import run from './run.js';
+import { url } from '../data.js';
 
-function clone(dest) {
+const clone = dest => {
 	const cmd = run('git', ['clone', '--depth=1', url, dest]);
 
 	if (cmd.status == 0) {
-		// Delete .git folder
 		run('rm', ['-rf', `${dest}/.git`]);
 		return true;
-	} else {
-		return false;
 	}
-}
 
-module.exports = clone;
+	return false;
+};
+
+export default clone;
diff --git a/src/modules/color.js b/src/modules/color.js
@@ -1,7 +1,7 @@
-const { yellow, reset } = require('./styles');
+import styles from './styles.js';
 
-function color(text) {
-	return yellow + text + reset;
-}
+const { yellow, reset } = styles;
 
-module.exports = color;
+const color = text => yellow + text + reset;
+
+export default color;
diff --git a/src/modules/exists.js b/src/modules/exists.js
@@ -1,7 +1,5 @@
-const fs = require('fs');
+import fs from 'fs';
 
-function exists(path) {
-	return fs.existsSync(path) ? true : false;
-}
+const exists = path => (fs.existsSync(path) ? true : false);
 
-module.exports = exists;
+export default exists;
diff --git a/src/modules/highlight.js b/src/modules/highlight.js
@@ -1,7 +1,7 @@
-const { bgGreen, black, reset } = require('./styles');
+import styles from './styles.js';
 
-function highlight(text) {
-	return bgGreen + black + text + reset;
-}
+const { bgGreen, black, reset } = styles;
 
-module.exports = highlight;
+const highlight = text => bgGreen + black + text + reset;
+
+export default highlight;
diff --git a/src/modules/install.js b/src/modules/install.js
@@ -1,8 +1,7 @@
-const exists = require('./exists');
-const run = require('./run');
+import exists from './exists.js';
+import run from './run.js';
 
-function install(dest) {
+const install = dest =>
 	exists(`${dest}/package.json`) && run('npm', ['install', '--prefix', dest]);
-}
 
-module.exports = install;
+export default install;
diff --git a/src/modules/log.js b/src/modules/log.js
@@ -1,7 +1,5 @@
-const color = require('./color');
+import color from './color.js';
 
-function log(message) {
-	console.log(color(message));
-}
+const log = message => console.log(color(message));
 
-module.exports = log;
+export default log;
diff --git a/src/modules/rl.js b/src/modules/rl.js
@@ -1,8 +1,8 @@
-const readline = require('readline');
+import readline from 'readline';
 
 const rl = readline.createInterface({
 	input: process.stdin,
 	output: process.stdout
 });
 
-module.exports = rl;
+export default rl;
diff --git a/src/modules/run.js b/src/modules/run.js
@@ -1,7 +1,5 @@
-const { spawnSync } = require('child_process');
+import { spawnSync } from 'child_process';
 
-function run(cmd, args) {
-	return spawnSync(cmd, args, { stdio: 'inherit' });
-}
+const run = (cmd, args) => spawnSync(cmd, args, { stdio: 'inherit' });
 
-module.exports = run;
+export default run;
diff --git a/src/modules/styles.js b/src/modules/styles.js
@@ -26,4 +26,4 @@ const styles = {
 	bgWhite: '\x1b[47m'
 };
 
-module.exports = styles;
+export default styles;

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"singleQuote": true,`
`3`	`3`	`"trailingComma": "none",`
`4`		`- "printWidth": 100`
	`4`	`+ "arrowParens": "avoid",`
	`5`	`+ "printWidth": 90`
`5`	`6`	`}`