dce8280d76
* resolve all _existing_ content paths
* pin `@napi-rs/cli`
* WIP: Log all resolved content files/globs
* only filter out raw changed content in non-auto mode
* skip parseCandidateFiles cache in `auto` mode
* improve algorithm of detecting content paths
1. Files in the root should be listed statically instead of using globs.
2. Files and folders in special known direct child folders should be
listed statically instead of using globs (e.g.: `public`). This is
because these special folders are often used to store generated AND
source files at the same time. Using globs could trigger infinite
loops because we are watching and acting upon dist files.
3. All file extensions found in the project, should be used in the globs
in addition to a known set of extensions.
4. Direct folders seen from the root, can use the glob syntax
`<root>/src/**/*.{...known-extensions}`
* inline wanted-extensions
Not 100% convinced yet, but seems cleaner so far.
* ensure writing an file also makes the parent folder(s)
* add integration tests for the auto content feature
* add pnpm and bun lock files
* Revert "inline wanted-extensions"
This reverts commit 879c1248524e84216125f4a24e0160b40736333a.
* sort binary-extensions and add lockb
* sort + add `lock` to ignored extensions
* drop `yarn.lock`, because lock extensions are already covered
* group template extensions
This will make it a bit easier to organize in the future.
* drop empty lines and commented lines from template-extensions
* skip the config path when resolving template files
The config file will automatically trigger a rebuild when this file is
changed. However, this should not be part of the template files because
that could cause additional css that's not being used.
* make `auto content` the default in the oxide engine
- In the oxide engine, the default `content: []` will be dropped from
the default configuration (config.simple.js, config.full.js).
- If you have `content: []` or `content: { files: [] }` then the auto
content feature won't be active. However if those arrays are empty a
warning will still be shown. Adding files/globs or dropping the
`content` section completely will enable auto content.
* only test the auto content integration test in the oxide engine
* set `content.files` to `auto` instead of using `auto: boolean`
This way we don't run into the issue where the `config.content.files` is
set and the `config.content.auto` is set to true.
* drop log
* ensure we validate the config in the CLI
* show experimental warning for automatic content detection
* use cached version of the getCandidateFiles instead of bypassing it
* use `is_empty()` shorthand
Thanks, Clippy!
* add test to ensure nested ignored folders are not scanned
* add `tempfile` for tests
* add auto content tests in Rust
* refactor auto content detection
This will also make sure that if we have (deeply) nested ignored
folders, then we won't use deeply nested globs (**/*.{js,html}) for the
parent(s) of the nested ignored folders but instead use a shallow glob
for each directory (*/*.{js,html}).
Then each sibling directory of the parent can use deeply nested globs
again except for the direct parent.
* use consistent comments
* ensure ignored static listed files are not present
* improve performance by ~30x
On a big test project this goes from ~6s to ~200ms
* improve performance by ~5x
We started with a ~6s duration
Then in the previous commit, we improved it by ~30x and it went down to
~200ms
Now with this change, it takes about ~40ms. That's another ~5x
improvement.
Or in total a ~150x improvement.
* ensure nested folders in `public/` are also explicitly listed
* add shortcut for normalizing files
This is only called once so won't do anything to the main performance of
Tailwind CSS. But always nice to make small performance improvements!
* run Rust tests in CI
* fix lint warnings
* update changelog
* Update CHANGELOG.md
---------
Co-authored-by: Robin Malfait <malfait.robin@gmail.com>
248 lines
10 KiB
Rust
248 lines
10 KiB
Rust
#[cfg(test)]
|
|
mod auto_content {
|
|
use std::fs;
|
|
use std::process::Command;
|
|
|
|
use tailwindcss_core::*;
|
|
use tempfile::tempdir;
|
|
|
|
fn test(paths_with_content: &[(&str, Option<&str>)]) -> Vec<String> {
|
|
// Create a temporary working directory
|
|
let dir = tempdir().unwrap().into_path();
|
|
|
|
// Initialize this directory as a git repository
|
|
let _ = Command::new("git").arg("init").current_dir(&dir).output();
|
|
|
|
// Create the necessary files
|
|
for (path, contents) in paths_with_content {
|
|
let path = dir.join(path);
|
|
let parent = path.parent().unwrap();
|
|
if !parent.exists() {
|
|
fs::create_dir_all(parent).unwrap();
|
|
}
|
|
|
|
match contents {
|
|
Some(contents) => fs::write(path, contents).unwrap(),
|
|
None => fs::write(path, "").unwrap(),
|
|
}
|
|
}
|
|
|
|
let base = format!("{}", dir.display());
|
|
|
|
// Resolve all content paths for the (temporary) current working directory
|
|
let mut paths: Vec<_> = resolve_content_paths(ContentPathInfo { base: base.clone() })
|
|
.into_iter()
|
|
.map(|x| x.replace(&format!("{}/", &base), ""))
|
|
.collect();
|
|
|
|
// Sort the output for easier comparison (depending on internal datastructure the order
|
|
// _could_ be random)
|
|
paths.sort();
|
|
|
|
paths
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_work_with_a_set_of_root_files() {
|
|
let globs = test(&[
|
|
("index.html", None),
|
|
("a.html", None),
|
|
("b.html", None),
|
|
("c.html", None),
|
|
]);
|
|
assert_eq!(globs, vec!["a.html", "b.html", "c.html", "index.html"]);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_work_with_a_set_of_root_files_and_ignore_ignored_files() {
|
|
let globs = test(&[
|
|
(".gitignore", Some("b.html")),
|
|
("index.html", None),
|
|
("a.html", None),
|
|
("b.html", None),
|
|
("c.html", None),
|
|
]);
|
|
assert_eq!(globs, vec!["a.html", "c.html", "index.html"]);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_list_all_files_in_the_public_folder_explicitly() {
|
|
let globs = test(&[
|
|
("index.html", None),
|
|
("public/a.html", None),
|
|
("public/b.html", None),
|
|
("public/c.html", None),
|
|
]);
|
|
assert_eq!(
|
|
globs,
|
|
vec![
|
|
"index.html",
|
|
"public/a.html",
|
|
"public/b.html",
|
|
"public/c.html",
|
|
]
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_list_nested_folders_explicitly_in_the_public_folder() {
|
|
let globs = test(&[
|
|
("index.html", None),
|
|
("public/a.html", None),
|
|
("public/b.html", None),
|
|
("public/c.html", None),
|
|
("public/nested/a.html", None),
|
|
("public/nested/b.html", None),
|
|
("public/nested/c.html", None),
|
|
("public/nested/again/a.html", None),
|
|
("public/very/deeply/nested/a.html", None),
|
|
]);
|
|
assert_eq!(
|
|
globs,
|
|
vec![
|
|
"index.html",
|
|
"public/a.html",
|
|
"public/b.html",
|
|
"public/c.html",
|
|
"public/nested/a.html",
|
|
"public/nested/again/a.html",
|
|
"public/nested/b.html",
|
|
"public/nested/c.html",
|
|
"public/very/deeply/nested/a.html",
|
|
]
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_list_all_files_in_the_public_folder_explicitly_except_ignored_files() {
|
|
let globs = test(&[
|
|
(".gitignore", Some("public/b.html\na.html")),
|
|
("index.html", None),
|
|
("public/a.html", None),
|
|
("public/b.html", None),
|
|
("public/c.html", None),
|
|
]);
|
|
assert_eq!(globs, vec!["index.html", "public/c.html",]);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_use_a_glob_for_top_level_folders() {
|
|
let globs = test(&[
|
|
("index.html", None),
|
|
("src/a.html", None),
|
|
("src/b.html", None),
|
|
("src/c.html", None),
|
|
]);
|
|
assert_eq!(globs, vec!["index.html", "src/**/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}"]);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_ignore_binary_files() {
|
|
let globs = test(&[
|
|
("index.html", None),
|
|
("a.mp4", None),
|
|
("b.png", None),
|
|
("c.lock", None),
|
|
]);
|
|
assert_eq!(globs, vec!["index.html"]);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_ignore_known_extensions() {
|
|
let globs = test(&[
|
|
("index.html", None),
|
|
("a.css", None),
|
|
("b.sass", None),
|
|
("c.less", None),
|
|
]);
|
|
assert_eq!(globs, vec!["index.html"]);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_ignore_known_files() {
|
|
let globs = test(&[
|
|
("index.html", None),
|
|
("package-lock.json", None),
|
|
("yarn.lock", None),
|
|
]);
|
|
assert_eq!(globs, vec!["index.html"]);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_ignore_and_expand_nested_ignored_folders() {
|
|
let globs = test(&[
|
|
// Explicitly listed root files
|
|
("foo.html", None),
|
|
("bar.html", None),
|
|
("baz.html", None),
|
|
// Nested folder A, using glob
|
|
("nested-a/foo.html", None),
|
|
("nested-a/bar.html", None),
|
|
("nested-a/baz.html", None),
|
|
// Nested folder B, with deeply nested files, using glob
|
|
("nested-b/deeply-nested/foo.html", None),
|
|
("nested-b/deeply-nested/bar.html", None),
|
|
("nested-b/deeply-nested/baz.html", None),
|
|
// Nested folder C, with ignored sub-folder
|
|
("nested-c/foo.html", None),
|
|
("nested-c/bar.html", None),
|
|
("nested-c/baz.html", None),
|
|
// Ignored folder
|
|
("nested-c/.gitignore", Some("ignored-folder/")),
|
|
("nested-c/ignored-folder/foo.html", None),
|
|
("nested-c/ignored-folder/bar.html", None),
|
|
("nested-c/ignored-folder/baz.html", None),
|
|
// Deeply nested, without issues
|
|
("nested-c/sibling-folder/foo.html", None),
|
|
("nested-c/sibling-folder/bar.html", None),
|
|
("nested-c/sibling-folder/baz.html", None),
|
|
// Nested folder D, with deeply nested ignored folder
|
|
("nested-d/foo.html", None),
|
|
("nested-d/bar.html", None),
|
|
("nested-d/baz.html", None),
|
|
("nested-d/.gitignore", Some("deep/")),
|
|
("nested-d/very/deeply/nested/deep/foo.html", None),
|
|
("nested-d/very/deeply/nested/deep/bar.html", None),
|
|
("nested-d/very/deeply/nested/deep/baz.html", None),
|
|
("nested-d/very/deeply/nested/foo.html", None),
|
|
("nested-d/very/deeply/nested/bar.html", None),
|
|
("nested-d/very/deeply/nested/baz.html", None),
|
|
("nested-d/very/deeply/nested/directory/foo.html", None),
|
|
("nested-d/very/deeply/nested/directory/bar.html", None),
|
|
("nested-d/very/deeply/nested/directory/baz.html", None),
|
|
("nested-d/very/deeply/nested/directory/again/foo.html", None),
|
|
]);
|
|
|
|
assert_eq!(
|
|
globs,
|
|
vec![
|
|
// Listed explicitly because they are in the root
|
|
"bar.html",
|
|
"baz.html",
|
|
"foo.html",
|
|
|
|
// Listed using a deep glob, because nothing inside is ignored
|
|
"nested-a/**/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}",
|
|
|
|
// Listed using a deep glob, because nothing inside is ignored (but contains deeply
|
|
// nested folders)
|
|
"nested-b/**/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}",
|
|
|
|
// Listed using a shallow glob, because `nested-c` contains ignored folders, deeply
|
|
// nested globs can't be used anymore
|
|
"nested-c/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}",
|
|
|
|
// Deeply nested folder can use a deep glob again
|
|
"nested-c/sibling-folder/**/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}",
|
|
|
|
// The deeply nested folder can use a deep glob, however all of its parents can
|
|
// only contain a shallow glob because of the ignored folder
|
|
"nested-d/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}",
|
|
"nested-d/very/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}",
|
|
"nested-d/very/deeply/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}",
|
|
"nested-d/very/deeply/nested/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}",
|
|
"nested-d/very/deeply/nested/directory/**/*.{py,tpl,js,vue,php,mjs,cts,jsx,tsx,rhtml,slim,handlebars,twig,rs,njk,svelte,liquid,pug,md,ts,heex,mts,astro,nunjucks,rb,eex,haml,cjs,html,hbs,jade,aspx,razor,erb,mustache,mdx}",
|
|
]
|
|
);
|
|
}
|
|
}
|