refactor: handle inconsistencies across the entire codebase

Author: thetutlage

index.ts

@@ -34,9 +34,11 @@ export async function runTasks (args: string[]) {
 
   let state: CliState = {
     boilerplate: argv.boilerplate || 'web',
-    db: !!argv.db,
   }
 
+  // tslint:disable-next-line: max-line-length quotemark
+  console.log("    _       _             _         _     \n   / \\   __| | ___  _ __ (_)___    | |___ \n  / _ \\ / _` |/ _ \\| '_ \\| / __|_  | / __|\n / ___ \\ (_| | (_) | | | | \\__ \\ |_| \\__ \\\n/_/   \\_\\__,_|\\___/|_| |_|_|___/\\___/|___/\n")
+
   const projectRoot = argv._[0].trim()
 
   /**

package.json

@@ -12,13 +12,12 @@
     "build/index.js"
   ],
   "scripts": {
-    "postinstall": "node build/bin/run.js",
     "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
     "test": "node japaFile.js",
     "lint": "tslint --project tsconfig.json",
     "clean": "del build",
-    "compile": "npm run lint && npm run clean && tsc && copyfiles \"templates/**/*.txt\" build",
+    "compile": "npm run lint && npm run clean && tsc && copyfiles \"templates/**/*.txt\" \"templates/**/*.edge\" build",
     "build": "npm run compile",
     "commit": "git-cz",
     "release": "np",
@@ -69,7 +68,9 @@
     "@adonisjs/sink": "^2.3.1",
     "@poppinss/application": "^1.0.10",
     "cli-width": "^2.2.0",
+    "dedent": "^0.7.0",
     "fs-extra": "^8.1.0",
+    "fs-readdir-recursive": "^1.1.0",
     "getopts": "^2.2.5",
     "ora": "^4.0.2",
     "randomstring": "^1.1.5"

src/contracts.ts

@@ -23,5 +23,4 @@ export type TaskFn = (
  */
 export type CliState = {
   boilerplate: 'web' | 'api',
-  db: boolean,
 }

src/boilerplate/packages.ts src/schematics/packages.tssrc/boilerplate/packages.ts renamed to src/schematics/packages.ts

@@ -11,43 +11,41 @@ import { CliState } from '../contracts'
 
 export const packages: {
   [K in CliState['boilerplate']]: {
-    [pkg: string]: { version: string, providers: string[] },
+    [pkg: string]: { version: string },
   }
 } = {
   web: {
     '@adonisjs/core': {
       version: 'latest',
-      providers: ['@adonisjs/core'],
     },
     '@adonisjs/fold': {
       version: '6',
-      providers: [],
+    },
+    '@adonisjs/ace': {
+      version: '6',
     },
     '@adonisjs/bodyparser': {
       version: '3',
-      providers: ['@adonisjs/bodyparser'],
     },
     '@adonisjs/session': {
       version: '2',
-      providers: ['@adonisjs/session'],
     },
     '@adonisjs/view': {
       version: 'latest',
-      providers: ['@adonisjs/view'],
     },
   },
   api: {
     '@adonisjs/core': {
       version: 'latest',
-      providers: ['@adonisjs/core'],
+    },
+    '@adonisjs/ace': {
+      version: '6',
     },
     '@adonisjs/fold': {
       version: '6',
-      providers: [],
     },
     '@adonisjs/bodyparser': {
       version: '3',
-      providers: ['@adonisjs/bodyparser'],
     },
   },
 }

src/schematics/rcMetaFiles.ts

@@ -0,0 +1,27 @@
+/*
+ * 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 { CliState } from '../contracts'
+
+export const metaFiles: {
+  [K in CliState['boilerplate']]: string[]
+} = {
+  web: [
+    '.env',
+    '.adonisrc.json',
+    '.gitignore',
+    'resources/views/**/*.edge',
+    'public/**',
+  ],
+  api: [
+    '.env',
+    '.adonisrc.json',
+    '.gitignore',
+  ],
+}

tasks/copyTemplates.ts

@@ -8,65 +8,24 @@
 */
 
 import { join } from 'path'
+import readDir from 'fs-readdir-recursive'
 import { TemplateFile, logger } from '@adonisjs/sink'
 
 import { TaskFn } from '../src/contracts'
