feat: add lintfix and prettier scripts (#829)

fix lint-staged coverage
fix #827 to avoid eslint conflicts by reordering prettier in lintfix

Author: scscgit

packages/cna-template/template/_.prettierignore

@@ -0,0 +1,96 @@
+###
+# Place your Prettier ignore content here
+
+###
+# .gitignore content is duplicated here due to https://github.com/prettier/prettier/issues/8506
+
+# Created by .ignore support plugin (hsz.mobi)
+### Node template
+# Logs
+/logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# Nuxt generate
+dist
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+
+# IDE / Editor
+.idea
+
+# Service worker
+sw.*
+
+# macOS
+.DS_Store
+
+# Vim swap files
+*.swp

packages/cna-template/template/nuxt/.husky/.gitignore

@@ -1 +1 @@
-_
+_

packages/cna-template/template/nuxt/package.js

@@ -12,17 +12,27 @@ module.exports = {
 
     // Linter
     const eslint = linter.includes('eslint')
-    const lintStaged = eslint && linter.includes('lintStaged')
+    const lintStaged = linter.includes('lintStaged')
     const stylelint = linter.includes('stylelint')
     const prettier = linter.includes('prettier')
     const commitlint = linter.includes('commitlint')
     const lintScripts = {
       eslint: '<%= pmRun %> lint:js',
-      stylelint: '<%= pmRun %> lint:style'
+      stylelint: '<%= pmRun %> lint:style',
+      prettier: '<%= pmRun %> lint:prettier'
+    }
+    const lintfixScripts = {
+      // prettier before eslint to avoid conflicting rules like no-return-assign
+      // without having to use prettier via eslint (plugin:prettier/recommended)
+      prettier: 'prettier --write --list-different .',
+      eslint: "<%= pmRun %> lint:js <%= pm === 'npm' ? '-- ' : '' %>--fix",
+      stylelint: "<%= pmRun %> lint:style <%= pm === 'npm' ? '-- ' : '' %>--fix"
     }
 
     if (!eslint) {
+      lintStaged && delete pkg['lint-staged']["*.{js,<%= typescript ? 'ts,' : '' %>vue}"]
       delete lintScripts.eslint
+      delete lintfixScripts.eslint
       delete pkg.scripts['lint:js']
       delete pkg.devDependencies['@nuxtjs/eslint-config']
       delete pkg.devDependencies['@nuxtjs/eslint-module']
@@ -36,15 +46,20 @@ module.exports = {
       delete pkg.devDependencies['lint-staged']
     }
     if (!stylelint) {
-      lintStaged && delete pkg['lint-staged']['*.{css,vue}']
+      lintStaged && delete pkg['lint-staged']['*.{css,scss,sass,html,vue}']
       delete lintScripts.stylelint
+      delete lintfixScripts.stylelint
       delete pkg.scripts['lint:style']
       delete pkg.devDependencies['@nuxtjs/stylelint-module']
       delete pkg.devDependencies.stylelint
       delete pkg.devDependencies['stylelint-config-standard']
       delete pkg.devDependencies['stylelint-config-prettier']
     }
     if (!prettier) {
+      lintStaged && delete pkg['lint-staged']['*.**']
+      delete pkg.scripts['lint:prettier']
+      delete lintScripts.prettier
+      delete lintfixScripts.prettier
       delete pkg.devDependencies['eslint-config-prettier']
       delete pkg.devDependencies['stylelint-config-prettier']
       delete pkg.devDependencies.prettier
@@ -53,15 +68,25 @@ module.exports = {
       delete pkg.devDependencies['@commitlint/config-conventional']
       delete pkg.devDependencies['@commitlint/cli']
     }
-    if (!lintStaged && !commitlint) {
-      delete pkg.devDependencies.husky
-      delete pkg.scripts.prepare
-    }
 
     const lintScript = Object.values(lintScripts).join(' && ')
     if (lintScript) {
       pkg.scripts.lint = lintScript
     }
+    const lintfixScript = Object.values(lintfixScripts).join(' && ')
+    if (lintfixScript) {
+      pkg.scripts.lintfix = lintfixScript
+    }
+
+    if (!lintStaged && !commitlint) {
+      delete pkg.devDependencies.husky
+      delete pkg.scripts.prepare
+    } else {
+      // Move prepare to make it the last script
+      const prepare = pkg.scripts.prepare
+      delete pkg.scripts.prepare
+      pkg.scripts.prepare = prepare
+    }
 
     // Modules
     if (!features.includes('axios')) {

packages/cna-template/template/nuxt/package.json

@@ -4,13 +4,15 @@
     "build": "nuxt build",
     "start": "nuxt start",
     "generate": "nuxt generate",
-    "lint:js": "eslint --ext \".js,.vue\" --ignore-path .gitignore .",
-    "lint:style": "stylelint \"**/*.{vue,css}\" --ignore-path .gitignore",
+    "lint:js": "eslint --ext \".js<%= typescript ? ',.ts' : '' %>,.vue\" --ignore-path .gitignore .",
+    "lint:style": "stylelint \"**/*.{css,scss,sass,html,vue}\" --ignore-path .gitignore",
+    "lint:prettier": "prettier --check .",
     "prepare": "husky install"
   },
   "lint-staged": {
-    "*.{js,vue}": "eslint",
-    "*.{css,vue}": "stylelint"
+    "*.{js,<%= typescript ? 'ts,' : '' %>vue}": "eslint --cache",
+    "*.{css,scss,sass,html,vue}": "stylelint",
+    "*.**": "prettier --check --ignore-unknown"
   },
   "dependencies": {
     "@nuxt/content": "^1.15.1",

packages/create-nuxt-app/lib/saofile.js

@@ -103,6 +103,7 @@ module.exports = {
       files: '*',
       filters: {
         '_.eslintrc.js': 'linter.includes("eslint")',
+        '_.prettierignore': 'linter.includes("prettier")',
         '_.prettierrc': 'linter.includes("prettier")',
         '_jsconfig.json': 'devTools.includes("jsconfig.json")',
         'tsconfig.json': 'language.includes("ts")',
@@ -119,6 +120,7 @@ module.exports = {
       patterns: {
         gitignore: '.gitignore',
         '_package.json': 'package.json',
+        '_.prettierignore': '.prettierignore',
         '_.prettierrc': '.prettierrc',
         '_.eslintrc.js': '.eslintrc.js',
         '_jsconfig.json': 'jsconfig.json',
@@ -167,23 +169,8 @@ module.exports = {
 
     await this.npmInstall({ npmClient: this.answers.pm })
 
-    if (this.answers.linter.includes('eslint')) {
-      const options = ['run', 'lint:js', '--', '--fix']
-      if (this.answers.pm === 'yarn') {
-        options.splice(2, 1)
-      }
-      spawn.sync(this.answers.pm, options, {
-        cwd: this.outDir,
-        stdio: 'inherit'
-      })
-    }
-
-    if (this.answers.linter.includes('stylelint')) {
-      const options = ['run', 'lint:style', '--', '--fix']
-      if (this.answers.pm === 'yarn') {
-        options.splice(2, 1)
-      }
-      spawn.sync(this.answers.pm, options, {
+    if (['eslint', 'stylelint', 'prettier'].some(linter => this.answers.linter.includes(linter))) {
+      spawn.sync(this.answers.pm, ['run', 'lintfix'], {
         cwd: this.outDir,
         stdio: 'inherit'
       })