Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Aliases for --lang. #488

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Aliases for --lang. #488

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b9db7ec
Aliases for --lang
xonx4l Sep 6, 2024
10dece2
from_string_or_alias
xonx4l Sep 6, 2024
45b88ed
adding tests
xonx4l Sep 6, 2024
7210a21
Global tests
xonx4l Sep 6, 2024
29aaae9
removed from_string_or_alias
xonx4l Sep 7, 2024
2d62b4c
Update target_language.rs
xonx4l Sep 7, 2024
718c4b7
Update target_language.rs
xonx4l Sep 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion crates/cli/src/commands/apply_pattern.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ pub(crate) async fn run_apply_pattern(
"A path must have an extension to determine the language for stdin"
))?;
if let Some(ext) = ext.to_str() {
PatternLanguage::from_extension(ext)
PatternLanguage::from_string_or_alias(ext, None)
} else {
default_lang
}
Expand Down
56 changes: 56 additions & 0 deletions crates/core/src/pattern_compiler/compiler.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,9 +673,23 @@ mod tests {
let pattern_tsx = "language js(jsx)";
let pattern_default = "language js";
let pattern_default_fall_through = "language js(block)";
let pattern_python_alias = "language py";
let pattern_csharp_alias = "language cs";
let pattern_rust_alias = "language rs";
let pattern_ruby_alias = "language rb";
let pattern_solidity_alias = "language sol";
let pattern_hcl_alias = "language tf";
let pattern_yaml_alias = "language yml";
let js: TargetLanguage = PatternLanguage::JavaScript.try_into().unwrap();
let ts: TargetLanguage = PatternLanguage::TypeScript.try_into().unwrap();
let tsx: TargetLanguage = PatternLanguage::Tsx.try_into().unwrap();
let python: TargetLanguage = PatternLanguage::Python.try_into().unwrap();
let csharp: TargetLanguage = PatternLanguage::CSharp.try_into().unwrap();
let rust: TargetLanguage = PatternLanguage::Rust.try_into().unwrap();
let ruby: TargetLanguage = PatternLanguage::Ruby.try_into().unwrap();
let solidity: TargetLanguage = PatternLanguage::Solidity.try_into().unwrap();
let hcl: TargetLanguage = PatternLanguage::Hcl.try_into().unwrap();
let yaml: TargetLanguage = PatternLanguage::Yaml.try_into().unwrap();
assert_eq!(
TargetLanguage::get_language(pattern_javascript)
.unwrap()
Expand Down Expand Up @@ -706,5 +720,47 @@ mod tests {
.language_name(),
tsx.language_name()
);
assert_eq!(
TargetLanguage::get_language(pattern_python_alias)
.unwrap()
.language_name(),
python.language_name()
);
assert_eq!(
TargetLanguage::get_language(pattern_csharp_alias)
.unwrap()
.language_name(),
csharp.language_name()
);
assert_eq!(
TargetLanguage::get_language(pattern_rust_alias)
.unwrap()
.language_name(),
rust.language_name()
);
assert_eq!(
TargetLanguage::get_language(pattern_ruby_alias)
.unwrap()
.language_name(),
ruby.language_name()
);
assert_eq!(
TargetLanguage::get_language(pattern_solidity_alias)
.unwrap()
.language_name(),
solidity.language_name()
);
assert_eq!(
TargetLanguage::get_language(pattern_hcl_alias)
.unwrap()
.language_name(),
hcl.language_name()
);
assert_eq!(
TargetLanguage::get_language(pattern_yaml_alias)
.unwrap()
.language_name(),
yaml.language_name()
);
}
}
85 changes: 85 additions & 0 deletions crates/language/src/target_language.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,48 @@ impl PatternLanguage {
Self::from_string(lang, flavor.as_deref())
}

