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

fix: update type CSSModulesOptions interface #14987

Merged
merged 3 commits into from
Nov 17, 2023
Merged

fix: update type CSSModulesOptions interface #14987

merged 3 commits into from
Nov 17, 2023

Conversation

psychobolt
Copy link
Contributor

@psychobolt psychobolt commented Nov 14, 2023

Description

This PR updates CSSModuleOptions to be in sync with the postcss modules documentation here: https://github.com/madyankin/postcss-modules

Additional context


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines, especially the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Update the corresponding documentation if needed.
  • Ideally, include relevant tests that fail without this PR but pass with it.

@psychobolt psychobolt changed the title Add type exportGlobals to CSSModulesOptions interface fix: Add type exportGlobals to CSSModulesOptions interface Nov 14, 2023
@psychobolt psychobolt changed the title fix: Add type exportGlobals to CSSModulesOptions interface fix: add type exportGlobals to CSSModulesOptions interface Nov 14, 2023
Copy link
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

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

LGTM. Can you also update the types in the docs here?

```ts
interface CSSModulesOptions {
scopeBehaviour?: 'global' | 'local'
globalModulePaths?: RegExp[]
generateScopedName?:
| string
| ((name: string, filename: string, css: string) => string)
hashPrefix?: string
/**
* default: null
*/
localsConvention?:
| 'camelCase'
| 'camelCaseOnly'
| 'dashes'
| 'dashesOnly'
| null
}
```

Looks like some other fields are also outdated

@bluwy bluwy added feat: css p2-nice-to-have Not breaking anything but nice to have (priority) labels Nov 15, 2023
@psychobolt psychobolt changed the title fix: add type exportGlobals to CSSModulesOptions interface fix: update type CSSModulesOptions interface Nov 16, 2023
@patak-dev patak-dev merged commit d0b2153 into vitejs:main Nov 17, 2023
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat: css p2-nice-to-have Not breaking anything but nice to have (priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants