mirror of
https://github.com/denoland/deno.git
synced 2024-10-29 08:58:01 -04:00
d93570a619
This commit adds support for following flags in deno lint subcommand: --config - allows to load configuration file and parses "lint" object --rules-tags=<tags> - allows specifying which set of tagged rules should be run --rules-include=<rules> - allow specifying which rules should be run --rules-exclude=<rules> - allow specifying which rules should not be run
523 lines
14 KiB
Rust
523 lines
14 KiB
Rust
// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
|
|
|
|
//! This module provides file formatting utilities using
|
|
//! [`deno_lint`](https://github.com/denoland/deno_lint).
|
|
//!
|
|
//! At the moment it is only consumed using CLI but in
|
|
//! the future it can be easily extended to provide
|
|
//! the same functions as ops available in JS runtime.
|
|
use crate::ast;
|
|
use crate::colors;
|
|
use crate::config_file::LintConfig;
|
|
use crate::fmt_errors;
|
|
use crate::fs_util::{collect_files, is_supported_ext};
|
|
use crate::media_type::MediaType;
|
|
use crate::tools::fmt::run_parallelized;
|
|
use deno_core::error::{anyhow, generic_error, AnyError, JsStackFrame};
|
|
use deno_core::serde_json;
|
|
use deno_lint::diagnostic::LintDiagnostic;
|
|
use deno_lint::linter::Linter;
|
|
use deno_lint::linter::LinterBuilder;
|
|
use deno_lint::rules;
|
|
use deno_lint::rules::LintRule;
|
|
use log::debug;
|
|
use log::info;
|
|
use serde::Serialize;
|
|
use std::fs;
|
|
use std::io::{stdin, Read};
|
|
use std::path::PathBuf;
|
|
use std::sync::atomic::{AtomicBool, Ordering};
|
|
use std::sync::{Arc, Mutex};
|
|
use swc_ecmascript::parser::Syntax;
|
|
|
|
pub enum LintReporterKind {
|
|
Pretty,
|
|
Json,
|
|
}
|
|
|
|
fn create_reporter(kind: LintReporterKind) -> Box<dyn LintReporter + Send> {
|
|
match kind {
|
|
LintReporterKind::Pretty => Box::new(PrettyLintReporter::new()),
|
|
LintReporterKind::Json => Box::new(JsonLintReporter::new()),
|
|
}
|
|
}
|
|
|
|
pub async fn lint_files(
|
|
maybe_lint_config: Option<LintConfig>,
|
|
rules_tags: Vec<String>,
|
|
rules_include: Vec<String>,
|
|
rules_exclude: Vec<String>,
|
|
args: Vec<PathBuf>,
|
|
ignore: Vec<PathBuf>,
|
|
json: bool,
|
|
) -> Result<(), AnyError> {
|
|
if args.len() == 1 && args[0].to_string_lossy() == "-" {
|
|
return lint_stdin(
|
|
json,
|
|
maybe_lint_config.as_ref(),
|
|
rules_tags,
|
|
rules_include,
|
|
rules_exclude,
|
|
);
|
|
}
|
|
|
|
// Collect included and ignored files. CLI flags take precendence
|
|
// over config file, ie. if there's `files.ignore` in config file
|
|
// and `--ignore` CLI flag, only the flag value is taken into account.
|
|
let mut include_files = args;
|
|
let mut exclude_files = ignore;
|
|
|
|
if let Some(lint_config) = maybe_lint_config.as_ref() {
|
|
if include_files.is_empty() {
|
|
include_files = lint_config
|
|
.files
|
|
.include
|
|
.iter()
|
|
.map(PathBuf::from)
|
|
.collect::<Vec<PathBuf>>();
|
|
}
|
|
|
|
if exclude_files.is_empty() {
|
|
exclude_files = lint_config
|
|
.files
|
|
.exclude
|
|
.iter()
|
|
.map(PathBuf::from)
|
|
.collect::<Vec<PathBuf>>();
|
|
}
|
|
}
|
|
|
|
let target_files =
|
|
collect_files(&include_files, &exclude_files, is_supported_ext).and_then(
|
|
|files| {
|
|
if files.is_empty() {
|
|
Err(generic_error("No target files found."))
|
|
} else {
|
|
Ok(files)
|
|
}
|
|
},
|
|
)?;
|
|
debug!("Found {} files", target_files.len());
|
|
let target_files_len = target_files.len();
|
|
|
|
let has_error = Arc::new(AtomicBool::new(false));
|
|
|
|
let reporter_kind = if json {
|
|
LintReporterKind::Json
|
|
} else {
|
|
LintReporterKind::Pretty
|
|
};
|
|
let reporter_lock = Arc::new(Mutex::new(create_reporter(reporter_kind)));
|
|
|
|
// Try to get configured rules. CLI flags take precendence
|
|
// over config file, ie. if there's `rules.include` in config file
|
|
// and `--rules-include` CLI flag, only the flag value is taken into account.
|
|
// TODO(bartlomieju): this is done multiple times for each file because
|
|
// Vec<Box<dyn LintRule>> is not clonable, this should be optimized.
|
|
get_configured_rules(
|
|
maybe_lint_config.as_ref(),
|
|
rules_tags.clone(),
|
|
rules_include.clone(),
|
|
rules_exclude.clone(),
|
|
)?;
|
|
|
|
run_parallelized(target_files, {
|
|
let reporter_lock = reporter_lock.clone();
|
|
let has_error = has_error.clone();
|
|
move |file_path| {
|
|
let r = lint_file(
|
|
file_path.clone(),
|
|
maybe_lint_config.as_ref(),
|
|
rules_tags.clone(),
|
|
rules_include.clone(),
|
|
rules_exclude.clone(),
|
|
);
|
|
let mut reporter = reporter_lock.lock().unwrap();
|
|
|
|
match r {
|
|
Ok((mut file_diagnostics, source)) => {
|
|
sort_diagnostics(&mut file_diagnostics);
|
|
for d in file_diagnostics.iter() {
|
|
has_error.store(true, Ordering::Relaxed);
|
|
reporter.visit_diagnostic(d, source.split('\n').collect());
|
|
}
|
|
}
|
|
Err(err) => {
|
|
has_error.store(true, Ordering::Relaxed);
|
|
reporter.visit_error(&file_path.to_string_lossy().to_string(), &err);
|
|
}
|
|
}
|
|
Ok(())
|
|
}
|
|
})
|
|
.await?;
|
|
|
|
let has_error = has_error.load(Ordering::Relaxed);
|
|
|
|
reporter_lock.lock().unwrap().close(target_files_len);
|
|
|
|
if has_error {
|
|
std::process::exit(1);
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
fn rule_to_json(rule: Box<dyn LintRule>) -> serde_json::Value {
|
|
serde_json::json!({
|
|
"code": rule.code(),
|
|
"tags": rule.tags(),
|
|
"docs": rule.docs(),
|
|
})
|
|
}
|
|
|
|
pub fn print_rules_list(json: bool) {
|
|
let lint_rules = rules::get_recommended_rules();
|
|
|
|
if json {
|
|
let json_rules: Vec<serde_json::Value> =
|
|
lint_rules.into_iter().map(rule_to_json).collect();
|
|
let json_str = serde_json::to_string_pretty(&json_rules).unwrap();
|
|
println!("{}", json_str);
|
|
} else {
|
|
// The rules should still be printed even if `--quiet` option is enabled,
|
|
// so use `println!` here instead of `info!`.
|
|
println!("Available rules:");
|
|
for rule in lint_rules {
|
|
println!(" - {}", rule.code());
|
|
println!(" help: https://lint.deno.land/#{}", rule.code());
|
|
println!();
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn create_linter(syntax: Syntax, rules: Vec<Box<dyn LintRule>>) -> Linter {
|
|
LinterBuilder::default()
|
|
.ignore_file_directive("deno-lint-ignore-file")
|
|
.ignore_diagnostic_directive("deno-lint-ignore")
|
|
.syntax(syntax)
|
|
.rules(rules)
|
|
.build()
|
|
}
|
|
|
|
fn lint_file(
|
|
file_path: PathBuf,
|
|
maybe_lint_config: Option<&LintConfig>,
|
|
rules_tags: Vec<String>,
|
|
rules_include: Vec<String>,
|
|
rules_exclude: Vec<String>,
|
|
) -> Result<(Vec<LintDiagnostic>, String), AnyError> {
|
|
let file_name = file_path.to_string_lossy().to_string();
|
|
let source_code = fs::read_to_string(&file_path)?;
|
|
let media_type = MediaType::from(&file_path);
|
|
let syntax = ast::get_syntax(&media_type);
|
|
|
|
// Obtaining rules from config is infallible at this point.
|
|
let lint_rules = get_configured_rules(
|
|
maybe_lint_config,
|
|
rules_tags,
|
|
rules_include,
|
|
rules_exclude,
|
|
)
|
|
.unwrap();
|
|
let linter = create_linter(syntax, lint_rules);
|
|
|
|
let (_, file_diagnostics) = linter.lint(file_name, source_code.clone())?;
|
|
|
|
Ok((file_diagnostics, source_code))
|
|
}
|
|
|
|
/// Lint stdin and write result to stdout.
|
|
/// Treats input as TypeScript.
|
|
/// Compatible with `--json` flag.
|
|
fn lint_stdin(
|
|
json: bool,
|
|
maybe_lint_config: Option<&LintConfig>,
|
|
rules_tags: Vec<String>,
|
|
rules_include: Vec<String>,
|
|
rules_exclude: Vec<String>,
|
|
) -> Result<(), AnyError> {
|
|
let mut source = String::new();
|
|
if stdin().read_to_string(&mut source).is_err() {
|
|
return Err(generic_error("Failed to read from stdin"));
|
|
}
|
|
|
|
let reporter_kind = if json {
|
|
LintReporterKind::Json
|
|
} else {
|
|
LintReporterKind::Pretty
|
|
};
|
|
let mut reporter = create_reporter(reporter_kind);
|
|
let lint_rules = get_configured_rules(
|
|
maybe_lint_config,
|
|
rules_tags,
|
|
rules_include,
|
|
rules_exclude,
|
|
)?;
|
|
let syntax = ast::get_syntax(&MediaType::TypeScript);
|
|
let linter = create_linter(syntax, lint_rules);
|
|
let mut has_error = false;
|
|
let pseudo_file_name = "_stdin.ts";
|
|
match linter
|
|
.lint(pseudo_file_name.to_string(), source.clone())
|
|
.map_err(|e| e.into())
|
|
{
|
|
Ok((_, diagnostics)) => {
|
|
for d in diagnostics {
|
|
has_error = true;
|
|
reporter.visit_diagnostic(&d, source.split('\n').collect());
|
|
}
|
|
}
|
|
Err(err) => {
|
|
has_error = true;
|
|
reporter.visit_error(pseudo_file_name, &err);
|
|
}
|
|
}
|
|
|
|
reporter.close(1);
|
|
|
|
if has_error {
|
|
std::process::exit(1);
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
trait LintReporter {
|
|
fn visit_diagnostic(&mut self, d: &LintDiagnostic, source_lines: Vec<&str>);
|
|
fn visit_error(&mut self, file_path: &str, err: &AnyError);
|
|
fn close(&mut self, check_count: usize);
|
|
}
|
|
|
|
#[derive(Serialize)]
|
|
struct LintError {
|
|
file_path: String,
|
|
message: String,
|
|
}
|
|
|
|
struct PrettyLintReporter {
|
|
lint_count: u32,
|
|
}
|
|
|
|
impl PrettyLintReporter {
|
|
fn new() -> PrettyLintReporter {
|
|
PrettyLintReporter { lint_count: 0 }
|
|
}
|
|
}
|
|
|
|
impl LintReporter for PrettyLintReporter {
|
|
fn visit_diagnostic(&mut self, d: &LintDiagnostic, source_lines: Vec<&str>) {
|
|
self.lint_count += 1;
|
|
|
|
let pretty_message = format!("({}) {}", colors::red(&d.code), &d.message);
|
|
|
|
let message = format_diagnostic(
|
|
&d.code,
|
|
&pretty_message,
|
|
&source_lines,
|
|
d.range.clone(),
|
|
d.hint.as_ref(),
|
|
&fmt_errors::format_location(&JsStackFrame::from_location(
|
|
Some(d.filename.clone()),
|
|
Some(d.range.start.line_index as i64 + 1), // 1-indexed
|
|
// todo(#11111): make 1-indexed as well
|
|
Some(d.range.start.column_index as i64),
|
|
)),
|
|
);
|
|
|
|
eprintln!("{}\n", message);
|
|
}
|
|
|
|
fn visit_error(&mut self, file_path: &str, err: &AnyError) {
|
|
eprintln!("Error linting: {}", file_path);
|
|
eprintln!(" {}", err);
|
|
}
|
|
|
|
fn close(&mut self, check_count: usize) {
|
|
match self.lint_count {
|
|
1 => info!("Found 1 problem"),
|
|
n if n > 1 => info!("Found {} problems", self.lint_count),
|
|
_ => (),
|
|
}
|
|
|
|
match check_count {
|
|
n if n <= 1 => info!("Checked {} file", n),
|
|
n if n > 1 => info!("Checked {} files", n),
|
|
_ => unreachable!(),
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn format_diagnostic(
|
|
diagnostic_code: &str,
|
|
message_line: &str,
|
|
source_lines: &[&str],
|
|
range: deno_lint::diagnostic::Range,
|
|
maybe_hint: Option<&String>,
|
|
formatted_location: &str,
|
|
) -> String {
|
|
let mut lines = vec![];
|
|
|
|
for (i, line) in source_lines
|
|
.iter()
|
|
.enumerate()
|
|
.take(range.end.line_index + 1)
|
|
.skip(range.start.line_index)
|
|
{
|
|
lines.push(line.to_string());
|
|
if range.start.line_index == range.end.line_index {
|
|
lines.push(format!(
|
|
"{}{}",
|
|
" ".repeat(range.start.column_index),
|
|
colors::red(
|
|
&"^".repeat(range.end.column_index - range.start.column_index)
|
|
)
|
|
));
|
|
} else {
|
|
let line_len = line.len();
|
|
if range.start.line_index == i {
|
|
lines.push(format!(
|
|
"{}{}",
|
|
" ".repeat(range.start.column_index),
|
|
colors::red(&"^".repeat(line_len - range.start.column_index))
|
|
));
|
|
} else if range.end.line_index == i {
|
|
lines
|
|
.push(colors::red(&"^".repeat(range.end.column_index)).to_string());
|
|
} else if line_len != 0 {
|
|
lines.push(colors::red(&"^".repeat(line_len)).to_string());
|
|
}
|
|
}
|
|
}
|
|
|
|
let hint = if let Some(hint) = maybe_hint {
|
|
format!(" {} {}\n", colors::cyan("hint:"), hint)
|
|
} else {
|
|
"".to_string()
|
|
};
|
|
let help = format!(
|
|
" {} for further information visit https://lint.deno.land/#{}",
|
|
colors::cyan("help:"),
|
|
diagnostic_code
|
|
);
|
|
|
|
format!(
|
|
"{message_line}\n{snippets}\n at {formatted_location}\n\n{hint}{help}",
|
|
message_line = message_line,
|
|
snippets = lines.join("\n"),
|
|
formatted_location = formatted_location,
|
|
hint = hint,
|
|
help = help
|
|
)
|
|
}
|
|
|
|
#[derive(Serialize)]
|
|
struct JsonLintReporter {
|
|
diagnostics: Vec<LintDiagnostic>,
|
|
errors: Vec<LintError>,
|
|
}
|
|
|
|
impl JsonLintReporter {
|
|
fn new() -> JsonLintReporter {
|
|
JsonLintReporter {
|
|
diagnostics: Vec::new(),
|
|
errors: Vec::new(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl LintReporter for JsonLintReporter {
|
|
fn visit_diagnostic(&mut self, d: &LintDiagnostic, _source_lines: Vec<&str>) {
|
|
self.diagnostics.push(d.clone());
|
|
}
|
|
|
|
fn visit_error(&mut self, file_path: &str, err: &AnyError) {
|
|
self.errors.push(LintError {
|
|
file_path: file_path.to_string(),
|
|
message: err.to_string(),
|
|
});
|
|
}
|
|
|
|
fn close(&mut self, _check_count: usize) {
|
|
sort_diagnostics(&mut self.diagnostics);
|
|
let json = serde_json::to_string_pretty(&self);
|
|
println!("{}", json.unwrap());
|
|
}
|
|
}
|
|
|
|
fn sort_diagnostics(diagnostics: &mut Vec<LintDiagnostic>) {
|
|
// Sort so that we guarantee a deterministic output which is useful for tests
|
|
diagnostics.sort_by(|a, b| {
|
|
use std::cmp::Ordering;
|
|
let file_order = a.filename.cmp(&b.filename);
|
|
match file_order {
|
|
Ordering::Equal => {
|
|
let line_order =
|
|
a.range.start.line_index.cmp(&b.range.start.line_index);
|
|
match line_order {
|
|
Ordering::Equal => {
|
|
a.range.start.column_index.cmp(&b.range.start.column_index)
|
|
}
|
|
_ => line_order,
|
|
}
|
|
}
|
|
_ => file_order,
|
|
}
|
|
});
|
|
}
|
|
|
|
fn get_configured_rules(
|
|
maybe_lint_config: Option<&LintConfig>,
|
|
rules_tags: Vec<String>,
|
|
rules_include: Vec<String>,
|
|
rules_exclude: Vec<String>,
|
|
) -> Result<Vec<Box<dyn LintRule>>, AnyError> {
|
|
if maybe_lint_config.is_none()
|
|
&& rules_tags.is_empty()
|
|
&& rules_include.is_empty()
|
|
&& rules_exclude.is_empty()
|
|
{
|
|
return Ok(rules::get_recommended_rules());
|
|
}
|
|
|
|
let (config_file_tags, config_file_include, config_file_exclude) =
|
|
if let Some(lint_config) = maybe_lint_config.as_ref() {
|
|
(
|
|
lint_config.rules.tags.clone(),
|
|
lint_config.rules.include.clone(),
|
|
lint_config.rules.exclude.clone(),
|
|
)
|
|
} else {
|
|
(None, None, None)
|
|
};
|
|
|
|
let maybe_configured_include = if !rules_include.is_empty() {
|
|
Some(rules_include)
|
|
} else {
|
|
config_file_include
|
|
};
|
|
|
|
let maybe_configured_exclude = if !rules_exclude.is_empty() {
|
|
Some(rules_exclude)
|
|
} else {
|
|
config_file_exclude
|
|
};
|
|
|
|
let configured_tags = if !rules_tags.is_empty() {
|
|
rules_tags
|
|
} else {
|
|
config_file_tags.unwrap_or_else(Vec::new)
|
|
};
|
|
|
|
let configured_rules = rules::get_filtered_rules(
|
|
Some(configured_tags),
|
|
maybe_configured_exclude,
|
|
maybe_configured_include,
|
|
);
|
|
|
|
if configured_rules.is_empty() {
|
|
anyhow!("No rules have been configured");
|
|
}
|
|
|
|
Ok(configured_rules)
|
|
}
|