Rename tailwind integration options

[bluwy]

Changes

Following up #6724 (major), this renames:

• config.path to configFile
• config.applyBaseStyles to applyBaseStyles

The config. prefix is a bit redundant 🤔 I also chose configFile over configPath as that's the same name used by Vite and vite-plugin-svelte.

Testing

Existing test should pass

Docs

Updated the README to reflect the new option names.
/cc @withastro/maintainers-docs for feedback!

[changeset-bot]

🦋 Changeset detected

Latest commit: c893d87

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[ematipico]

I also chose configFile over configPath as that's the same name used by Vite and vite-plugin-svelte.

Note: Disclaimer: I don't want to bikeshed.

Usually, the terminology "path" is used for types/structures that don't necessarily exist on file system and they do not necessarily belong to a physical file. Instead, the terminology "file" is used for those types/structures that read/write to file system, which means they must be derived/computed from "path" that exists.

This means that when I read configFile, I assume I can read its contents. Is it the case?

[bluwy]

Yes! configFile should always be a file path that exist in the filesystem. This value is passed to tailwind, which IIRC the internal code simply does fs.readFile(path.resolve(configFile), 'utf-8').

[ematipico]

That's what got me! It's a path, we don't pass the actual contents 😅

[bluwy]

I'm confused if you're proposing either configFile or configPath here 😅 But I think I'm leaning towards the current one for now for consistency.

[delucis]

Are we documenting migration steps somewhere if this is a major release with breaking changes? I think the changelog for the major release should include clear descriptions highlighting:

• What broke?
• Under which circumstances?
• What do you need to do to your existing project to upgrade?

[ematipico]

Looks good. I would personally use configPath, but it's just a personal preference. No need to block it

[bluwy]

@delucis I'm currently documenting them in the changesets. There's two migration needed:

1. option name change (this PR)
2. tailwind config loading behaviour change (@astrojs/tailwind: simplify, upgrade & fix support for ts config file #6724)

In this PR, I've tweaked the changeset for no2 to reflect the new option name (real-spies-pretend.md). I suppose they don't currently answer your 3 points well that can be improved 😅

EDIT: improved!

[sarah11918]

Looks great so far, @bluwy! I left some suggestions below, and as Chris said, for a breaking change we'll really need in this document to show the diff example you have in the changeset.

With that section, we can do the kinds of things I've suggested below. See what you think!

[sarah11918]

Thanks, @bluwy! I think these look good now!