Skip to content

fix: update type CSSModulesOptions interface#14987

Merged
patak-cat merged 3 commits intovitejs:mainfrom
psychobolt:patch-1
Nov 17, 2023
Merged

fix: update type CSSModulesOptions interface#14987
patak-cat merged 3 commits intovitejs:mainfrom
psychobolt:patch-1

Conversation

@psychobolt
Copy link
Contributor

@psychobolt psychobolt commented Nov 14, 2023 •
edited
Loading

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
bluwy
bluwy reviewed Nov 15, 2023
View reviewed changes
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?

vite/docs/config/shared-options.md

Lines 169 to 187 in c61c376

```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-cat patak-cat merged commit d0b2153 into vitejs:main Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@patak-cat patak-cat patak-cat approved these changes

@bluwy bluwy bluwy approved these changes

Assignees

No one assigned

Labels

feat: css p2-nice-to-have Not breaking anything but nice to have (priority)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@psychobolt @patak-cat @bluwy