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.

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

Allow mod statements with path to source file #1786

Merged
merged 2 commits into from
Dec 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 src/analyzer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ impl<'src> Analyzer<'src> {
Item::Import { absolute, .. } => {
stack.push(asts.get(absolute.as_ref().unwrap()).unwrap());
}
Item::Mod { absolute, name } => {
Item::Mod { absolute, name, .. } => {
define(*name, "module", false)?;
modules.insert(
name.to_string(),
Expand Down
12 changes: 10 additions & 2 deletions src/compiler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,11 @@ impl Compiler {

for item in &mut ast.items {
match item {
Item::Mod { name, absolute } => {
Item::Mod {
name,
absolute,
path,
} => {
if !unstable {
return Err(Error::Unstable {
message: "Modules are currently unstable.".into(),
Expand All @@ -36,7 +40,11 @@ impl Compiler {

let parent = current.parent().unwrap();

let import = Self::find_module_file(parent, *name)?;
let import = if let Some(path) = path {
parent.join(&path.cooked)
} else {
Self::find_module_file(parent, *name)?
};

if srcs.contains_key(&import) {
return Err(Error::CircularImport { current, import });
Expand Down
11 changes: 10 additions & 1 deletion src/item.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ pub(crate) enum Item<'src> {
Mod {
name: Name<'src>,
absolute: Option<PathBuf>,
path: Option<StringLiteral<'src>>,
},
Recipe(UnresolvedRecipe<'src>),
Set(Set<'src>),
Expand All @@ -25,7 +26,15 @@ impl<'src> Display for Item<'src> {
Item::Assignment(assignment) => write!(f, "{assignment}"),
Item::Comment(comment) => write!(f, "{comment}"),
Item::Import { relative, .. } => write!(f, "import {relative}"),
Item::Mod { name, .. } => write!(f, "mod {name}"),
Item::Mod { name, path, .. } => {
write!(f, "mod {name}")?;

if let Some(path) = path {
write!(f, " {path}")?;
}

Ok(())
}
Item::Recipe(recipe) => write!(f, "{}", recipe.color_display(Color::never())),
Item::Set(set) => write!(f, "{set}"),
}
Expand Down
17 changes: 15 additions & 2 deletions src/parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -335,11 +335,24 @@ impl<'tokens, 'src> Parser<'tokens, 'src> {
absolute: None,
});
}
Some(Keyword::Mod) if self.next_are(&[Identifier, Identifier]) => {
Some(Keyword::Mod)
if self.next_are(&[Identifier, Identifier, StringToken])
|| self.next_are(&[Identifier, Identifier, Eof])
|| self.next_are(&[Identifier, Identifier, Eol]) =>
{
self.presume_keyword(Keyword::Mod)?;
let name = self.parse_name()?;

let path = if self.next_is(StringToken) {
Some(self.parse_string_literal()?)
} else {
None
};

items.push(Item::Mod {
name: self.parse_name()?,
name,
absolute: None,
path,
});
}
Some(Keyword::Set)
Expand Down
49 changes: 49 additions & 0 deletions tests/modules.rs
Original file line number Diff line number Diff line change
Expand Up @@ -444,3 +444,52 @@ fn dotenv_settings_in_submodule_are_ignored() {
.stdout("dotenv-value\n")
.run();
}

#[test]
fn modules_may_specify_path() {
Test::new()
.write("commands/foo.just", "foo:\n @echo FOO")
.justfile(
"
mod foo 'commands/foo.just'
",
)
.test_round_trip(false)
.arg("--unstable")
.arg("foo")
.arg("foo")
.stdout("FOO\n")
.run();
}

#[test]
fn modules_with_paths_are_dumped_correctly() {
Test::new()
.write("commands/foo.just", "foo:\n @echo FOO")
.justfile(
"
mod foo 'commands/foo.just'
",
)
.test_round_trip(false)
.arg("--unstable")
.arg("--dump")
.stdout("mod foo 'commands/foo.just'\n")
.run();
}

#[test]
fn recipes_may_be_named_mod() {
Test::new()
.justfile(
"
mod foo:
@echo FOO
",
)
.test_round_trip(false)
.arg("mod")
.arg("bar")
.stdout("FOO\n")
.run();
}
Loading