Merge pull request #325 from ottofeller/husky-hooks-file-structure

PLA-245 Change file structure for husky hooks

src/common/git/husky/add-husky.ts

@@ -1,7 +1,7 @@
 import type {NodeProject} from 'projen/lib/javascript'
+import {WithGitHooks} from '../with-git-hooks'
 import {checkCargo} from './check-cargo'
 import {commitMessage} from './commit-message'
-import {WithGitHooks} from './with-git-hooks'
 
 export const addHusky = (project: NodeProject, options: WithGitHooks): void => {
   project.addDevDeps('husky')

src/common/git/husky/check-cargo-options.ts

@@ -0,0 +1,15 @@
+export interface CheckCargoOptions {
+  /**
+   * Perform a code formatting step
+   *
+   * @default true
+   */
+  readonly isFormatting?: boolean
+
+  /**
+   * Path to the cargo
+   *
+   * @default '.'
+   */
+  readonly workingDirectory?: string
+}

src/common/git/husky/check-cargo.ts

@@ -1,8 +1,8 @@
 import * as path from 'path'
 import type {NodeProject} from 'projen/lib/javascript'
 import {AssetFile} from '../../files/AssetFile'
+import type {CheckCargoOptions} from './check-cargo-options'
 import {destinationFolder, sourceFolder, templateFile, templateString} from './template-path'
-import type {CheckCargoOptions} from './with-git-hooks'
 
 export const checkCargo = (project: NodeProject, options: CheckCargoOptions) => {
   const commands: Array<string> = ['cargo check']

src/common/git/husky/husky-rule.ts

@@ -0,0 +1,17 @@
+import type {CheckCargoOptions} from './check-cargo-options'
+
+export interface HuskyRule {
+  /**
+   * Include pre-commit hook with `cargo check` command.
+   *
+   * @default undefined
+   */
+  readonly checkCargo?: CheckCargoOptions
+
+  /**
+   * Include commit message hook.
+   *
+   * @default true
+   */
+  readonly commitMsg?: boolean
+}

src/common/git/husky/index.ts

@@ -1,2 +1,3 @@
 export * from './add-husky'
-export * from './with-git-hooks'
+export * from './check-cargo-options'
+export * from './husky-rule'

src/common/git/index.ts

@@ -1,2 +1,3 @@
 export * from './gitignore'
 export * from './husky'
+export * from './with-git-hooks'

src/common/git/with-git-hooks.ts

@@ -0,0 +1,17 @@
+import type {HuskyRule} from './husky'
+
+export interface WithGitHooks {
+  /**
+   * Include husky for git hook management.
+   *
+   * @default false
+   */
+  readonly hasGitHooks?: boolean
+
+  /**
+   * Include a default git hook that checks commit message.
+   *
+   * @default { commitMsg: true }
+   */
+  readonly huskyRules?: HuskyRule
+}