Class Linter

Linter

Hierarchy

Linter

Index

Constructors

Methods

get_linter lint_from_code lint_from_file lint_from_project parse_output

Constructors

constructor

new Linter(): Linter
Returns Linter

Methods

`Private` get_linter

get_linter(linter_name: t_linter_name): Ghdl | Icarus | Verilator | Vivado | Modelsim | Verible | Vsg
Parameters
- linter_name: t_linter_name
Returns Ghdl | Icarus | Verilator | Vivado | Modelsim | Verible | Vsg
- Defined in linter/linter.ts:34

lint_from_code

lint_from_code(linter_name: t_linter_name, code: string, options: l_options): Promise<l_error[]>
Lint a file from the code
Parameters
- linter_name: t_linter_name
- code: string
  
  Code to lint
- options: l_options
  
  Linter options
Returns Promise<l_error[]>
- Defined in linter/linter.ts:90

lint_from_file

lint_from_file(linter_name: t_linter_name, file: string, options: l_options): Promise<l_error[]>
Lint a file from path
Parameters
- linter_name: t_linter_name
- file: string
  
  File path to lint
- options: l_options
  
  Linter options
Returns Promise<l_error[]>
- Defined in linter/linter.ts:79

lint_from_project

lint_from_project(file_path: string, prj_file_list: t_file[], linter_name: t_linter_name, options: l_options): Promise<l_error[]>
Parameters
- file_path: string
- prj_file_list: t_file[]
- linter_name: t_linter_name
- options: l_options
Returns Promise<l_error[]>
- Defined in linter/linter.ts:96

parse_output

parse_output(linter_name: t_linter_name, output: string, file: string): l_error[]
Parameters
- linter_name: t_linter_name
- output: string
- file: string
Returns l_error[]
- Defined in linter/linter.ts:68

Generated using TypeDoc