feat(lint): implement v1 with 3 rules - trailing spaces, encoded passwords and Doxygen header

src/types/Diagnostic.ts

@@ -0,0 +1,5 @@
+export interface Diagnostic {
+  lineNumber: number
+  columnNumber: number
+  warning: string
+}

src/types/LintConfig.spec.ts

@@ -0,0 +1,61 @@
+import { LintConfig } from './LintConfig'
+import { LintRuleType } from './LintRuleType'
+
+describe('LintConfig', () => {
+  it('should create an empty instance', () => {
+    const config = new LintConfig()
+
+    expect(config).toBeTruthy()
+    expect(config.fileLintRules.length).toEqual(0)
+    expect(config.lineLintRules.length).toEqual(0)
+  })
+
+  it('should create an instance with the noTrailingSpaces flag set', () => {
+    const config = new LintConfig({ noTrailingSpaces: true })
+
+    expect(config).toBeTruthy()
+    expect(config.lineLintRules.length).toEqual(1)
+    expect(config.lineLintRules[0].name).toEqual('noTrailingSpaces')
+    expect(config.lineLintRules[0].type).toEqual(LintRuleType.Line)
+    expect(config.fileLintRules.length).toEqual(0)
+  })
+
+  it('should create an instance with the noEncodedPasswords flag set', () => {
+    const config = new LintConfig({ noEncodedPasswords: true })
+
+    expect(config).toBeTruthy()
+    expect(config.lineLintRules.length).toEqual(1)
+    expect(config.lineLintRules[0].name).toEqual('noEncodedPasswords')
+    expect(config.lineLintRules[0].type).toEqual(LintRuleType.Line)
+    expect(config.fileLintRules.length).toEqual(0)
+  })
+
+  it('should create an instance with the hasDoxygenHeader flag set', () => {
+    const config = new LintConfig({ hasDoxygenHeader: true })
+
+    expect(config).toBeTruthy()
+    expect(config.lineLintRules.length).toEqual(0)
+    expect(config.fileLintRules.length).toEqual(1)
+    expect(config.fileLintRules[0].name).toEqual('hasDoxygenHeader')
+    expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
+  })
+
+  it('should create an instance with all flags set', () => {
+    const config = new LintConfig({
+      noTrailingSpaces: true,
+      noEncodedPasswords: true,
+      hasDoxygenHeader: true
+    })
+
+    expect(config).toBeTruthy()
+    expect(config.lineLintRules.length).toEqual(2)
+    expect(config.lineLintRules[0].name).toEqual('noTrailingSpaces')
+    expect(config.lineLintRules[0].type).toEqual(LintRuleType.Line)
+    expect(config.lineLintRules[1].name).toEqual('noEncodedPasswords')
+    expect(config.lineLintRules[1].type).toEqual(LintRuleType.Line)
+
+    expect(config.fileLintRules.length).toEqual(1)
+    expect(config.fileLintRules[0].name).toEqual('hasDoxygenHeader')
+    expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
+  })
+})

src/types/LintConfig.ts

@@ -0,0 +1,23 @@
+import { hasDoxygenHeader } from '../rules/hasDoxygenHeader'
+import { noEncodedPasswords } from '../rules/noEncodedPasswords'
+import { noTrailingSpaces } from '../rules/noTrailingSpaces'
+import { FileLintRule, LineLintRule } from './LintRule'
+
+export class LintConfig {
+  readonly lineLintRules: LineLintRule[] = []
+  readonly fileLintRules: FileLintRule[] = []
+
+  constructor(json?: any) {
+    if (json?.noTrailingSpaces) {
+      this.lineLintRules.push(noTrailingSpaces)
+    }
+
+    if (json?.noEncodedPasswords) {
+      this.lineLintRules.push(noEncodedPasswords)
+    }
+
+    if (json?.hasDoxygenHeader) {
+      this.fileLintRules.push(hasDoxygenHeader)
+    }
+  }
+}

src/types/LintRule.ts

@@ -0,0 +1,19 @@
+import { Diagnostic } from './Diagnostic'
+import { LintRuleType } from './LintRuleType'
+
+export interface LintRule {
+  type: LintRuleType
+  name: string
+  description: string
+  warning: string
+  test: (value: string, lineNumber: number) => Diagnostic[]
+}
+
+export interface LineLintRule extends LintRule {
+  type: LintRuleType.Line
+}
+
+export interface FileLintRule extends LintRule {
+  type: LintRuleType.File
+  test: (value: string) => Diagnostic[]
+}

src/types/LintRuleType.ts

@@ -0,0 +1,4 @@
+export enum LintRuleType {
+  Line,
+  File
+}