style: setup lint and format

billyyyyy3320 · billyyyyy3320 · commit 49913930fb35 · 2020-10-12T19:13:14.000+08:00
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,14 @@
+module.exports = {
+  root: true,
+
+  env: {
+    node: true,
+    es6: true
+  },
+
+  extends: ['plugin:prettier/recommended'],
+
+  rules: {
+    'no-undef': ['error']
+  }
+};
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,4 @@
+module.exports = {
+  singleQuote: true,
+  tabWidth: 2,
+}
diff --git a/cli.js b/cli.js
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-const {existsSync} = require('fs');
-const {join} = require('path');
+const { existsSync } = require('fs');
+const { join } = require('path');
 const yParser = require('yargs-parser');
 const semver = require('semver');
 const chalk = require('chalk');
@@ -11,22 +11,22 @@ const run = require('./lib/run');
 const args = yParser(process.argv.slice(2));
 
 if (args.v || args.version) {
-	console.log(require('./package').version);
-	if (existsSync(join(__dirname, '.local'))) {
-		console.log(chalk.cyan('@local'));
-	}
-	process.exit(0);
+  console.log(require('./package').version);
+  if (existsSync(join(__dirname, '.local'))) {
+    console.log(chalk.cyan('@local'));
+  }
+  process.exit(0);
 }
 
 if (!semver.satisfies(process.version, '>= 8.0.0')) {
-	console.error(
-		chalk.red('✘ The generator will only work with Node v8.0.0 and up!')
-	);
-	process.exit(1);
+  console.error(
+    chalk.red('✘ The generator will only work with Node v8.0.0 and up!')
+  );
+  process.exit(1);
 }
 
 const name = args._[0] || '';
 run({
-	name,
-	args
+  name,
+  args
 });
diff --git a/lib/BasicGenerator.js b/lib/BasicGenerator.js
@@ -1,48 +1,48 @@
-const {statSync} = require('fs');
-const {basename} = require('path');
+const { statSync } = require('fs');
+const { basename } = require('path');
 const Generator = require('yeoman-generator');
 const glob = require('glob');
 const debug = require('debug')('create-vuepress:BasicGenerator');
 
 function noop() {
-	return true;
+  return true;
 }
 
 class BasicGenerator extends Generator {
-	constructor(opts) {
-		super(opts);
-		this.opts = opts;
-		this.name = basename(opts.env.cwd);
-	}
+  constructor(opts) {
+    super(opts);
+    this.opts = opts;
+    this.name = basename(opts.env.cwd);
+  }
 
-	isTsFile(f) {
-		return (
-			f.endsWith('.ts') ||
-			f.endsWith('.tsx') ||
-			['tsconfig.json', 'tslint.yml'].includes(f)
-		);
-	}
+  isTsFile(f) {
+    return (
+      f.endsWith('.ts') ||
+      f.endsWith('.tsx') ||
+      ['tsconfig.json', 'tslint.yml'].includes(f)
+    );
+  }
 
-	writeFiles({context, filterFiles = noop}) {
-		debug(`context: ${JSON.stringify(context)}`);
-		glob
-			.sync('**/*', {
-				cwd: this.templatePath(),
-				dot: true
-			})
-			.filter(filterFiles)
-			.forEach(file => {
-				debug(`copy ${file}`);
-				const filePath = this.templatePath(file);
-				if (statSync(filePath).isFile()) {
-					this.fs.copyTpl(
-						this.templatePath(filePath),
-						this.destinationPath(file.replace(/^_/, '.')),
-						context
-					);
-				}
-			});
-	}
+  writeFiles({ context, filterFiles = noop }) {
+    debug(`context: ${JSON.stringify(context)}`);
+    glob
+      .sync('**/*', {
+        cwd: this.templatePath(),
+        dot: true
+      })
+      .filter(filterFiles)
+      .forEach(file => {
+        debug(`copy ${file}`);
+        const filePath = this.templatePath(file);
+        if (statSync(filePath).isFile()) {
+          this.fs.copyTpl(
+            this.templatePath(filePath),
+            this.destinationPath(file.replace(/^_/, '.')),
+            context
+          );
+        }
+      });
+  }
 }
 
 module.exports = BasicGenerator;
diff --git a/lib/generators/blog/index.js b/lib/generators/blog/index.js
@@ -1,43 +1,43 @@
 const BasicGenerator = require('../../BasicGenerator');
 
 class Generator extends BasicGenerator {
-	prompting() {
-		const prompts = [
-			{
-				name: 'name',
-				message: `What's the name of your project?`,
-				default: this.name
-			},
-			{
-				name: 'description',
-				message: `What's the description of your project?`
-			},
-			{
-				name: 'mail',
-				message: `What's your email?`
-			},
-			{
-				name: 'author',
-				message: `What's your name?`
-			},
-			{
-				name: 'repo',
-				message: `What's the repo of your project?`
-			}
-		];
-		return this.prompt(prompts).then(props => {
-			this.prompts = props;
-		});
-	}
+  prompting() {
+    const prompts = [
+      {
+        name: 'name',
+        message: `What's the name of your project?`,
+        default: this.name
+      },
+      {
+        name: 'description',
+        message: `What's the description of your project?`
+      },
+      {
+        name: 'mail',
+        message: `What's your email?`
+      },
+      {
+        name: 'author',
+        message: `What's your name?`
+      },
+      {
+        name: 'repo',
+        message: `What's the repo of your project?`
+      }
+    ];
+    return this.prompt(prompts).then(props => {
+      this.prompts = props;
+    });
+  }
 
-	writing() {
-		this.writeFiles({
-			context: this.prompts,
-			filterFiles: () => {
-				return true;
-			}
-		});
-	}
+  writing() {
+    this.writeFiles({
+      context: this.prompts,
+      filterFiles: () => {
+        return true;
+      }
+    });
+  }
 }
 
 module.exports = Generator;
