feat: add make:validator command

Author: thetutlage

commands/Make/Validator.ts

@@ -0,0 +1,61 @@
+/*
+ * @adonisjs/assembler
+ *
+ * (c) Harminder Virk <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
+import { join } from 'path'
+import { args } from '@adonisjs/ace'
+import { RcFile } from '@ioc:Adonis/Core/Application'
+import { BaseGenerator } from './Base'
+
+/**
+ * Command to make a new validator
+ */
+export default class MakeValidator extends BaseGenerator {
+  /**
+   * Required by BaseGenerator
+   */
+  protected $suffix = ''
+  protected $form = 'singular' as const
+  protected $pattern = 'pascalcase' as const
+  protected $resourceName: string
+
+  /**
+   * Command meta data
+   */
+  public static commandName = 'make:validator'
+  public static description = 'Make a new validator'
+
+  @args.string({ description: 'Name of the validator' })
+  public name: string
+
+  /**
+   * Returns the template stub path
+   */
+  protected $getStub (): string {
+    return join(
+      __dirname,
+      '..',
+      '..',
+      'templates',
+      'validator.txt',
+    )
+  }
+
+  /**
+   * Pull path for the `validators` directory declaration from
+   * the `.adonisrc.json` file or fallback to `app/Validators`
+   */
+  protected $getDestinationPath (rcContents: RcFile): string {
+    return this.$getPathForNamespace(rcContents, 'validators') || 'app/Validators'
+  }
+
+  public async handle () {
+    this.$resourceName = this.name
+    await super.generate()
+  }
+}

index.ts

@@ -16,6 +16,7 @@ new Manifest(__dirname).generate([
   './commands/Make/Controller',
   './commands/Make/Middleware',
   './commands/Make/Provider',
+  './commands/Make/Validator',
   './commands/Make/View',
   './commands/Make/Model',
 ])

templates/validator.txt

@@ -0,0 +1,40 @@
+import { schema, validator } from '@ioc:Adonis/Core/Validator'
+
+class ${filename}Validator {
+  /**
+   * Using a pre-compiled schema you can validate the "shape", "type",
+   * "formatting" and "integrity" of data.
+   *
+   * For example:
+   * 1. The username must be of data type string. But then also, it should
+   *    not contain special characters or numbers.
+   *    ```
+   *     schema.string([ rules.alpha() ])
+   *    ```
+   *
+   * 2. The email must be of data type string, formatted as a valid
+   *    email. But also, not used by any other user.
+   *    ```
+   *     schema.string([
+   *       rules.email(),
+   *       rules.unique({ inTable: 'users', column: 'email' }),
+   *     ])
+   *    ```
+   */
+  public schema = validator.compile(schema.create({
+  }))
+
+  /**
+   * Custom messages for validation failures. You can make use of dot notation `(.)`
+   * for targeting nested fields and array expressions `(*)` for targeting all
+   * children of an array. For example:
+   *
+   * {
+   *   'profile.username.required': 'Username is required',
+   *   'scores.*.number': 'Define scores as valid numbers'
+   * }
+  */
+  public messages = {}
+}
+
+export default new ${filename}Validator()