-import { packages } from '../src/boilerplate/packages'
-
-const templates = [
-  'server.txt',
-  'start/app.txt',
-  'start/kernel.txt',
-  'start/routes.txt',
-  'app/Exceptions/Handler.txt',
-  'providers/AppProvider.txt',
-]
 
 /**
  * Copies templates to project directory
  */
 const task: TaskFn = (absPath, _app, state) => {
-  const boilerPlatePackages = packages[state.boilerplate]
-  if (state.boilerplate === 'api') {
-    templates.push('app/Middleware/SpoofAccept.ts')
-  }
-
-  templates.forEach((template) => {
-    let data: any = {}
-
-    /**
-     * Defining providers for the `start/app` file
-     */
-    if (template === 'start/app.txt') {
-      data.providers = []
-      Object.keys(boilerPlatePackages).forEach((name) => {
-        if (boilerPlatePackages[name].providers.length) {
-          data.providers = data.providers.concat(`'${boilerPlatePackages[name].providers}',`)
-        }
-      })
-
-      data.providers.push(`'./providers/AppProvider',`)
-    }
-
-    /**
-     * Middleware based upon the type of project
-     */
-    if (template === 'start/kernel.txt') {
-      data.middleware = state.boilerplate === 'api'
-        ? [`'App/Middleware/SpoofAccept',`, `'Adonis/Addons/BodyParserMiddleware',`]
-        : [`'Adonis/Addons/BodyParserMiddleware',`]
-    }
-
-    new TemplateFile(
-      absPath,
-      template.replace(/\.txt$/, '.ts'),
-      join(__dirname, '..', 'templates', template),
-    )
-      .apply(data)
-      .commit()
-
-    logger.create(template)
-  })
+  const files = readDir(join(__dirname, '..', 'templates', state.boilerplate))
+
+  files
+    .forEach((name: string) => {
+      const outputFileName = name.replace(/\.txt$/, '.ts')
+      const src = join(__dirname, '..', 'templates', state.boilerplate, name)
+      new TemplateFile(absPath, outputFileName, src).apply({}).commit()
+      logger.create(outputFileName)
+    })
 }
 
 export default task

tasks/createGitIgnore.ts

@@ -22,6 +22,7 @@ const task: TaskFn = (absPath) => {
   gitignore.add('coverage')
   gitignore.add('.vscode')
   gitignore.add('.DS_STORE')
+  gitignore.add('.env')
 
   gitignore.commit()
   logger.create('.gitignore')

tasks/createPackageFile.ts

@@ -13,7 +13,7 @@ import { PackageFile, logger } from '@adonisjs/sink'
 
 import { TaskFn } from '../src/contracts'
 import { logInstall } from '../src/spinner'
-import { packages } from '../src/boilerplate/packages'
+import { packages } from '../src/schematics/packages'
 
 /**
  * Creates the `package.json` file in the project root and installs
@@ -26,14 +26,13 @@ const task: TaskFn = async (absPath, _app, state) => {
   pkg.set('version', '0.0.0')
   pkg.set('private', true)
 
-  pkg.setScript('build', 'adonis build')
-  pkg.setScript('start', 'adonis serve --dev')
-
-  const useYarn = process.env.npm_execpath && process.env.npm_execpath.includes('yarn')
+  pkg.setScript('build', 'node ace build')
+  pkg.setScript('start', 'node ace serve --watch')
 
   /**
-   * Use yarn when executed as `yarn create`
+   * Set by `yarn create`
    */
+  const useYarn = process.env.npm_execpath && process.env.npm_execpath.includes('yarn')
   if (useYarn) {
     pkg.yarn(true)
   }

tasks/createRcFile.ts

@@ -9,31 +9,26 @@
 
 import { RcFile, logger } from '@adonisjs/sink'
 import { TaskFn } from '../src/contracts'
+import { metaFiles } from '../src/schematics/rcMetaFiles'
 
 /**
  * Creates the `.adonisrc.json` file in the project root
  */
 const task: TaskFn = (absPath, _app, state) => {
   const rcFile = new RcFile(absPath)
 
+  rcFile.set('typescript', true)
+  rcFile.set('commands', {})
   rcFile.setExceptionHandler('App/Exceptions/Handler')
   rcFile.setAutoload('App', 'app')
   rcFile.setAutoload('Contracts', 'contracts')
 
   rcFile.setPreload('start/routes')
   rcFile.setPreload('start/kernel')
 
-  rcFile.addMetaFile('.env')
-  rcFile.addMetaFile('.adonisrc.json')
-  rcFile.addMetaFile('.gitignore')
-
-  /**
-   * Extra files for the web boilerplate
-   */
-  if (state.boilerplate === 'web') {
-    rcFile.addMetaFile('resources/views/**/*.edge')
-    rcFile.addMetaFile('public/**')
-  }
+  metaFiles[state.boilerplate].forEach((file) => {
+    rcFile.addMetaFile(file)
+  })
 
   rcFile.commit()
   logger.create('.adonisrc.json')

tasks/createTsConfig.ts

@@ -20,6 +20,7 @@ const task: TaskFn = (absPath) => {
   tsconfig.set('exclude', ['node_modules', 'build'])
   tsconfig.set('extends', './node_modules/adonis-preset-ts/tsconfig')
   tsconfig.set('compilerOptions', {
+    outDir: 'build',
     paths: {
       'App/*': ['./app/*'],
       'Contracts/*': ['./contracts/*'],