impl PatternLanguage {
pub fn from_string_or_alias(name: &str, flavor: Option<&str>) -> Option<Self> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xonx4l This should be removed, you don't need both.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!!!

match name {
"py" | "python" => Some(Self::Python),
"js" | "javascript" => match flavor {
Some("jsx") => Some(Self::Tsx),
Some("flow") => Some(Self::Tsx),
Some("FlowComments") => Some(Self::Tsx),
Some("typescript") => Some(Self::TypeScript),
Some("js_do_not_use") => Some(Self::JavaScript),
_ => Some(Self::Tsx),
},
"ts" | "typescript" => Some(Self::Typescript),
"html" => Some(Self::Html),
"css" => Some(Self::Css),
"json" => Some(Self::Json),
"java" => Some(Self::Java),
"cs" | "csharp" => Some(Self::CSharp),
"md" | "markdown" => match flavor {
Some("block") => Some(Self::MarkdownBlock),
Some("inline") => Some(Self::MarkdownInline),
_ => Some(Self::MarkdownInline),
},
"go" => Some(Self::Go),
"rs" | "rust" => Some(Self::Rust),
"rb" | "ruby" => Some(Self::Ruby),
"sol" | "solidity" => Some(Self::Solidity),
"hcl" | "tf" | "terraform" => Some(Self::Hcl),
"yml" | "yaml" => Some(Self::Yaml),
"sql" => Some(Self::Sql),
"vue" => Some(Self::Vue),
"toml" => Some(Self::Toml),
"php" => match flavor {
Some("html") => Some(Self::Php),
Some("only") => Some(self::PhpOnly),
_ => Some(Self::Php),
},
"universal" => Some(Self::Universal),
_ => None,
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve the implementation of from_string_or_alias.

The new function from_string_or_alias is well-implemented and covers a comprehensive range of languages and aliases. It effectively centralizes the logic for language identification, which enhances maintainability and code reuse.

Suggestion: Add documentation.
It would be beneficial to add documentation comments to this function to explain its purpose, parameters, and the handling of different cases, especially the use of the flavor parameter.


#[cfg(not(feature = "builtin-parser"))]
pub fn get_language_with_parser(_parser: &mut MarzanoGritParser, _body: &str) -> Option<Self> {
unimplemented!("grit_parser is unavailable when feature flag [builtin-parser] is off.")
Expand All @@ -146,6 +188,7 @@ impl PatternLanguage {
}

pub fn from_string(name: &str, flavor: Option<&str>) -> Option<Self> {
Self::from_string_or_alias(name, flavor)
xonx4l marked this conversation as resolved.
Show resolved Hide resolved
match name {
"js" => match flavor {
Some("jsx") => Some(Self::Tsx),
Expand Down Expand Up @@ -245,6 +288,7 @@ impl PatternLanguage {
}

pub fn from_extension(extension: &str) -> Option<Self> {
Self::from_string_or_alias(extension, None)
morgante marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This call isn't doing anything, I think you probably meant to delegate this entirely?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have changed the from_extension function which now uses the updated from_string function, which handles both full language names and aliases.

match extension {
"js" | "jsx" | "cjs" | "mjs" => Some(Self::Tsx),
"ts" | "tsx" | "cts" | "mts" => Some(Self::Tsx),
Expand Down Expand Up @@ -822,4 +866,45 @@ mod tests {
let other_comment = lang.extract_single_line_comment(other_text).unwrap();
assert_eq!(other_comment, "this is a comment");
}

#[test]
fn test_from_string_or_alias() {
assert_eq!(PatternLanguage::from_string_or_alias("py", None), Some(PatternLanguage::Python));
assert_eq!(PatternLanguage::from_string_or_alias("python", None), Some(PatternLanguage::Python));
assert_eq!(PatternLanguage::from_string_or_alias("js", None), Some(PatternLanguage::Tsx));
assert_eq!(PatternLanguage::from_string_or_alias("javascript", None), Some(PatternLanguage::Tsx));
assert_eq!(PatternLanguage::from_string_or_alias("ts", None), Some(PatternLanguage::TypeScript));
assert_eq!(PatternLanguage::from_string_or_alias("typescript", None), Some(PatternLanguage::TypeScript));
assert_eq!(PatternLanguage::from_string_or_alias("cs", None), Some(PatternLanguage::CSharp));
assert_eq!(PatternLanguage::from_string_or_alias("csharp", None), Some(PatternLanguage::CSharp));
assert_eq!(PatternLanguage::from_string_or_alias("md", None), Some(PatternLanguage::MarkdownInline));
assert_eq!(PatternLanguage::from_string_or_alias("markdown", None), Some(PatternLanguage::MarkdownInline));
assert_eq!(PatternLanguage::from_string_or_alias("rs", None), Some(PatternLanguage::Rust));
assert_eq!(PatternLanguage::from_string_or_alias("rust", None), Some(PatternLanguage::Rust));
assert_eq!(PatternLanguage::from_string_or_alias("rb", None), Some(PatternLanguage::Ruby));
assert_eq!(PatternLanguage::from_string_or_alias("ruby", None), Some(PatternLanguage::Ruby));
assert_eq!(PatternLanguage::from_string_or_alias("sol", None), Some(PatternLanguage::Solidity));
assert_eq!(PatternLanguage::from_string_or_alias("solidity", None), Some(PatternLanguage::Solidity));
assert_eq!(PatternLanguage::from_string_or_alias("tf", None), Some(PatternLanguage::Hcl));
assert_eq!(PatternLanguage::from_string_or_alias("hcl", None), Some(PatternLanguage::Hcl));
assert_eq!(PatternLanguage::from_string_or_alias("terraform", None), Some(PatternLanguage::Hcl));
assert_eq!(PatternLanguage::from_string_or_alias("yml", None), Some(PatternLanguage::Yaml));
assert_eq!(PatternLanguage::from_string_or_alias("yaml", None), Some(PatternLanguage::Yaml));
assert_eq!(PatternLanguage::from_string_or_alias("unknown", None), None);
}

#[test]
fn test_from_extension() {
assert_eq!(PatternLanguage::from_extension("py"), Some(PatternLanguage::Python));
assert_eq!(PatternLanguage::from_extension("js"), Some(PatternLanguage::Tsx));
assert_eq!(PatternLanguage::from_extension("ts"), Some(PatternLanguage::TypeScript));
assert_eq!(PatternLanguage::from_extension("cs"), Some(PatternLanguage::CSharp));
assert_eq!(PatternLanguage::from_extension("md"), Some(PatternLanguage::MarkdownInline));
assert_eq!(PatternLanguage::from_extension("rs"), Some(PatternLanguage::Rust));
assert_eq!(PatternLanguage::from_extension("rb"), Some(PatternLanguage::Ruby));
assert_eq!(PatternLanguage::from_extension("sol"), Some(PatternLanguage::Solidity));
assert_eq!(PatternLanguage::from_extension("tf"), Some(PatternLanguage::Hcl));
assert_eq!(PatternLanguage::from_extension("yml"), Some(PatternLanguage::Yaml));
assert_eq!(PatternLanguage::from_extension("unknown"), None);
}
}
Loading