mirror of
https://github.com/tailwindlabs/tailwindcss.git
synced 2025-12-08 21:36:08 +00:00
a902128640
This PR updates the API for interacting with the Oxide API. Until now,
we used the name `scanDir(…)` which is fine, but we do way more work
right now.
We now have features such as:
1. Auto source detection (can be turned off, e.g.: `@tailwindcss/vite`
doesn't need it)
2. Scan based on `@source`s found in CSS files
3. Do "incremental" rebuilds (which means that the `scanDir(…)` result
was stateful).
To solve these issues, this PR introduces a new `Scanner` class where
you can pass in the `detectSources` and `sources` options. E.g.:
```ts
let scanner = new Scanner({
// Optional, omitting `detectSources` field disables automatic source detection
detectSources: { base: __dirname },
// List of glob entries to scan. These come from `@source` directives in CSS.
sources: [
{ base: __dirname, pattern: "src/**/*.css" },
// …
],
});
```
The scanner object has the following API:
```ts
export interface ChangedContent {
/** File path to the changed file */
file?: string
/** Contents of the changed file */
content?: string
/** File extension */
extension: string
}
export interface DetectSources {
/** Base path to start scanning from */
base: string
}
export interface GlobEntry {
/** Base path of the glob */
base: string
/** Glob pattern */
pattern: string
}
export interface ScannerOptions {
/** Automatically detect sources in the base path */
detectSources?: DetectSources
/** Glob sources */
sources?: Array<GlobEntry>
}
export declare class Scanner {
constructor(opts: ScannerOptions)
scan(): Array<string>
scanFiles(input: Array<ChangedContent>): Array<string>
get files(): Array<string>
get globs(): Array<GlobEntry>
}
```
The `scanFiles(…)` method is used for incremental rebuilds. It takes the
`ChangedContent` array for all the new/changes files. It returns whether
we scanned any new candidates or not.
Note that the `scanner` object is stateful, this means that we don't
have to track candidates in a `Set` anymore. We can just call
`getCandidates()` when we need it.
This PR also removed some unused code that we had in the `scanDir(…)`
function to allow for sequential or parallel `IO`, and sequential or
parallel `Parsing`. We only used the same `IO` and `Parsing` strategies
for all files, so I just got rid of it.
---------
Co-authored-by: Jordan Pittman <jordan@cryptica.me>
368 lines
14 KiB
Rust
368 lines
14 KiB
Rust
#[cfg(test)]
|
|
mod scanner {
|
|
use scanner::detect_sources::DetectSources;
|
|
use std::process::Command;
|
|
use std::{fs, path};
|
|
|
|
use tailwindcss_oxide::*;
|
|
use tempfile::tempdir;
|
|
|
|
fn scan_with_globs(
|
|
paths_with_content: &[(&str, Option<&str>)],
|
|
globs: Vec<&str>,
|
|
) -> (Vec<String>, 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 {
|
|
// Ensure we use the right path separator for the current platform
|
|
let path = dir.join(path.replace('/', path::MAIN_SEPARATOR.to_string().as_str()));
|
|
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 scanner = Scanner::new(
|
|
Some(DetectSources::new(base.clone().into())),
|
|
Some(
|
|
globs
|
|
.iter()
|
|
.map(|x| GlobEntry {
|
|
base: base.clone(),
|
|
pattern: x.to_string(),
|
|
})
|
|
.collect(),
|
|
),
|
|
);
|
|
|
|
let candidates = scanner.scan();
|
|
|
|
let mut paths: Vec<_> = scanner
|
|
.get_files()
|
|
.into_iter()
|
|
.map(|x| x.replace(&format!("{}{}", &base, path::MAIN_SEPARATOR), ""))
|
|
.collect();
|
|
|
|
for glob in scanner.get_globs() {
|
|
paths.push(format!(
|
|
"{}{}{}",
|
|
glob.base,
|
|
path::MAIN_SEPARATOR,
|
|
glob.pattern
|
|
));
|
|
}
|
|
|
|
paths = paths
|
|
.into_iter()
|
|
.map(|x| {
|
|
let parent_dir = format!("{}{}", &base.to_string(), path::MAIN_SEPARATOR);
|
|
x.replace(&parent_dir, "")
|
|
// Normalize paths to use unix style separators
|
|
.replace('\\', "/")
|
|
})
|
|
.collect();
|
|
|
|
// Sort the output for easier comparison (depending on internal datastructure the order
|
|
// _could_ be random)
|
|
paths.sort();
|
|
|
|
(paths, candidates)
|
|
}
|
|
|
|
fn scan(paths_with_content: &[(&str, Option<&str>)]) -> (Vec<String>, Vec<String>) {
|
|
scan_with_globs(paths_with_content, vec![])
|
|
}
|
|
|
|
fn test(paths_with_content: &[(&str, Option<&str>)]) -> Vec<String> {
|
|
scan(paths_with_content).0
|
|
}
|
|
|
|
#[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/**/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"src/a.html",
|
|
"src/b.html",
|
|
"src/c.html"
|
|
]);
|
|
}
|
|
|
|
#[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![
|
|
"bar.html",
|
|
"baz.html",
|
|
"foo.html",
|
|
"nested-a/**/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"nested-a/bar.html",
|
|
"nested-a/baz.html",
|
|
"nested-a/foo.html",
|
|
"nested-b/**/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"nested-b/deeply-nested/bar.html",
|
|
"nested-b/deeply-nested/baz.html",
|
|
"nested-b/deeply-nested/foo.html",
|
|
"nested-c/*/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"nested-c/bar.html",
|
|
"nested-c/baz.html",
|
|
"nested-c/foo.html",
|
|
"nested-c/sibling-folder/**/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"nested-c/sibling-folder/bar.html",
|
|
"nested-c/sibling-folder/baz.html",
|
|
"nested-c/sibling-folder/foo.html",
|
|
"nested-d/*/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"nested-d/bar.html",
|
|
"nested-d/baz.html",
|
|
"nested-d/foo.html",
|
|
"nested-d/very/*/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"nested-d/very/deeply/*/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"nested-d/very/deeply/nested/*/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"nested-d/very/deeply/nested/bar.html",
|
|
"nested-d/very/deeply/nested/baz.html",
|
|
"nested-d/very/deeply/nested/directory/**/*.{aspx,astro,cjs,cts,eex,erb,gjs,gts,haml,handlebars,hbs,heex,html,jade,js,jsx,liquid,md,mdx,mjs,mts,mustache,njk,nunjucks,php,pug,py,razor,rb,rhtml,rs,slim,svelte,tpl,ts,tsx,twig,vue}",
|
|
"nested-d/very/deeply/nested/directory/again/foo.html",
|
|
"nested-d/very/deeply/nested/directory/bar.html",
|
|
"nested-d/very/deeply/nested/directory/baz.html",
|
|
"nested-d/very/deeply/nested/directory/foo.html",
|
|
"nested-d/very/deeply/nested/foo.html",
|
|
]
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_scan_for_utilities() {
|
|
let mut ignores = String::new();
|
|
ignores.push_str("# md:font-bold\n");
|
|
ignores.push_str("foo.html\n");
|
|
|
|
let candidates = scan(&[
|
|
// The gitignore file is used to filter out files but not scanned for candidates
|
|
(".gitignore", Some(&ignores)),
|
|
// A file that should definitely be scanned
|
|
("index.html", Some("font-bold md:flex")),
|
|
// A file that should definitely not be scanned
|
|
("foo.jpg", Some("xl:font-bold")),
|
|
// A file that is ignored
|
|
("foo.html", Some("lg:font-bold")),
|
|
// A svelte file with `class:foo="bar"` syntax
|
|
("index.svelte", Some("<div class:px-4='condition'></div>")),
|
|
])
|
|
.1;
|
|
|
|
assert_eq!(
|
|
candidates,
|
|
vec!["condition", "div", "font-bold", "md:flex", "px-4"]
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_scan_content_paths() {
|
|
let candidates = scan_with_globs(
|
|
&[
|
|
// We know that `.styl` extensions are ignored, so they are not covered by auto content
|
|
// detection.
|
|
("foo.styl", Some("content-['foo.styl']")),
|
|
],
|
|
vec!["*.styl"],
|
|
)
|
|
.1;
|
|
|
|
assert_eq!(candidates, vec!["content-['foo.styl']"]);
|
|
}
|
|
|
|
#[test]
|
|
fn it_should_scan_content_paths_even_when_they_are_git_ignored() {
|
|
let candidates = scan_with_globs(
|
|
&[
|
|
(".gitignore", Some("foo.styl")),
|
|
// We know that `.styl` extensions are ignored, so they are not covered by auto content
|
|
// detection.
|
|
("foo.styl", Some("content-['foo.styl']")),
|
|
],
|
|
vec!["*.styl"],
|
|
)
|
|
.1;
|
|
|
|
assert_eq!(candidates, vec!["content-['foo.styl']"]);
|
|
}
|
|
}
|