diff --git a/lib/generators/docs/index.js b/lib/generators/docs/index.js
@@ -1,27 +1,27 @@
-const BasicGenerator = require("../../BasicGenerator");
+const BasicGenerator = require('../../BasicGenerator');
 
 class Generator extends BasicGenerator {
   prompting() {
     const prompts = [
       {
-        name: "name",
+        name: 'name',
         message: `What's the name of your project?`,
         default: this.name
       },
       {
-        name: "description",
+        name: 'description',
         message: `What's the description of your project?`
       },
       {
-        name: "mail",
+        name: 'mail',
         message: `What's your email?`
       },
       {
-        name: "author",
+        name: 'author',
         message: `What's your name?`
       },
       {
-        name: "repo",
+        name: 'repo',
         message: `What's the repo of your project?`
       }
     ];
diff --git a/lib/run.js b/lib/run.js
@@ -1,15 +1,15 @@
-const fs = require("fs");
-const path = require("path");
-const chalk = require("chalk");
-const mkdirp = require("mkdirp");
-const inquirer = require("inquirer");
-const clipboardy = require("clipboardy");
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const mkdirp = require('mkdirp');
+const inquirer = require('inquirer');
+const clipboardy = require('clipboardy');
 
-const sequences = ["docs", "blog"];
+const sequences = ['docs', 'blog'];
 
 const generators = fs
   .readdirSync(`${__dirname}/generators`)
-  .filter(f => !f.startsWith("."))
+  .filter(f => !f.startsWith('.'))
   .sort((previous, next) =>
     sequences.indexOf(previous) > sequences.indexOf(next) ? 1 : -1
   )
@@ -23,9 +23,9 @@ const generators = fs
     };
   });
 
-const runGenerator = async (
+const runGenerator = (
   generatorPath,
-  { name = "", cwd = process.cwd(), args = {} }
+  { name = '', cwd = process.cwd(), args = {} }
 ) => {
   return new Promise(resolve => {
     if (name) {
@@ -47,17 +47,17 @@ const runGenerator = async (
       if (name) {
         if (process.platform !== `linux` || process.env.DISPLAY) {
           clipboardy.writeSync(`cd ${name}`);
-          console.log("📋 Copied to clipboard, just use Ctrl+V");
+          console.log('📋 Copied to clipboard, just use Ctrl+V');
         }
       }
 
-      console.log("✨ File Generate Done");
+      console.log('✨ File Generate Done');
       resolve(true);
     });
   });
 };
 
-const run = async config => {
+const run = config => {
   return inquirer
     .prompt([
       {
diff --git a/package.json b/package.json
@@ -10,7 +10,9 @@
   "bin": {
     "create-vuepress-site": "cli.js"
   },
-  "scripts": {},
+  "scripts": {
+    "lint": "eslint . --ext .js"
+  },
   "repository": {
     "url": "vuepressjs/create-vuepress-site",
     "type": "git"
@@ -33,6 +35,9 @@
     "yeoman-generator": "^4.0.1"
   },
   "devDependencies": {
+    "eslint": "^7.11.0",
+    "eslint-config-prettier": "^6.12.0",
+    "eslint-plugin-prettier": "^3.1.4",
     "husky": "1.3.1",
     "lint-staged": "8.1.0"
   },
@@ -43,6 +48,7 @@
   },
   "lint-staged": {
     "*.js": [
+      "eslint --fix",
       "git add"
     ]
   },
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,27 +1,27 @@`
`1`		`-const BasicGenerator = require("../../BasicGenerator");`
	`1`	`+const BasicGenerator = require('../../BasicGenerator');`
`2`	`2`
`3`	`3`	`class Generator extends BasicGenerator {`
`4`	`4`	`prompting() {`
`5`	`5`	`const prompts = [`
`6`	`6`	`{`
`7`		`- name: "name",`
	`7`	`+ name: 'name',`
`8`	`8`	message: `What's the name of your project?`,
`9`	`9`	`default: this.name`
`10`	`10`	`},`
`11`	`11`	`{`
`12`		`- name: "description",`
	`12`	`+ name: 'description',`
`13`	`13`	message: `What's the description of your project?`
`14`	`14`	`},`
`15`	`15`	`{`
`16`		`- name: "mail",`
	`16`	`+ name: 'mail',`
`17`	`17`	message: `What's your email?`
`18`	`18`	`},`
`19`	`19`	`{`
`20`		`- name: "author",`
	`20`	`+ name: 'author',`
`21`	`21`	message: `What's your name?`
`22`	`22`	`},`
`23`	`23`	`{`
`24`		`- name: "repo",`
	`24`	`+ name: 'repo',`
`25`	`25`	message: `What's the repo of your project?`
`26`	`26`	`}`
`27`	`27`	`];`