@the-/lint

Lint of the-frameworks

Installation

$ npm install @the-/lint --save

Usage

'use strict'

const { TheLint, rules } = require('@the-/lint')

async function tryExample() {
  const lint = new TheLint()

  // Use Buildin rules
  lint.add(
    'src/controllers/*Ctrl.js',
    rules.defaultExportRule({
      type: 'function',
    }),
  )

  // Use Custom rules
  lint.add('src/controllers/*Ctrl.js', ({ content, report }) => {
    const { EOL } = require('os')

    if (!content.endsWith(EOL)) {
      report('Should have end with EOL', {
        actual: JSON.stringify(content[content.length - 1]),
        expect: JSON.stringify(EOL),
      })
    }
  })

  await lint.run()
}

tryExample().catch((err) => console.error(err))

API Guide

• module:@the-/lint
  • .create(args)
  • .default()
  • .helpers
  • .rules
  • .TheLint
• module:@the-/lint.helpers
  • .LintCache
• module:@the-/lint.rules
  • .callRule(config,keypathArguments)
  • .contentRule(config)
  • .depsRule(config)
  • .filenameRule(config)
  • .moduleRule(config)
  • .packageRule(config)
  • .propRule(config)
  • .usageRule(config)
• TheLint
  • #add(pattern,checker)
  • #run()

See API Guide for more detail

License

This software is released under the MIT License.

Links

• THE Labo