feat: scaffold with integrated tests runner

Author: thetutlage

package-lock.json

@@ -37,7 +37,7 @@
     "cz-conventional-changelog": "^3.3.0",
     "del-cli": "^4.0.1",
     "doctoc": "^2.1.0",
-    "eslint": "^8.12.0",
+    "eslint": "^8.13.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-adonis": "^2.1.0",
     "eslint-plugin-prettier": "^4.0.0",
@@ -75,15 +75,16 @@
     "tag": "latest"
   },
   "dependencies": {
-    "@adonisjs/application": "^5.2.1",
+    "@adonisjs/application": "^5.2.3",
     "@adonisjs/sink": "^5.2.2",
     "@poppinss/prompts": "^2.0.2",
-    "@poppinss/utils": "^4.0.3",
+    "@poppinss/utils": "^4.0.4",
     "@types/fs-extra": "^9.0.13",
     "cli-width": "^3.0.0",
     "execa": "^5.1.1",
     "fs-extra": "^10.0.1",
-    "getopts": "^2.3.0"
+    "getopts": "^2.3.0",
+    "gradient-string": "^2.0.0"
   },
   "repository": {
     "type": "git",

package.json

@@ -7,8 +7,11 @@
  * file that was distributed with this source code.
  */
 
-/* eslint-disable-next-line */
-const art =
-  "    _       _             _         _     \n   / \\   __| | ___  _ __ (_)___    | |___ \n  / _ \\ / _` |/ _ \\| '_ \\| / __|_  | / __|\n / ___ \\ (_| | (_) | | | | \\__ \\ |_| \\__ \\\n/_/   \\_\\__,_|\\___/|_| |_|_|___/\\___/|___/\n"
+import gradient from 'gradient-string'
 
-export const showArt = () => console.log(art)
+const art = Buffer.from(
+  'CiAgICAgXyAgICAgICBfICAgICAgICAgICAgIF8gICAgICAgICBfIF9fX18gIAogICAgLyBcICAgX198IHwgX19fICBfIF9fIChfKV9fXyAgICB8IC8gX19ffCAKICAgLyBfIFwgLyBfYCB8LyBfIFx8ICdfIFx8IC8gX198XyAgfCBcX19fIFwgCiAgLyBfX18gXCAoX3wgfCAoXykgfCB8IHwgfCBcX18gXCB8X3wgfF9fXykgfAogL18vICAgXF9cX18sX3xcX19fL3xffCB8X3xffF9fXy9cX19fL3xfX19fLyAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCg==',
+  'base64'
+).toString()
+
+export const showArt = () => console.log(gradient.pastel.multiline(art))

src/Chalk/art.ts

@@ -16,13 +16,13 @@ export const packages: {
 } = {
   web: {
     '@adonisjs/core': {
-      version: '^5.4.0',
+      version: '^5.6.0',
     },
     '@adonisjs/repl': {
       version: '^3.1.0',
     },
     '@adonisjs/session': {
-      version: '^6.1.0',
+      version: '^6.2.0',
     },
     '@adonisjs/view': {
       version: '^6.1.0',
@@ -33,15 +33,15 @@ export const packages: {
   },
   api: {
     '@adonisjs/core': {
-      version: '^5.4.0',
+      version: '^5.6.0',
     },
     '@adonisjs/repl': {
       version: '^3.1.0',
     },
   },
   slim: {
     '@adonisjs/core': {
-      version: '^5.4.0',
+      version: '^5.6.0',
     },
   },
 }

src/schematics/packages.ts

@@ -0,0 +1,34 @@
+/*
+ * adonis-ts-boilerplate
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import execa from 'execa'
+import { TaskFn } from '../../src/contracts'
+
+/**
+ * Configure tests
+ */
+const task: TaskFn = async (_, logger, { absPath, debug }) => {
+  let spinner: ReturnType<typeof logger.await> | undefined
+  if (!debug) {
+    spinner = logger.await('Configuring tests')
+  }
+
+  try {
+    await execa('node', ['ace', 'configure', 'tests'], {
+      cwd: absPath,
+      ...(debug ? { stdio: 'inherit' } : {}),
+    })
+    spinner && spinner.stop()
+  } catch (error) {
+    spinner && spinner.stop()
+    throw error
+  }
+}
+
+export default task

tasks/ConfigureTests/index.ts

@@ -41,12 +41,12 @@ const task: TaskFn = async (_, logger, { pkg, client, boilerplate, debug }) => {
   /**
    * Required dev dependencies
    */
-  pkg.install('typescript', '~4.5')
+  pkg.install('typescript', '~4.6')
   pkg.install('youch')
   pkg.install('youch-terminal')
   pkg.install('pino-pretty')
   pkg.install('adonis-preset-ts')
-  pkg.install('@adonisjs/assembler', '^5.3.0')
+  pkg.install('@adonisjs/assembler')
 
   /**
    * Displaying a spinner, since install packages takes

tasks/InstallDependencies/index.ts

@@ -7,53 +7,38 @@
  * file that was distributed with this source code.
  */
 
-import { files } from '@adonisjs/sink'
 import { TaskFn } from '../../src/contracts'
 
 /**
  * Setup eslint inside the project
  */
-const task: TaskFn = (_, logger, { absPath, prettier, eslint, pkg }) => {
+const task: TaskFn = (_, __, { prettier, eslint, pkg }) => {
   if (!eslint) {
     return
   }
 
-  /**
-   * Create eslintRc file
-   */
-  const eslintRc = new files.JsonFile(absPath, '.eslintrc.json')
-
   /**
    * Setup config for prettier
    */
   if (prettier) {
-    eslintRc.set('extends', ['plugin:adonis/typescriptApp', 'prettier'])
-    eslintRc.set('plugins', ['prettier'])
-    eslintRc.set('rules', {
+    pkg.set('eslintConfig.extends', ['plugin:adonis/typescriptApp', 'prettier'])
+    pkg.set('eslintConfig.plugins', ['prettier'])
+    pkg.set('eslintConfig.rules', {
       'prettier/prettier': ['error'],
     })
+    pkg.set('eslintIgnore', ['build'])
   } else {
     // or setup without prettier
-    eslintRc.set('extends', ['plugin:adonis/typescriptApp'])
+    pkg.set('eslintConfig.extends', ['plugin:adonis/typescriptApp'])
+    pkg.set('eslintIgnore', ['build'])
   }
 
-  eslintRc.commit()
-
   /**
-   * Create eslintIgnore file
-   */
-  const eslintIgnore = new files.NewLineFile(absPath, '.eslintignore')
-  eslintIgnore.add('build')
-  eslintIgnore.commit()
-
-  /**
-   * Setup package.json file
+   * Install packages and configure lint script
    */
   pkg.install('eslint')
   pkg.install('eslint-plugin-adonis')
   pkg.setScript('lint', 'eslint . --ext=.ts')
-
-  logger.action('create').succeeded('.eslintrc.json, .eslintignore')
 }
 
 export default task

tasks/Scaffold/setupEslint.ts

@@ -21,33 +21,32 @@ const task: TaskFn = (_, logger, { absPath, prettier, eslint, pkg }) => {
   /**
    * Create prettierrc file
    */
-  const prettierRc = new files.JsonFile(absPath, '.prettierrc')
-  prettierRc.set('trailingComma', 'es5')
-  prettierRc.set('semi', false)
-  prettierRc.set('singleQuote', true)
-  prettierRc.set('useTabs', false)
-  prettierRc.set('quoteProps', 'consistent')
-  prettierRc.set('bracketSpacing', true)
-  prettierRc.set('arrowParens', 'always')
-  prettierRc.set('printWidth', 100)
-  prettierRc.commit()
+  pkg.set('prettier.trailingComma', 'es5')
+  pkg.set('prettier.semi', false)
+  pkg.set('prettier.singleQuote', true)
+  pkg.set('prettier.useTabs', false)
+  pkg.set('prettier.quoteProps', 'consistent')
+  pkg.set('prettier.bracketSpacing', true)
+  pkg.set('prettier.arrowParens', 'always')
+  pkg.set('prettier.printWidth', 100)
+  pkg.commit()
 
   /**
    * Create prettier ignore file
    */
   const prettierIgnore = new files.NewLineFile(absPath, '.prettierignore')
   prettierIgnore.add('build')
   prettierIgnore.commit()
+  logger.action('create').succeeded('.prettierignore')
 
   /**
-   * Setup package.json file
+   * Install prettier dependencies and register formatting
+   * script
    */
   pkg.install('prettier')
   pkg.install('eslint-config-prettier')
   pkg.install('eslint-plugin-prettier')
   pkg.setScript('format', 'prettier --write .')
-
-  logger.action('create').succeeded('.prettierrc, .prettierignore')
 }
 
 export default task

tasks/Scaffold/setupPrettier.ts

@@ -8,6 +8,7 @@
  */
 
 import formatSource from './FormatSource'
+import configureTests from './ConfigureTests'
 import setupEslint from './Scaffold/setupEslint'
 import generateManifest from './GenerateManifest'
 import createRcFile from './Scaffold/createRcFile'
@@ -44,7 +45,7 @@ export const tasks = function ({ encore }: CliState) {
     },
     {
       title: 'Configure installed packages',
-      actions: [configurePackages, generateManifest, formatSource],
+      actions: [configurePackages, configureTests, generateManifest, formatSource],
     },
     ...(encore
       ? [

tasks/index.ts

@@ -20,5 +20,5 @@ export default Env.rules({
 	APP_KEY: Env.schema.string(),
 	APP_NAME: Env.schema.string(),
   DRIVE_DISK: Env.schema.enum(['local'] as const),
-	NODE_ENV: Env.schema.enum(['development', 'production', 'testing'] as const),
+	NODE_ENV: Env.schema.enum(['development', 'production', 'test'] as const),
 })

templates/api/env.txt

@@ -20,5 +20,5 @@ export default Env.rules({
 	APP_KEY: Env.schema.string(),
 	APP_NAME: Env.schema.string(),
   DRIVE_DISK: Env.schema.enum(['local'] as const),
-	NODE_ENV: Env.schema.enum(['development', 'production', 'testing'] as const),
+	NODE_ENV: Env.schema.enum(['development', 'production', 'test'] as const),
 })

templates/slim/env.txt

@@ -22,5 +22,5 @@ export default Env.rules({
 	CACHE_VIEWS: Env.schema.boolean(),
 	SESSION_DRIVER: Env.schema.string(),
   DRIVE_DISK: Env.schema.enum(['local'] as const),
-	NODE_ENV: Env.schema.enum(['development', 'production', 'testing'] as const),
+	NODE_ENV: Env.schema.enum(['development', 'production', 'test'] as const),
 })